Skip to content

godber/planetary_test_data

 
 

Repository files navigation

Planetary Test Data

image

image

Planetary Test Data contains a list of planetary data for software testing purposes and utilities to retrieve them.

  • Free software: BSD license

Features

  • Downloads a core set of sample Planetary test data into ./mission_data/ or if ./tests/mission_data/ if ./tests/ exists.

TODO

  • Download to central cache directory and use symbolic links to share data between projects or other locations.
  • Find smaller example images to reduce download times.
  • Command line usage improvements
    • Include a mode that just copies the data.json file into the local directory.
    • Include a mode that allows users to somehow specify subsets of data to retrieve. Perhaps selecting by mission or instrument name.
  • Improve label testing.
  • Include Mission Names with each product.
  • Include product type with each product.

See also the Github issues for this project.

Usage

To download the core set of planetary test data install this package with pip and then run the command get_mission_data:

pip install planetary_test_data
get_mission_data

Additional usage options are shown below:

usage: get_mission_data [-h] [--all] [--file FILE] [--dir DIR]
                        [--tags [TAGS [TAGS ...]]]

optional arguments:
  -h, --help            show this help message and exit
  --all, -a             Download all products.
  --file FILE, -f FILE  Override default data.json by providing path to custom
                        data.json file.
  --dir DIR, -d DIR     Directory to place test data products in.
  --tags [TAGS [TAGS ...]], -t [TAGS [TAGS ...]]
                        Retrieve products whose tags match those provided
                        here.

Description

Running get_mission_data will do the following

  • If tests directory exists it will create tests/mission_data if necessary. If tests does not exist, it will just create mission_data in the current directory.
  • The data prodcuts tagged to be core products will be downloaded into the download directory.

Only products which do not exist in the download directory will be downloaded.

Mission Data

The PDS mission data included in the package can be found here:

https://github.com/planetarypy/planetary_test_data/blob/master/planetary_test_data/data.json

If there are products you think should be included or removed from this dataset please file a Github issue.

data.json Format

The data.json file contains PDS product names, urls and other metainformation about the product. This structure will be extended to support generic testing, for instance the label key will be changed to a dictionary that includes product label keys and the values found at those keys.

Below is a sample snippet of a data.json entry:

"1m298459885effa312p2956m2m1.img": {
    "instrument": "MICROSCOPIC IMAGER", 
    "label": "PDS3", 
    "opens": "True", 
    "url": "http://pds-imaging.jpl.nasa.gov/data/mer/opportunity/mer1mo_0xxx/data/sol1918/edr/1m298459885effa312p2956m2m1.img"
}, 

About

Simple package that retrieves the suite of planetary data supported by planetaryimage.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 87.9%
  • Makefile 12.1%