Repository files navigation

The Python Satellite Data Analysis Toolkit (pysat) provides a simple andflexible interface for robust data analysis from beginning to end - includingdownloading, loading, cleaning, managing, processing, and analyzing data.Pysat's plug-in design allows analysis support for any data, including userprovided data sets. The pysat team provides a variety of plug-ins to supportpublic scientific data sets in packages such as pysatNASA, pysatMadrigal, andmore, available as part of the generalpysat ecosystem.

FullDocumentation

JGR-Space PhysicsPublication

Pysat EcosystemPublication

Citation Info

Come join us on Slack! An invitation to the pysat workspace is availablein the 'About' section of thepysat GitHub Repository.Development meetings are generally held fortnightly.

• Instrument independent analysis routines.
• Instrument object providing an interface for downloading and analyzing a widevariety of science data sets.
  • Uses pandas or xarray for the underlying data structure;capable of handling the many forms scientific measurements take in aconsistent manner.
  • Standard scientific data handling tasks (e.g., identifying, downloading,and loading files and cleaning and modifying data) are built into theInstrument object.
  • Supports metadata consistent with the netCDF CF-1.6 standard. Each variablehas a name, long name, and units. Note units are informational only.
• Simplifies data management
  • Iterator support for loading data by day/file/orbit, independent of datastorage details.
  • Orbits are calculated on the fly from loaded data and span day breaks.
  • Iterate over custom seasons
• Supports rigorous time-series calculations that require spin up/down timeacross day, orbit, and file breaks.
• Includes helper functions to reduce the barrier in adding new scienceinstruments to pysat

The following instructions provide a guide for installing pysat and give someexamples on how to use the routines.

pysat uses common Python modules, as well as modules developed by and for theSpace Physics community. This module officially supports Python 3.X+.

pip install pysat

Note that while support for python 3.6 is maintained for opertional purposes, therehave been issues with installing through PyPi on older systems. Installation throughGitHub is recommended for older systems.

git clone https://github.com/pysat/pysat.git

Change directories into the repository folder and run the pyproject.toml orsetup.py file. For a local install use the "--user" flag after "install".

cd pysat/python -m build .pip install .

• The first time pysat is run, you will need to specify a directory to storethe data. In Python, run:

pysat.params['data_dirs'] = 'path/to/directory/that/may/or/may/not/exist'

• Nominal organization of data is top_dir/platform/name/tag/inst_id/files

Detailed examples and tutorials for using pysat are available in thedocumentation.