You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-19Lines changed: 19 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -12,21 +12,21 @@ If you use this software for scientific research, please reference the above pap
12
12
13
13
You can either install directly from PyPi using
14
14
15
-
```
15
+
```shell
16
16
pip install CosRayModifiedISO
17
17
```
18
18
19
19
Or clone CosRayModifiedISO from https://github.com/ssc-maire/CosRayModifiedISO, and then from the cloned directory, run
20
20
21
-
```
21
+
```shell
22
22
sudo python setup.py install
23
23
```
24
24
25
25
# Usage
26
26
27
27
to import this module, use
28
28
29
-
```
29
+
```python
30
30
from CosRayModifiedISO import CosRayModifiedISO
31
31
```
32
32
@@ -61,12 +61,12 @@ Unit description:
61
61
62
62
to get a single differential flux value for a particle value of solar modulation, and for a particular particle with a given atomic number and kinetic energy
63
63
(or range of kinetic energies), the appropriate method for `CosRayModifiedISO` is
method, where `OULUcountRatePerSecond` is a single float representing the count rate per second of the OULU neutron monitor at a given instance of time.
142
142
The solar modulation parameter can also be supplied directly using
This function can be identically supplied with the monthly averaged sunspot number instead of the solar modulation parameter, which the solar modulation parameter
147
147
is essentially a proxy for. Alternatively the identical function
Each of these three methods output Pandas DataFrames in the same format as outputted by `getSpectrumUsingTimestamp`. The value of the solar modulation parameter
155
155
as a function of OULU neutron monitor monitor count rate can also be outputted by running
In addition to the above spectrum calculation methods, there are also several methods for performing conversion between different quantities for input and output.
0 commit comments