Core package for planetary science tools.
This package is in early alpha.
Core dev Michael Aye has developed a set of tools that, step by step and under reviews
of the planetarypy org technical committee, will be incorporated into a new core library
for working in planetary science in Python.
That package will be open for public contribution and collaboration.
The approximate feature set (also see below) that this package will cover can be checked out at https://michaelaye.github.io/nbplanetary where the documentation for the current package lives.
- Free software: BSD-3 license
- Documentation (not yet deployed): https://planetarypy.readthedocs.io
- Part of the PlanetaryPy Organisation.
From PyPI (once published):
pip install planetarypyFrom GitHub:
pip install git+https://github.com/planetarypy/planetarypy.gitFor development installation:
# Clone the repository
git clone https://github.com/planetarypy/planetarypy.git
cd planetarypy
# Install in development mode with dev dependencies
pip install -e ".[dev]"The package includes robust tools for working with PDS (Planetary Data System) indices:
- Index Configuration: Manage URLs and access timestamps in separate configuration files
- Dynamic URL Discovery: Automatically find and use the latest index files for mission data
- Index Browsing: Easily explore available missions, instruments, and indices
from planetarypy.pds import print_pds_tree, list_missions, list_instruments, list_indexes
# Display all available PDS indices in a tree structure
print_pds_tree()
# Get a list of all missions
missions = list_missions()
# Get all instruments for a specific mission
instruments = list_instruments('mro')
# Get all indices for a specific mission and instrument
indices = list_indexes('cassini', 'iss')- Index Management: Download, update, and convert indices to high-performance parquet format
from planetarypy.pds import Index
# Create an index object
idx = Index('cassini.iss.ring_summary')
# Check if updates are available
idx.check_for_updates()
# Download the index
idx.download()First and foremost this package shall provide support in working with planetary science data.
With working we mean:
- locating
- retrieving
- reading
- further processing
of data.
This library manages, via its PDS tools, multiple PDS3 index files per instrument that can be used for identifying data of interest. These index files are automatically downloaded and converted to the very performant (and cloud-ready) parquet file format. Parquet is able to store advanced datatypes like nan-capable integer and full datetime objects, as opposed to HDF5.
The interface to getting data is via a path-retrieving function based on a PDS product-id. If that product-id is available locally, the path will be returned. If it is not, it will previously be downloaded, stored in a systematic fashion organized by mission and instrument, and then the local path will be returned.
For now, the library only returns the path to the object and the user needs to sort out the reading process. A recently funded NASA project Planetary Data Reader will be integrated here, so that basic reading into memory can be provided.
As such, we anticipate two classes of reading support:
- basic reading into numpy and/or xarray
- added reader functionality like basic plots and basic geospatial processing, as supported by interested parties
There will exist larger other packages that focus on working with a given instrument's data,
in which case that package could become an affiliated package with the planetarypy GitHub
organization, if so desired.
In the future, additional frequently used procedures will be added to this library, e.g.
- frequently used GDAL/rasterio procedures
- frequently used SPICE operations, e.g. surface illumination on a given body
Feedback, issues, and contributions are always gratefully welcomed. See the contributing guide for details on how to help and setup a development environment.