Skip to content

Commit

Permalink
DOC: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jklenzing committed Feb 26, 2020
1 parent 7b25755 commit e75b825
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,11 @@ The methods that run empirical models can also be exported to any pysat instrume

```
import pysat
import pysatMissions.methods.empirical as mm_emp
from pysatMissions.methods import empirical
ivm = pysat.Instrument(platform='cnofs', name='ivm')
ivm.custom.add(mm_emp.add_iri_thermal_plasma, 'modify', glat_label='glat',
ivm.custom.add(empirical.add_iri_thermal_plasma, 'modify',
glat_label='glat',
glong_label='glon', alt_label='altitude')
```
Once the custom function is added, the model will automatically be run when the dataset is loaded.
4 changes: 2 additions & 2 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ A number of methods are included to invoke several python wrappers for empirical
.. code:: python
import pysat
from pysatMissions.methods import empirical as mm_emp
from pysatMissions.methods import empirical
ivm = pysat.Instrument(platform='cnofs', name='ivm')
ivm.custom.add(mm_emp.add_iri_thermal_plasma, 'modify', 'end', glat_label='glat', glong_label='glon', alt_label='altitude')
ivm.custom.add(empirical.add_iri_thermal_plasma, 'modify', 'end', glat_label='glat', glong_label='glon', alt_label='altitude')
Note that in this case, the latitude, longitude, and altitude variable names of the instrument must be specified since they are not identical to the default names in the function.
2 changes: 1 addition & 1 deletion pysatMissions/methods/magcoord.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Provides default routines for projecting aacgmv2 model values onto locations
"""Provides default routines for projecting aacgmv2 and apexpy model values onto locations
from pysat instruments.
"""
Expand Down

0 comments on commit e75b825

Please sign in to comment.