From 5dea25e169a58cbc5b6cbdcd14dc03414d8b0087 Mon Sep 17 00:00:00 2001 From: Jeff Klenzing Date: Mon, 25 Nov 2024 16:26:32 -0500 Subject: [PATCH] DOC: update reqs --- README.md | 16 ++++++++-------- docs/installation.rst | 8 ++++---- pyproject.toml | 10 +++++----- requirements.txt | 4 ++-- setup.cfg | 6 ------ 5 files changed, 19 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 86d45ad5..9357e9d4 100644 --- a/README.md +++ b/README.md @@ -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 | | | @@ -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 @@ -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. ``` @@ -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 diff --git a/docs/installation.rst b/docs/installation.rst index 2722700f..694ebf92 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -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 ================== ================= diff --git a/pyproject.toml b/pyproject.toml index b5950de0..4ae71e1a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 = "pysat.developers@gmail.com"}, @@ -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" @@ -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" ] diff --git a/requirements.txt b/requirements.txt index 3684998a..0ae6c10e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -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 diff --git a/setup.cfg b/setup.cfg index 32dc6c9c..ccced987 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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 =