Skip to content

Commit

Permalink
MAINT: updated readme
Browse files Browse the repository at this point in the history
Updated the readme install instructions and fixed a typo in the example.
  • Loading branch information
aburrell committed Feb 1, 2024
1 parent 0db87d1 commit fb4f357
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ a local install use the "--user" flag after "install".

```
cd pysatMadrigal/
python setup.py install
python -m build .
pip install .
```

# Examples
Expand All @@ -67,7 +68,7 @@ Afterward, pysat will identify them using the `platform` and `name` keywords.

```
pysat.utils.registry.register('pysatMadrigal.instruments.dmsp_ivm')
dst = pysat.Instrument('dmsp', 'ivm', tag='utd', inst_id='f15')
ivm = pysat.Instrument('dmsp', 'ivm', tag='utd', inst_id='f15')
```

The package also include analysis tools. Detailed examples are in the
Expand Down

0 comments on commit fb4f357

Please sign in to comment.