Skip to content

Commit

Permalink
DOC: update reqs
Browse files Browse the repository at this point in the history
  • Loading branch information
jklenzing committed Nov 25, 2024
1 parent 97cca38 commit 5dea25e
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 25 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ some examples on how to use the routines

pysatNASA uses common Python modules, as well as modules developed by
and for the Space Physics community. This module officially supports
Python 3.6+.
Python 3.9+.

| Common modules | Community modules | Optional Modules |
| ---------------- | ----------------- |------------------|
| beautifulsoup4 | cdflib>=0.4.4 | pysatCDF |
| lxml | pysat>=3.1.0 | |
| beautifulsoup4 | cdflib>=1.0.2 | pysatCDF |
| lxml | pysat>=3.2.0 | |
| netCDF4 | | |
| numpy | | |
| pandas | | |
Expand Down Expand Up @@ -54,7 +54,7 @@ pip install .

Note: pre-1.0.0 version
-----------------------
pysatNASA is currently in an initial development phase and requires pysat 3.1.0.
pysatNASA is currently in an initial development phase and requires pysat 3.2.0.
Feedback and contributions are appreciated.

# Using with pysat
Expand All @@ -68,7 +68,7 @@ from pysatNASA.instruments import icon_ivm
ivm = pysat.Instrument(inst_module=icon_ivm, inst_id='a')
```
Another way to use the instruments in an external repository is to register the
instruments. This only needs to be done the first time you load an instrument.
instruments. This only needs to be done the first time you load an instrument.
Afterward, pysat will identify them using the `platform` and `name` keywords.

```
Expand All @@ -81,10 +81,10 @@ ivm = pysat.Instrument('icon', 'ivm', inst_id='a')
# CDF Integration
For data products stored as CDF files, this package can use either `cdflib` or
`pysatCDF`. Note that `cdflib` is a pure python package and more readily
deployable across systems, whereas `pysatCDF` interfaces with the fortran.
This is a faster approach for loading data, but may not install on all systems.
deployable across systems, whereas `pysatCDF` interfaces with the fortran.
This is a faster approach for loading data, but may not install on all systems.
There are known issues with `numpy`>=1.24. Therefore, `pysatCDF` is optional
rather than required.
rather than required.

You can specify which load routine to use via the optional `use_cdflib` kwarg.
If no kwarg is specified, `pysatNASA` will default to `pysatCDF` if it is
Expand Down
8 changes: 4 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ Prerequisites

pysatNASA uses common Python modules, as well as modules developed by
and for the Space Physics community. This module officially supports
Python 3.6+ and pysat 3.1.0+.
Python 3.9+ and pysat 3.2.0+.

================== =================
Common modules Community modules
================== =================
beautifulsoup4 cdflib>=0.4.4
lxml pysat>=3.1.0
beautifulsoup4 cdflib>=1.0.2
lxml pysat>=3.2.0
netCDF4
numpy
pandas
requests
scipy>=1.4.0
scipy>=1.10.0
xarray
================== =================

Expand Down
10 changes: 5 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ name = "pysatNASA"
version = "0.0.6"
description = "pysat support for NASA Instruments"
readme = "README.md"
requires-python = ">=3.6"
requires-python = ">=3.9"
license = {file = "LICENSE"}
authors = [
{name = "Jeff Klenzing, et al.", email = "[email protected]"},
Expand All @@ -21,10 +21,10 @@ classifiers = [
"License :: OSI Approved :: BSD License",
"Natural Language :: English",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Operating System :: POSIX :: Linux",
"Operating System :: MacOS :: MacOS X",
"Operating System :: Microsoft :: Windows"
Expand All @@ -39,14 +39,14 @@ keywords = [
dependencies = [
"beautifulsoup4",
"cdasws",
"cdflib >= 1.0",
"cdflib >= 1.0.2",
"lxml",
"netCDF4",
"numpy",
"pandas",
"pysat >= 3.2",
"requests",
"scipy >= 1.4",
"scipy >= 1.10",
"xarray"
]

Expand Down
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
beautifulsoup4
cdasws
cdflib>=0.4.4
cdflib>=1.0.2
lxml
netCDF4
numpy
pandas
pysat>=3.1.0
pysat>=3.2.0
requests
xarray
6 changes: 0 additions & 6 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
# name and version must be maintained here as well for python 3.6 compatibility

[metadata]
name = pysatNASA
version = 0.0.6

[flake8]
max-line-length = 80
ignore =
Expand Down

0 comments on commit 5dea25e

Please sign in to comment.