Skip to main content

Planetary Data Reader

Project description

README.md

The Planetary Data Reader (pdr)

This tool provides a single command---read(‘/path/to/file’)---for ingesting all common planetary data types. It reads almost all "primary observational data" products currently archived in the PDS (under PDS3 or PDS4), and the fraction of products it does not read is continuously shrinking. Currently-supported datasets are listed here.

If the software fails while attempting to read from datasets that we have listed as supported, please submit an issue with a link to the file and information about the error (if applicable). There might also be datasets that work but are not listed. We would like to hear about those too. If a dataset is not yet supported that you would like us to consider prioritizing, please fill out this request form.

Attribution

If you use pdr in your work, please cite us using our Zenodo DOI: DOI

Installation

pdr is now on conda and pip. We recommend (and only officially support) installation into a conda environment. You can do this like so:

conda create --name pdrenv
conda activate pdrenv
conda install -c conda-forge pdr

The minimum supported version of Python is 3.9.

Using the conda install will install all dependencies in the environment.yml file (both required and optional) for pdr. If you'd prefer to forego the optional dependencies, please use minimal_environment.yml in your installation. This is not supported through a direct conda install as described above and will require additional steps. Optional dependencies and the added functionality they support are listed below:

  • pvl: allows Data.load("LABEL", as_pvl=True), which will load PDS3 labels as pvl objects rather than plain text
  • astropy: adds support for FITS files
  • jupyter: allows usage of the Example Jupyter Notebook (and other jupyter notebooks you create)
  • pillow: adds support for TIFF files and browse image rendering
  • matplotlib: allows usage of save_sparklines, an experimental browse function

Usage

You can check out our example Notebook on a JupyterLite server for a quick interactive demo of functionality: JupyterLite

Additional information on usage including examples, output data types, notes and caveats, tests, etc. can now be accessed in our documentation on readthedocs at: https://pdr.readthedocs.io Documentation Status

Contributing

Thank you for wanting to contribute to pdr and improving efforts to make planetary science data accessible. Please review our code of conduct before contributing. Contributor Covenant

If you have found a bug, a dataset that we claim to support that's not opening properly, or you have a feature request, please file an issue. We will also review pull requests, but would probably prefer you start the conversation with us first, so we can expect your contributions and make sure they will be within scope.

If you need general support you can find us on OpenPlanetary Slack or feel free to email the team.


This work is supported by NASA grant No. 80NSSC21K0885.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pdr-1.2.2.tar.gz (13.3 MB view details)

Uploaded Source

Built Distribution

pdr-1.2.2-py3-none-any.whl (273.1 kB view details)

Uploaded Python 3

File details

Details for the file pdr-1.2.2.tar.gz.

File metadata

  • Download URL: pdr-1.2.2.tar.gz
  • Upload date:
  • Size: 13.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for pdr-1.2.2.tar.gz
Algorithm Hash digest
SHA256 788ce23df8886c998d67e64335599a21a98500fbc62f02fe792fbd96bdb69ed0
MD5 29d0d95236dce7b2bc58b685a77b53c1
BLAKE2b-256 07185b456a7263f042bc33fc7356d34a39d8f5b9df9b595441d23b42c377d727

See more details on using hashes here.

File details

Details for the file pdr-1.2.2-py3-none-any.whl.

File metadata

  • Download URL: pdr-1.2.2-py3-none-any.whl
  • Upload date:
  • Size: 273.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for pdr-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 867929b4e5ff2005f3b34198a0ed3c9d71873c5ee9695e239a4aaa7595120f14
MD5 1c801cec2fd24a50f631312515a0e3fb
BLAKE2b-256 5e3103746a6735d62098cc8c4651f9828df4b3fcbda3d8709c5356ec383882f2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page