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 is currently in development. Almost every kind
of "primary observational data" product currently archived in the PDS
(under PDS3 or PDS4) should be covered eventually. [Currently-supported datasets are listed here.](docs/supported_datasets.md)
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](https://docs.google.com/forms/d/1JHyMDzC9LlXY4MOMcHqV5fbseSB096_PsLshAMqMWBw/viewform).
### Attribution
If you use _pdr_ in your work, please cite us using our Zenodo DOI: [](https://zenodo.org/badge/latestdoi/266449940)
### 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 reqiore 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 Binder for a
quick interactive demo of functionality:
[](https://mybinder.org/v2/gh/millionconcepts/pdr/main)
Additional information on usage including examples, output data types, notes and caveats, test, etc.
can now be accessed in our documentation on readthedocs at: https://pdr.readthedocs.io [](https://pdr.readthedocs.io/en/latest/?badge=latest)
---
This work is supported by NASA grant No. 80NSSC21K0885.
Raw data
{
"_id": null,
"home_page": "https://github.com/MillionConcepts/pdr",
"name": "pdr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Chase Million",
"author_email": "chase@millionconcepts.com",
"download_url": "https://files.pythonhosted.org/packages/6a/e6/9eb8a98767d74c2739b569f2f89592582422041d3cb810954b861990d1b5/pdr-1.0.6.tar.gz",
"platform": null,
"description": "README.md\n## The Planetary Data Reader (pdr)\n\nThis tool provides a single command---`read(\u2018/path/to/file\u2019)`---for ingesting\n_all_ common planetary data types. It is currently in development. Almost every kind\nof \"primary observational data\" product currently archived in the PDS\n(under PDS3 or PDS4) should be covered eventually. [Currently-supported datasets are listed here.](docs/supported_datasets.md) \n\nIf 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](https://docs.google.com/forms/d/1JHyMDzC9LlXY4MOMcHqV5fbseSB096_PsLshAMqMWBw/viewform).\n\n### Attribution\nIf you use _pdr_ in your work, please cite us using our Zenodo DOI: [](https://zenodo.org/badge/latestdoi/266449940)\n\n### Installation\n_pdr_ is now on `conda` and `pip`. We recommend (and only officially support) installation into a `conda` environment.\nYou can do this like so: \n\n```\nconda create --name pdrenv\nconda activate pdrenv\nconda install -c conda-forge pdr\n```\nThe minimum supported version of Python is _3.9_.\n\nUsing the conda install will install all dependencies in the environment.yml \nfile (both required and optional) for pdr. If you'd prefer to forego the \noptional dependencies, please use minimal_environment.yml in your \ninstallation. This is not supported through a direct conda install as \ndescribed above and will reqiore additional steps. Optional dependencies \nand the added functionality they support are listed below:\n\n - `pvl`: allows `Data.load(\"LABEL\", as_pvl=True)` which will load PDS3 labels as `pvl` objects rather than plain text\n - `astropy`: adds support for FITS files\n - `jupyter`: allows usage of the Example Jupyter Notebook (and other jupyter notebooks you create)\n - `pillow`: adds support for TIFF files and browse image rendering\n - `matplotlib`: allows usage of `save_sparklines`, an experimental browse function\n\n### Usage\n\nYou can check out our example Notebook on Binder for a \nquick interactive demo of functionality: \n[](https://mybinder.org/v2/gh/millionconcepts/pdr/main)\n\nAdditional information on usage including examples, output data types, notes and caveats, test, etc. \ncan now be accessed in our documentation on readthedocs at: https://pdr.readthedocs.io [](https://pdr.readthedocs.io/en/latest/?badge=latest)\n\n---\nThis work is supported by NASA grant No. 80NSSC21K0885.\n",
"bugtrack_url": null,
"license": null,
"summary": "Planetary Data Reader",
"version": "1.0.6",
"project_urls": {
"Homepage": "https://github.com/MillionConcepts/pdr"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ada13969fe2ad1e9605b1a5750deae9a0a1c8314d94722f59fc103ceeb54741",
"md5": "e7b6c5916a0d446fbe05f324c496c90c",
"sha256": "d67a27cc1235a3f4d7dc53b55fbbd96a97f9d8f2c59a92ec003d35bd5df09f85"
},
"downloads": -1,
"filename": "pdr-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7b6c5916a0d446fbe05f324c496c90c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 124354,
"upload_time": "2024-03-28T18:27:43",
"upload_time_iso_8601": "2024-03-28T18:27:43.756666Z",
"url": "https://files.pythonhosted.org/packages/4a/da/13969fe2ad1e9605b1a5750deae9a0a1c8314d94722f59fc103ceeb54741/pdr-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ae69eb8a98767d74c2739b569f2f89592582422041d3cb810954b861990d1b5",
"md5": "e1785e37e78a4c41f06f9f4544c34771",
"sha256": "fff4e4a2893a3eb62768d15fde0c73efb2b104c47db16ab23b1bcd0281749fed"
},
"downloads": -1,
"filename": "pdr-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "e1785e37e78a4c41f06f9f4544c34771",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 99897,
"upload_time": "2024-03-28T18:27:46",
"upload_time_iso_8601": "2024-03-28T18:27:46.348294Z",
"url": "https://files.pythonhosted.org/packages/6a/e6/9eb8a98767d74c2739b569f2f89592582422041d3cb810954b861990d1b5/pdr-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-28 18:27:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MillionConcepts",
"github_project": "pdr",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "pdr"
}
JSON
