The DSCOVR dictionary provides classes and attributes specific to the DSCOVR (Deep Space Climate Observatory) mission.
Robert Deen (rgdeen), Image node (IMG)
DSCOVR (Deep Space Climate Observatory) is a space weather station that monitors changes in the solar wind, providing space weather alerts and forecasts for geomagnetic storms that could disrupt power grids, satellites, telecommunications, aviation and GPS. DSCOVR orbits about a million miles from Earth in a unique location called Lagrange point 1, which basically allows it to hover between the Sun and our planet. The spacecraft’s EPIC camera takes a new picture of Earth every two hours. The EPIC camera also captures images of solar eclipses and images of the Moon as it passes between DSCOVR and Earth. The primary DSCOVR data archive is hosted by the NASA Atmospheric Science Data Center (ASDC), however Lunar images are not archived in this repository due to the lack of cartographic information. The Planetary Data System Cartography and Imaging Node, NASA's data archive for planetary imagary, is archiving the Lunar data.
IMPORTANT NOTE: This mission is a "rescue" mission, where PDS is saving the lunar data and making it available to the public before the mission gets canceled. As such, we did not have time or resources to throroughly research the metadata. It is basically copied straight from the documentation we have. For example, we do not know what the Quaternion is rotating, the sense of the rotation, or even if it's scalar-first or scalar-last. Hopefully these answers are buried in the documentation somewhere; if not, they must be divined by the user. Since the primary Earth archive is with ASDC, presumably they will have better information. It is not great that we have these holes, but better that than lose the data permanently.
The following fields in the HDF are not transferred to this LDD, because
they were not applicable to the lunar case:
Lunar group:
centroid_mean_latitude
centroid_mean_longitude
geolocation_algorithm
geospatial_(lat|lon)_(min|max)
granule_version
image_set_date
(max|min)imum_(latitude|longitude)
product_level
bottom_latitude
bottom_longitude
centroid_center_height
centroid_center_(latitude|longitude)
east_longitude
left_latitude
left_longitude
north_latitude
south_latitude
top_latitude
top_longitude
west_longitude
Image group:
centroid_center_(latitude|longitude)
centroid_column_offset
centroid_row_offset
coordsys
darkspace
percent_bad_pixels
all of the pixel_type values (they're in the documentation instead)
- Download dictionary files from the PDS Data Dictionaries Page
- On GitHub
- Review the Change log
In this repo you will find...
- src/ - The directory containing the managed IngestLDD file that defines this namespace. This is where changes to the namespace itself are made.
- build/ - This directory holds the files generated by the build processing, including the schema files used in designing and validating labels, JSON for inclusion in code, and report files from the LDDTool execution that created the files. There are separate subdirectories for development versions and releases.
- test/ - This directory contains regression tests (in the form of documented labels) for this namespace.
- logs/ - This directory contains the logs generated by the GitHub-automated build and test processes of LDDTool and Validate.
- examples/ - This directory contains label samples for using this namespace.
- .github/ - This (possibly hidden) directory contains internal files used to manage the automated build processes.
The main branch is where you should merge your final changes to documentation and LDD structure.
The gh-pages branch is auto-generated and used to run the documentation site. DO NOT MAKE CHANGES HERE.
There is a common place to request enhancements and report problems for any PDS-curated dictionary - the PDS4 Issue Repo. Search for the [ldd-dscovr] update request block and click the green "Get Started" button.
If you'd like to actively contribute to development, begin with the feature/bug process described above. Then familiarize yourself with the LDD Update Process and contact the dictionary steward to coordinate development, testing, and release. And thanks!
See the PDS Data Dictionaries pages for documentation and tutorials describing the procedures required to reserve a namespace, establish a new repo, and build your dictionary.
If you need help creating your IngestLDD file, contact the Dictionary Stewards Group. Documentation is in preparation.
See the tutorial on updating and building an IngestLDD and the LDD Update Process for documentation of those procedures.
Each build is auto-generated using Github Actions, PDS4 LDDTool, and Validate Tool.
You can also download the IngestLDD file and build the dictionary locally. You will need to install [LDDTool] (https://nasa-pds.github.io/pds4-information-model/model-lddtool/index.html) on your system. Once you do, you can manually run LDDTool on the IngestLDD using the following command:
lddtool -lpsnJ PDS4_DSCOVR_IngestLDD.xml
The documentation website is managed by GitHub Pages. When changes are made on the main branch, GitHub will process those changes and update the gh-pages branch, which drives the website on pds-data-dictionaries.github.io.
If you would like to test your changes and generate the site on your own system:
- Clone the repository
- Install Python dependencies (preferably within a Python virtual environment1) using this command:
pip install -r requirements.txt
- Follow steps below
- Build the HTML documents
cd docs
make clean html
Note that in Windows environments you will need to run the "clean" and "html" operations as separate invocations of "make":
cd docs
make clean
make html
- Preview the HTML in your browser
open build/html/index.html
-
Install some additional dependencies:
On a Mac:
brew install texliveOn Linux:
apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended -
Make the PDF
cd docs
make latexpdf
The output PDF will be written into the docs/ directory.
The output file name will depend on the value for the project variable
in the docs/source/conf.py file.