pyeuvac 0.0.6b0__tar.gz

pyeuvac-0.0.6b0/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (с) 2024 Tatarnikov Anton, Zolotov Oleg
+
+pyeuvac package is licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

pyeuvac-0.0.6b0/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.2
+Name: pyeuvac
+Version: 0.0.6b0
+Summary: Python3 implementation of EUVAC - extreme ultraviolet (EUV) flux model for aeronomic calculations.
+Author-email: Anton Tatarnikov <tatarnikoffanton@yandex.ru>, Oleg Zolotov <ovz.office@gmail.com>
+Project-URL: Homepage, https://github.com/klklklo/pyeuvac
+Keywords: Solar radiation model,EUV
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: importlib-resources
+Requires-Dist: netcdf4
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: xarray
+
+# pyeuvac
+<!--Basic information-->
+pyeuvac is a Python3 implementation of the extra ultraviolet (EUV) flux model EUVAC described by P. G. Richards, 
+J. A. Fennelly, D. G. Torr. This EUV model provides fluxes in the range 5-105 nm, divided into 20 intervals 
+of 5 nm width and into 17 separate lines.
+
+If you use pyeuvac or Euvac model directly or indirectly, please, cite in your research the following paper:
+
+1. Richards, P. G., J. A. Fennelly, and D. G. Torr (1994), Euvac: A solar EUV Flux Model for aeronomic calculations, 
+J. Geophys. Res., 99(A5), 8981-8992. https://doi.org/10.1029/94JA00518
+
+# User's guide
+
+<!--Users guide-->
+
+## Installation
+
+The following command is used to install the package:
+
+```
+python -m pip install pyeuvac
+```
+pyeuvac is the name of the package.
+
+## Euvac
+
+The pyeuvac package contains one class Euvac which has 3 methods:
+- get_spectral_bands() for calculating the spectrum over intervals;
+- get_spectral_lines() for calculating the spectrum along individual lines;
+- get_spectra() for calculating the spectrum in a wavelength interval and in an individual wavelength.
+
+All methods of the class have two input parameters:
+- F<sub>10.7</sub> - daily value of the F<sub>10.7</sub> solar activity index (in s.f.u.);
+- F<sub>10.7A</sub> - the average value of the F<sub>10.7</sub> solar activity index for 81 days.
+
+Parameters can only be of types float, int, list and numpy.array. If there are several parameters, they are passed as 
+lists with an equal number of elements.
+
+## Usage example
+
+1. get_spectral_bands()
+
+Method for calculating spectrum in 5 nm wide intervals from 5-105 nm range. Method returns xarray Dataset class object.
+
+Input parameters:
+- f107 - single value of the daily index F<sub>10.7</sub> (in s.f.u.);
+- f107avg - 81-day average F<sub>10.7</sub> value (in s.f.u.).
+
+```
+<xarray.Dataset> Size: 736B
+Dimensions:           (F10.7: 1, F10.7AVG: 1, band_center: 20, band_number: 20)
+Coordinates:
+  * F10.7             (F10.7) float64 8B <input F10.7 values>
+  * F10.7AVG          (F10.7AVG) float64 8B <input F10.7A values>
+  * band_center       (band_center) float64 160B 7.5 12.5 17.5 ... 97.5 102.5
+  * band_number       (band_number) int32 80B 0 1 2 3 4 5 ... 14 15 16 17 18 19
+Data variables:
+    euv_flux_spectra  (F10.7, F10.7AVG, band_center) float64 160B <output spectrum>
+    lband             (band_number) float64 160B 5.0 10.0 15.0 ... 95.0 100.0
+    uband             (band_number) float64 160B 10.0 15.0 20.0 ... 100.0 105.0
+```
+The resulting spectrum is contained in a three-dimensional array with dimensions (F<sub>10.7</sub>, F<sub>10.7A</sub>, euv_spectrum)
+
+Below is an example of calculating the spectrum with input parameters F<sub>10.7</sub> = F<sub>10.7A</sub> = 200 s.f.u.
+```
+# importing a package with the alias pe
+import pyeuvac as pe
+# creating an instance of the Euvac class
+example = pe.Euvac()
+# calculate the spectrum values at F10.7 = 200 and F10.7A = 200 (P = 200 as an example of the Richards et al.) using get_spectral_bands()
+spectrum = example.get_spectral_bands(f107=200., f107avg=200.)
+# output the resulting EUV-spectra
+print(spectrum['euv_flux_spectra'])
+
+
+<xarray.DataArray 'euv_flux_spectra' (F10.7: 1, F10.7AVG: 1, band_center: 20)> Size: 160B
+array([[[ 2.642448  ,  0.83475   , 12.504     , 10.3367336 ,
+          7.01157116,  3.56471   ,  1.69090256,  0.72348547,
+          0.976695  ,  0.92705019,  0.51372157,  0.826272  ,
+          0.34776092,  0.22137   ,  1.19157903,  2.5642565 ,
+          5.945697  ,  4.793988  ,  2.2567559 ,  3.762175  ]]])
+Coordinates:
+  * F10.7        (F10.7) float64 8B 200.0
+  * F10.7AVG     (F10.7AVG) float64 8B 200.0
+  * band_center  (band_center) float64 160B 7.5 12.5 17.5 ... 92.5 97.5 102.5
+```
+
+If you need to calculate the spectrum for several F<sub>10.7</sub> and F<sub>10.7A</sub> values, pass them using a list.
+The number of values in the lists must be equal.
+```
+# calculate the spectrum values at F10.7 = [200., 210., 220.] and F10.7A = [200., 210., 220.]
+spectrum = example.get_spectral_bands(f107=[200., 210., 220.], f107avg=[200., 210., 220.])
+# output the resulting EUV-spectra for the first pair of F10.7 and F10.7A
+print(spectrum['euv_flux_spectra'][0,0,:])
+
+
+<xarray.DataArray 'euv_flux_spectra' (band_center: 20)> Size: 160B
+array([ 2.642448  ,  0.83475   , 12.504     , 10.3367336 ,  7.01157116,
+        3.56471   ,  1.69090256,  0.72348547,  0.976695  ,  0.92705019,
+        0.51372157,  0.826272  ,  0.34776092,  0.22137   ,  1.19157903,
+        2.5642565 ,  5.945697  ,  4.793988  ,  2.2567559 ,  3.762175  ])
+Coordinates:
+    F10.7        float64 8B 200.0
+    F10.7AVG     float64 8B 200.0
+  * band_center  (band_center) float64 160B 7.5 12.5 17.5 ... 92.5 97.5 102.5
+```
+
+2. get_spectral_lines()
+
+Method for calculating spectrum in 17 separate lines from the range 5-105 nm. Method returns xarray Dataset class object.
+
+Input parameters:
+- f107 - single value of the daily index F10.7 (in s.f.u.);
+- f107avg - 81-day average F10.7 value (in s.f.u.).
+
+f107 and f107avg can be represented by lists for calculating spectra for several values of F<sub>10.7</sub> and F<sub>10.7A</sub>.
+In this case, the lengths of these lists should be the same.
+
+Output parameters:
+- xarray dataset
+``` 
+<xarray.Dataset> Size: 492B
+Dimensions:           (F10.7: 1, F10.7AVG: 1, line_wavelength: 17,
+                       line_number: 17)
+Coordinates:
+  * F10.7             (F10.7) float64 8B <input F10.7 values>
+  * F10.7AVG          (F10.7AVG) float64 8B <input F10.7A values>
+  * line_wavelength   (line_wavelength) float64 136B 25.63 28.41 ... 102.6 103.2
+  * line_number       (line_number) int32 68B 0 1 2 3 4 5 ... 11 12 13 14 15 16
+Data variables:
+    euv_flux_spectra  (F10.7, F10.7AVG, line_wavelength) float64 136B <output spectrum>
+    wavelength        (line_number) float64 136B 25.63 28.41 ... 102.6 103.2
+```
+
+Below is an example of spectrum calculation using get_spectra_lines() method
+```
+# importing a package with the alias pe
+import pyeuvac as pe
+# creating an instance of the Euvac class
+example = pe.Euvac()
+# calculate the spectrum values at F10.7 = 200 and F10.7A = 200 (P = 200 as an example of the Richards et al.) using get_spectral_bands()
+spectrum = example.get_spectral_lines(f107=200., f107avg=200.)
+# output the resulting EUV-spectra
+print(spectrum['euv_flux_spectra'])
+
+
+<xarray.DataArray 'euv_flux_spectra' (F10.7: 1, F10.7AVG: 1, line_wavelength: 17)> Size: 136B
+array([[[0.61318   , 3.679536  , 3.2       , 9.6599724 , 1.1641526 ,
+         0.55071116, 1.00224288, 2.05612492, 1.55873   , 2.22441   ,
+         0.49140144, 0.24854   , 0.6596096 , 0.977886  , 6.4812176 ,
+         5.676986  , 3.4313916 ]]])
+Coordinates:
+  * F10.7            (F10.7) float64 8B 200.0
+  * F10.7AVG         (F10.7AVG) float64 8B 200.0
+  * line_wavelength  (line_wavelength) float64 136B 25.63 28.41 ... 102.6 103.2
+```
+
+If you need to calculate the spectrum for several P values, pass them using a list:
+```
+# calculate the spectrum values at F10.7 = [200., 210., 220.] and F10.7A = [200., 210., 220.]
+spectrum = example.get_spectral_lines(f107=[200., 210., 220.], f107avg=[200., 210., 220.])
+# output the resulting EUV-spectra for the first pair of F10.7 and F10.7A
+print(spectrum['euv_flux_spectra'][0,0,:])
+
+
+<xarray.DataArray 'euv_flux_spectra' (line_wavelength: 17)> Size: 136B
+array([0.61318   , 3.679536  , 3.2       , 9.6599724 , 1.1641526 ,
+       0.55071116, 1.00224288, 2.05612492, 1.55873   , 2.22441   ,
+       0.49140144, 0.24854   , 0.6596096 , 0.977886  , 6.4812176 ,
+       5.676986  , 3.4313916 ])
+Coordinates:
+    F10.7            float64 8B 200.0
+    F10.7AVG         float64 8B 200.0
+  * line_wavelength  (line_wavelength) float64 136B 25.63 28.41 ... 102.6 103.2
+```
+
+3. get_spectra()
+
+This method combines the get_spectral_bands() and get_spectral_lines() methods. The method returns a tuple of 
+xarray Dataset (lines, bands), the first element is the flux in intervals, the second is the flux in individual lines.

pyeuvac-0.0.6b0/README.md

@@ -0,0 +1,180 @@
+# pyeuvac
+<!--Basic information-->
+pyeuvac is a Python3 implementation of the extra ultraviolet (EUV) flux model EUVAC described by P. G. Richards, 
+J. A. Fennelly, D. G. Torr. This EUV model provides fluxes in the range 5-105 nm, divided into 20 intervals 
+of 5 nm width and into 17 separate lines.
+
+If you use pyeuvac or Euvac model directly or indirectly, please, cite in your research the following paper:
+
+1. Richards, P. G., J. A. Fennelly, and D. G. Torr (1994), Euvac: A solar EUV Flux Model for aeronomic calculations, 
+J. Geophys. Res., 99(A5), 8981-8992. https://doi.org/10.1029/94JA00518
+
+# User's guide
+
+<!--Users guide-->
+
+## Installation
+
+The following command is used to install the package:
+
+```
+python -m pip install pyeuvac
+```
+pyeuvac is the name of the package.
+
+## Euvac
+
+The pyeuvac package contains one class Euvac which has 3 methods:
+- get_spectral_bands() for calculating the spectrum over intervals;
+- get_spectral_lines() for calculating the spectrum along individual lines;
+- get_spectra() for calculating the spectrum in a wavelength interval and in an individual wavelength.
+
+All methods of the class have two input parameters:
+- F<sub>10.7</sub> - daily value of the F<sub>10.7</sub> solar activity index (in s.f.u.);
+- F<sub>10.7A</sub> - the average value of the F<sub>10.7</sub> solar activity index for 81 days.
+
+Parameters can only be of types float, int, list and numpy.array. If there are several parameters, they are passed as 
+lists with an equal number of elements.
+
+## Usage example
+
+1. get_spectral_bands()
+
+Method for calculating spectrum in 5 nm wide intervals from 5-105 nm range. Method returns xarray Dataset class object.
+
+Input parameters:
+- f107 - single value of the daily index F<sub>10.7</sub> (in s.f.u.);
+- f107avg - 81-day average F<sub>10.7</sub> value (in s.f.u.).
+
+```
+<xarray.Dataset> Size: 736B
+Dimensions:           (F10.7: 1, F10.7AVG: 1, band_center: 20, band_number: 20)
+Coordinates:
+  * F10.7             (F10.7) float64 8B <input F10.7 values>
+  * F10.7AVG          (F10.7AVG) float64 8B <input F10.7A values>
+  * band_center       (band_center) float64 160B 7.5 12.5 17.5 ... 97.5 102.5
+  * band_number       (band_number) int32 80B 0 1 2 3 4 5 ... 14 15 16 17 18 19
+Data variables:
+    euv_flux_spectra  (F10.7, F10.7AVG, band_center) float64 160B <output spectrum>
+    lband             (band_number) float64 160B 5.0 10.0 15.0 ... 95.0 100.0
+    uband             (band_number) float64 160B 10.0 15.0 20.0 ... 100.0 105.0
+```
+The resulting spectrum is contained in a three-dimensional array with dimensions (F<sub>10.7</sub>, F<sub>10.7A</sub>, euv_spectrum)
+
+Below is an example of calculating the spectrum with input parameters F<sub>10.7</sub> = F<sub>10.7A</sub> = 200 s.f.u.
+```
+# importing a package with the alias pe
+import pyeuvac as pe
+# creating an instance of the Euvac class
+example = pe.Euvac()
+# calculate the spectrum values at F10.7 = 200 and F10.7A = 200 (P = 200 as an example of the Richards et al.) using get_spectral_bands()
+spectrum = example.get_spectral_bands(f107=200., f107avg=200.)
+# output the resulting EUV-spectra
+print(spectrum['euv_flux_spectra'])
+
+
+<xarray.DataArray 'euv_flux_spectra' (F10.7: 1, F10.7AVG: 1, band_center: 20)> Size: 160B
+array([[[ 2.642448  ,  0.83475   , 12.504     , 10.3367336 ,
+          7.01157116,  3.56471   ,  1.69090256,  0.72348547,
+          0.976695  ,  0.92705019,  0.51372157,  0.826272  ,
+          0.34776092,  0.22137   ,  1.19157903,  2.5642565 ,
+          5.945697  ,  4.793988  ,  2.2567559 ,  3.762175  ]]])
+Coordinates:
+  * F10.7        (F10.7) float64 8B 200.0
+  * F10.7AVG     (F10.7AVG) float64 8B 200.0
+  * band_center  (band_center) float64 160B 7.5 12.5 17.5 ... 92.5 97.5 102.5
+```
+
+If you need to calculate the spectrum for several F<sub>10.7</sub> and F<sub>10.7A</sub> values, pass them using a list.
+The number of values in the lists must be equal.
+```
+# calculate the spectrum values at F10.7 = [200., 210., 220.] and F10.7A = [200., 210., 220.]
+spectrum = example.get_spectral_bands(f107=[200., 210., 220.], f107avg=[200., 210., 220.])
+# output the resulting EUV-spectra for the first pair of F10.7 and F10.7A
+print(spectrum['euv_flux_spectra'][0,0,:])
+
+
+<xarray.DataArray 'euv_flux_spectra' (band_center: 20)> Size: 160B
+array([ 2.642448  ,  0.83475   , 12.504     , 10.3367336 ,  7.01157116,
+        3.56471   ,  1.69090256,  0.72348547,  0.976695  ,  0.92705019,
+        0.51372157,  0.826272  ,  0.34776092,  0.22137   ,  1.19157903,
+        2.5642565 ,  5.945697  ,  4.793988  ,  2.2567559 ,  3.762175  ])
+Coordinates:
+    F10.7        float64 8B 200.0
+    F10.7AVG     float64 8B 200.0
+  * band_center  (band_center) float64 160B 7.5 12.5 17.5 ... 92.5 97.5 102.5
+```
+
+2. get_spectral_lines()
+
+Method for calculating spectrum in 17 separate lines from the range 5-105 nm. Method returns xarray Dataset class object.
+
+Input parameters:
+- f107 - single value of the daily index F10.7 (in s.f.u.);
+- f107avg - 81-day average F10.7 value (in s.f.u.).
+
+f107 and f107avg can be represented by lists for calculating spectra for several values of F<sub>10.7</sub> and F<sub>10.7A</sub>.
+In this case, the lengths of these lists should be the same.
+
+Output parameters:
+- xarray dataset
+``` 
+<xarray.Dataset> Size: 492B
+Dimensions:           (F10.7: 1, F10.7AVG: 1, line_wavelength: 17,
+                       line_number: 17)
+Coordinates:
+  * F10.7             (F10.7) float64 8B <input F10.7 values>
+  * F10.7AVG          (F10.7AVG) float64 8B <input F10.7A values>
+  * line_wavelength   (line_wavelength) float64 136B 25.63 28.41 ... 102.6 103.2
+  * line_number       (line_number) int32 68B 0 1 2 3 4 5 ... 11 12 13 14 15 16
+Data variables:
+    euv_flux_spectra  (F10.7, F10.7AVG, line_wavelength) float64 136B <output spectrum>
+    wavelength        (line_number) float64 136B 25.63 28.41 ... 102.6 103.2
+```
+
+Below is an example of spectrum calculation using get_spectra_lines() method
+```
+# importing a package with the alias pe
+import pyeuvac as pe
+# creating an instance of the Euvac class
+example = pe.Euvac()
+# calculate the spectrum values at F10.7 = 200 and F10.7A = 200 (P = 200 as an example of the Richards et al.) using get_spectral_bands()
+spectrum = example.get_spectral_lines(f107=200., f107avg=200.)
+# output the resulting EUV-spectra
+print(spectrum['euv_flux_spectra'])
+
+
+<xarray.DataArray 'euv_flux_spectra' (F10.7: 1, F10.7AVG: 1, line_wavelength: 17)> Size: 136B
+array([[[0.61318   , 3.679536  , 3.2       , 9.6599724 , 1.1641526 ,
+         0.55071116, 1.00224288, 2.05612492, 1.55873   , 2.22441   ,
+         0.49140144, 0.24854   , 0.6596096 , 0.977886  , 6.4812176 ,
+         5.676986  , 3.4313916 ]]])
+Coordinates:
+  * F10.7            (F10.7) float64 8B 200.0
+  * F10.7AVG         (F10.7AVG) float64 8B 200.0
+  * line_wavelength  (line_wavelength) float64 136B 25.63 28.41 ... 102.6 103.2
+```
+
+If you need to calculate the spectrum for several P values, pass them using a list:
+```
+# calculate the spectrum values at F10.7 = [200., 210., 220.] and F10.7A = [200., 210., 220.]
+spectrum = example.get_spectral_lines(f107=[200., 210., 220.], f107avg=[200., 210., 220.])
+# output the resulting EUV-spectra for the first pair of F10.7 and F10.7A
+print(spectrum['euv_flux_spectra'][0,0,:])
+
+
+<xarray.DataArray 'euv_flux_spectra' (line_wavelength: 17)> Size: 136B
+array([0.61318   , 3.679536  , 3.2       , 9.6599724 , 1.1641526 ,
+       0.55071116, 1.00224288, 2.05612492, 1.55873   , 2.22441   ,
+       0.49140144, 0.24854   , 0.6596096 , 0.977886  , 6.4812176 ,
+       5.676986  , 3.4313916 ])
+Coordinates:
+    F10.7            float64 8B 200.0
+    F10.7AVG         float64 8B 200.0
+  * line_wavelength  (line_wavelength) float64 136B 25.63 28.41 ... 102.6 103.2
+```
+
+3. get_spectra()
+
+This method combines the get_spectral_bands() and get_spectral_lines() methods. The method returns a tuple of 
+xarray Dataset (lines, bands), the first element is the flux in intervals, the second is the flux in individual lines.

pyeuvac-0.0.6b0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyeuvac"
+version = "0.0.6b"
+authors = [
+  { name="Anton Tatarnikov", email="tatarnikoffanton@yandex.ru" },
+  { name="Oleg Zolotov", email="ovz.office@gmail.com" },
+]
+description = "Python3 implementation of EUVAC - extreme ultraviolet (EUV) flux model for aeronomic calculations."
+
+readme = "README.md"
+license = {file = "LICENSE"}
+
+keywords = ["Solar radiation model", "EUV"]
+
+requires-python = ">=3.7"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "License :: OSI Approved :: Apache Software License",
+    "Topic :: Scientific/Engineering :: Physics"
+]
+dependencies=[
+    "importlib-resources",
+    "netcdf4",
+    "numpy",
+    "pandas",
+    "xarray"
+]
+
+[project.urls]
+Homepage = "https://github.com/klklklo/pyeuvac"
+
+[tool.setuptools]
+include-package-data=true
+
+[tool.setuptools.package-data]
+"pyeuvac._coeffs" = [ "*.nc"]

pyeuvac-0.0.6b0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyeuvac-0.0.6b0/src/pyeuvac/__init__.py

@@ -0,0 +1 @@
+from pyeuvac._euvac import Euvac

pyeuvac-0.0.6b0/src/pyeuvac/_euvac.py

@@ -0,0 +1,135 @@
+import numpy as np
+import xarray as xr
+import pyeuvac._misc as _m
+
+
+class Euvac:
+    '''
+    EUVAC model class.
+    '''
+    def __init__(self):
+
+        self._bands_dataset, self._lines_dataset = _m.get_euvac()
+
+        self._bands_f74113 = np.array(self._bands_dataset['F74113'], dtype=np.float64).reshape(20,1)
+        self._bands_ai = np.array(self._bands_dataset['Ai'], dtype=np.float64).reshape(20,1)
+
+        self._lines_f74113 = np.array(self._lines_dataset['F74113'], dtype=np.float64).reshape(17,1)
+        self._lines_ai = np.array(self._lines_dataset['Ai'], dtype=np.float64).reshape(17,1)
+
+    def _get_p(self, i, f107, f107avg):
+        '''
+        Method for getting the P parameter. For each pair of values f107 and f107a, the value
+        P = (f107 + f107 avg) / 2. - 80. is calculated, and then a matrix is constructed,
+        each column of which is the value P.
+        :param i: number of rows.
+        :param f107: single value of the daily index F10.7 or an array of such values.
+        :param f107avg: a single value of the F10.7 index averaged over 81 days or an array of such values.
+        :return: numpy array.
+        '''
+
+        if f107.size != f107avg.size:
+            raise Exception(f'The number of F10.7 and F10.7_avg values does not match. f107 contained {f107.size} '
+                            f'elements, f107avg contained {f107avg.size} elements.')
+
+        p = (f107 + f107avg) / 2. - 80.
+        p_0 = p[:]
+        for j in range(i-1):
+            p_0 = np.vstack((p_0, p))
+
+        return p_0
+
+    def _check_types(self, *proxies):
+        if not all([isinstance(x, (float, int, list, np.ndarray)) for x in proxies]):
+            raise TypeError(f'Only float, int, list and np.ndarray types are allowed. f107 was {type(proxies[0])}, '
+                            f'f107avg was {type(proxies[1])}')
+        return True
+
+    def get_spectral_bands(self, *, f107, f107avg, correction=False):
+        '''
+        Model calculation method. Returns the values of radiation fluxes in all 20 intervals
+        of the spectrum of the interval 10-105 nm.
+        :param f107: single value of the daily index F10.7 or an array of such values.
+        :param f107avg: a single value of the F10.7 index averaged over 81 days or an array of such values.
+        :param correction: parameter for applying flux factor correction
+        :return: xarray Dataset [euv_flux_spectra, lband, uband].
+        '''
+
+        bands = 20
+
+        if self._check_types(f107, f107avg):
+
+            f107 = np.array([f107], dtype=np.float64) if isinstance(f107, (type(None), int, float)) \
+                else np.array(f107, dtype=np.float64)
+            f107avg = np.array([f107avg], dtype=np.float64) if isinstance(f107avg, (type(None), int, float)) \
+                else np.array(f107avg, dtype=np.float64)
+
+            p = self._get_p(bands,f107, f107avg)
+            pai = self._bands_ai * p + 1.0
+
+            if correction:
+                pai[pai < 0.8] = 0.8
+
+            spectra = self._bands_f74113 * pai
+
+            res = np.zeros((spectra.shape[1], spectra.shape[1], spectra.shape[0]))
+            for i in range(spectra.shape[1]):
+                res[i, i, :] = spectra[:, i]
+
+            return xr.Dataset(data_vars={'euv_flux_spectra': (('F10.7', 'F10.7AVG', 'band_center'), res),
+                                         'lband': ('band_number', self._bands_dataset['lband'].values),
+                                         'uband': ('band_number', self._bands_dataset['uband'].values)},
+                              coords={'F10.7': f107,
+                                      'F10.7AVG':  f107avg,
+                                      'band_center': self._bands_dataset['center'].values,
+                                      'band_number': np.arange(bands)})
+
+    def get_spectral_lines(self, *, f107, f107avg, correction=False):
+        '''
+        Model calculation method. Returns the values of radiation fluxes in all 17 lines
+        of the spectrum of the interval 10-105 nm.
+        :param f107: single value of the daily index F10.7 or an array of such values.
+        :param f107avg: a single value of the F10.7 index averaged over 81 days or an array of such values.
+        :param correction: parameter for applying flux factor correction
+        :return: xarray Dataset [euv_flux_spectra, wavelength].
+        '''
+
+        lines = 17
+
+        if self._check_types(f107, f107avg):
+
+            f107 = np.array([f107], dtype=np.float64) if isinstance(f107, (type(None), int, float)) \
+                else np.array(f107, dtype=np.float64)
+            f107avg = np.array([f107avg], dtype=np.float64) if isinstance(f107avg, (type(None), int, float)) \
+                else np.array(f107avg, dtype=np.float64)
+
+            p = self._get_p(lines, f107, f107avg)
+            pai = self._lines_ai * p + 1.0
+
+            if correction:
+                pai[pai < 0.8] = 0.8
+
+            spectra = self._lines_f74113 * pai
+
+            res = np.zeros((spectra.shape[1], spectra.shape[1], spectra.shape[0]))
+            for i in range(spectra.shape[1]):
+                res[i, i, :] = spectra[:, i]
+
+            return xr.Dataset(data_vars={'euv_flux_spectra': (('F10.7', 'F10.7AVG', 'line_wavelength'), res),
+                                         'wavelength': ('line_number', self._lines_dataset['lambda'].values)},
+                              coords={'F10.7': f107,
+                                      'F10.7AVG': f107avg,
+                                      'line_wavelength': self._lines_dataset['lambda'].values,
+                                      'line_number': np.arange(lines)})
+
+    def get_spectra(self, *, f107, f107avg, correction=False):
+        '''
+        Model calculation method. Combines the get_spectra_bands() and get_spectral_lines() methods.
+        :param f107: single value of the daily index F10.7 or an array of such values.
+        :param f107avg: a single value of the F10.7 index averaged over 81 days or an array of such values.
+        :param correction: parameter for applying flux factor correction
+        :return: xarray Dataset [euv_flux_spectra, lband, uband], xarray Dataset [euv_flux_spectra, wavelength].
+        '''
+
+        return (self.get_spectral_bands(f107=f107, f107avg=f107avg, correction=correction),
+                self.get_spectral_lines(f107=f107, f107avg=f107avg, correction=correction))

pyeuvac-0.0.6b0/src/pyeuvac/_misc.py

@@ -0,0 +1,11 @@
+import functools
+import xarray as xr
+from importlib_resources import files
+
+
+@functools.cache
+def _read_coeffs(file):
+    return xr.open_dataset(files('pyeuvac._coeffs').joinpath(file))
+
+def get_euvac():
+    return _read_coeffs('euvac_bands_coeffs.nc').copy(), _read_coeffs('euvac_lines_coeffs.nc').copy(),

pyeuvac-0.0.6b0/src/pyeuvac.egg-info/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.2
+Name: pyeuvac
+Version: 0.0.6b0
+Summary: Python3 implementation of EUVAC - extreme ultraviolet (EUV) flux model for aeronomic calculations.
+Author-email: Anton Tatarnikov <tatarnikoffanton@yandex.ru>, Oleg Zolotov <ovz.office@gmail.com>
+Project-URL: Homepage, https://github.com/klklklo/pyeuvac
+Keywords: Solar radiation model,EUV
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: importlib-resources
+Requires-Dist: netcdf4
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: xarray
+
+# pyeuvac
+<!--Basic information-->
+pyeuvac is a Python3 implementation of the extra ultraviolet (EUV) flux model EUVAC described by P. G. Richards, 
+J. A. Fennelly, D. G. Torr. This EUV model provides fluxes in the range 5-105 nm, divided into 20 intervals 
+of 5 nm width and into 17 separate lines.
+
+If you use pyeuvac or Euvac model directly or indirectly, please, cite in your research the following paper:
+
+1. Richards, P. G., J. A. Fennelly, and D. G. Torr (1994), Euvac: A solar EUV Flux Model for aeronomic calculations, 
+J. Geophys. Res., 99(A5), 8981-8992. https://doi.org/10.1029/94JA00518
+
+# User's guide
+
+<!--Users guide-->
+
+## Installation
+
+The following command is used to install the package:
+
+```
+python -m pip install pyeuvac
+```
+pyeuvac is the name of the package.
+
+## Euvac
+
+The pyeuvac package contains one class Euvac which has 3 methods:
+- get_spectral_bands() for calculating the spectrum over intervals;
+- get_spectral_lines() for calculating the spectrum along individual lines;
+- get_spectra() for calculating the spectrum in a wavelength interval and in an individual wavelength.
+
+All methods of the class have two input parameters:
+- F<sub>10.7</sub> - daily value of the F<sub>10.7</sub> solar activity index (in s.f.u.);
+- F<sub>10.7A</sub> - the average value of the F<sub>10.7</sub> solar activity index for 81 days.
+
+Parameters can only be of types float, int, list and numpy.array. If there are several parameters, they are passed as 
+lists with an equal number of elements.
+
+## Usage example
+
+1. get_spectral_bands()
+
+Method for calculating spectrum in 5 nm wide intervals from 5-105 nm range. Method returns xarray Dataset class object.
+
+Input parameters:
+- f107 - single value of the daily index F<sub>10.7</sub> (in s.f.u.);
+- f107avg - 81-day average F<sub>10.7</sub> value (in s.f.u.).
+
+```
+<xarray.Dataset> Size: 736B
+Dimensions:           (F10.7: 1, F10.7AVG: 1, band_center: 20, band_number: 20)
+Coordinates:
+  * F10.7             (F10.7) float64 8B <input F10.7 values>
+  * F10.7AVG          (F10.7AVG) float64 8B <input F10.7A values>
+  * band_center       (band_center) float64 160B 7.5 12.5 17.5 ... 97.5 102.5
+  * band_number       (band_number) int32 80B 0 1 2 3 4 5 ... 14 15 16 17 18 19
+Data variables:
+    euv_flux_spectra  (F10.7, F10.7AVG, band_center) float64 160B <output spectrum>
+    lband             (band_number) float64 160B 5.0 10.0 15.0 ... 95.0 100.0
+    uband             (band_number) float64 160B 10.0 15.0 20.0 ... 100.0 105.0
+```
+The resulting spectrum is contained in a three-dimensional array with dimensions (F<sub>10.7</sub>, F<sub>10.7A</sub>, euv_spectrum)
+
+Below is an example of calculating the spectrum with input parameters F<sub>10.7</sub> = F<sub>10.7A</sub> = 200 s.f.u.
+```
+# importing a package with the alias pe
+import pyeuvac as pe
+# creating an instance of the Euvac class
+example = pe.Euvac()
+# calculate the spectrum values at F10.7 = 200 and F10.7A = 200 (P = 200 as an example of the Richards et al.) using get_spectral_bands()
+spectrum = example.get_spectral_bands(f107=200., f107avg=200.)
+# output the resulting EUV-spectra
+print(spectrum['euv_flux_spectra'])
+
+
+<xarray.DataArray 'euv_flux_spectra' (F10.7: 1, F10.7AVG: 1, band_center: 20)> Size: 160B
+array([[[ 2.642448  ,  0.83475   , 12.504     , 10.3367336 ,
+          7.01157116,  3.56471   ,  1.69090256,  0.72348547,
+          0.976695  ,  0.92705019,  0.51372157,  0.826272  ,
+          0.34776092,  0.22137   ,  1.19157903,  2.5642565 ,
+          5.945697  ,  4.793988  ,  2.2567559 ,  3.762175  ]]])
+Coordinates:
+  * F10.7        (F10.7) float64 8B 200.0
+  * F10.7AVG     (F10.7AVG) float64 8B 200.0
+  * band_center  (band_center) float64 160B 7.5 12.5 17.5 ... 92.5 97.5 102.5
+```
+
+If you need to calculate the spectrum for several F<sub>10.7</sub> and F<sub>10.7A</sub> values, pass them using a list.
+The number of values in the lists must be equal.
+```
+# calculate the spectrum values at F10.7 = [200., 210., 220.] and F10.7A = [200., 210., 220.]
+spectrum = example.get_spectral_bands(f107=[200., 210., 220.], f107avg=[200., 210., 220.])
+# output the resulting EUV-spectra for the first pair of F10.7 and F10.7A
+print(spectrum['euv_flux_spectra'][0,0,:])
+
+
+<xarray.DataArray 'euv_flux_spectra' (band_center: 20)> Size: 160B
+array([ 2.642448  ,  0.83475   , 12.504     , 10.3367336 ,  7.01157116,
+        3.56471   ,  1.69090256,  0.72348547,  0.976695  ,  0.92705019,
+        0.51372157,  0.826272  ,  0.34776092,  0.22137   ,  1.19157903,
+        2.5642565 ,  5.945697  ,  4.793988  ,  2.2567559 ,  3.762175  ])
+Coordinates:
+    F10.7        float64 8B 200.0
+    F10.7AVG     float64 8B 200.0
+  * band_center  (band_center) float64 160B 7.5 12.5 17.5 ... 92.5 97.5 102.5
+```
+
+2. get_spectral_lines()
+
+Method for calculating spectrum in 17 separate lines from the range 5-105 nm. Method returns xarray Dataset class object.
+
+Input parameters:
+- f107 - single value of the daily index F10.7 (in s.f.u.);
+- f107avg - 81-day average F10.7 value (in s.f.u.).
+
+f107 and f107avg can be represented by lists for calculating spectra for several values of F<sub>10.7</sub> and F<sub>10.7A</sub>.
+In this case, the lengths of these lists should be the same.
+
+Output parameters:
+- xarray dataset
+``` 
+<xarray.Dataset> Size: 492B
+Dimensions:           (F10.7: 1, F10.7AVG: 1, line_wavelength: 17,
+                       line_number: 17)
+Coordinates:
+  * F10.7             (F10.7) float64 8B <input F10.7 values>
+  * F10.7AVG          (F10.7AVG) float64 8B <input F10.7A values>
+  * line_wavelength   (line_wavelength) float64 136B 25.63 28.41 ... 102.6 103.2
+  * line_number       (line_number) int32 68B 0 1 2 3 4 5 ... 11 12 13 14 15 16
+Data variables:
+    euv_flux_spectra  (F10.7, F10.7AVG, line_wavelength) float64 136B <output spectrum>
+    wavelength        (line_number) float64 136B 25.63 28.41 ... 102.6 103.2
+```
+
+Below is an example of spectrum calculation using get_spectra_lines() method
+```
+# importing a package with the alias pe
+import pyeuvac as pe
+# creating an instance of the Euvac class
+example = pe.Euvac()
+# calculate the spectrum values at F10.7 = 200 and F10.7A = 200 (P = 200 as an example of the Richards et al.) using get_spectral_bands()
+spectrum = example.get_spectral_lines(f107=200., f107avg=200.)
+# output the resulting EUV-spectra
+print(spectrum['euv_flux_spectra'])
+
+
+<xarray.DataArray 'euv_flux_spectra' (F10.7: 1, F10.7AVG: 1, line_wavelength: 17)> Size: 136B
+array([[[0.61318   , 3.679536  , 3.2       , 9.6599724 , 1.1641526 ,
+         0.55071116, 1.00224288, 2.05612492, 1.55873   , 2.22441   ,
+         0.49140144, 0.24854   , 0.6596096 , 0.977886  , 6.4812176 ,
+         5.676986  , 3.4313916 ]]])
+Coordinates:
+  * F10.7            (F10.7) float64 8B 200.0
+  * F10.7AVG         (F10.7AVG) float64 8B 200.0
+  * line_wavelength  (line_wavelength) float64 136B 25.63 28.41 ... 102.6 103.2
+```
+
+If you need to calculate the spectrum for several P values, pass them using a list:
+```
+# calculate the spectrum values at F10.7 = [200., 210., 220.] and F10.7A = [200., 210., 220.]
+spectrum = example.get_spectral_lines(f107=[200., 210., 220.], f107avg=[200., 210., 220.])
+# output the resulting EUV-spectra for the first pair of F10.7 and F10.7A
+print(spectrum['euv_flux_spectra'][0,0,:])
+
+
+<xarray.DataArray 'euv_flux_spectra' (line_wavelength: 17)> Size: 136B
+array([0.61318   , 3.679536  , 3.2       , 9.6599724 , 1.1641526 ,
+       0.55071116, 1.00224288, 2.05612492, 1.55873   , 2.22441   ,
+       0.49140144, 0.24854   , 0.6596096 , 0.977886  , 6.4812176 ,
+       5.676986  , 3.4313916 ])
+Coordinates:
+    F10.7            float64 8B 200.0
+    F10.7AVG         float64 8B 200.0
+  * line_wavelength  (line_wavelength) float64 136B 25.63 28.41 ... 102.6 103.2
+```
+
+3. get_spectra()
+
+This method combines the get_spectral_bands() and get_spectral_lines() methods. The method returns a tuple of 
+xarray Dataset (lines, bands), the first element is the flux in intervals, the second is the flux in individual lines.

pyeuvac-0.0.6b0/src/pyeuvac.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE.txt
+README.md
+pyproject.toml
+src/pyeuvac/__init__.py
+src/pyeuvac/_euvac.py
+src/pyeuvac/_misc.py
+src/pyeuvac.egg-info/PKG-INFO
+src/pyeuvac.egg-info/SOURCES.txt
+src/pyeuvac.egg-info/dependency_links.txt
+src/pyeuvac.egg-info/requires.txt
+src/pyeuvac.egg-info/top_level.txt
+src/pyeuvac/_coeffs/euvac_bands_coeffs.nc
+src/pyeuvac/_coeffs/euvac_lines_coeffs.nc

pyeuvac-0.0.6b0/src/pyeuvac.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyeuvac-0.0.6b0/src/pyeuvac.egg-info/requires.txt

@@ -0,0 +1,5 @@
+importlib-resources
+netcdf4
+numpy
+pandas
+xarray

pyeuvac-0.0.6b0/src/pyeuvac.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyeuvac