Skip to content

Commit

Permalink
Add docs (#25)
Browse files Browse the repository at this point in the history
* Add docs for LRO dictionary

* Add logs from failed LDD generation

* updates for tests

Removed discipline areas and updated header area for LROC tests

* update tests to set No.DATA for LROC

* update tests

added   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

* tests not working, rename temporarily

* tests not working, rename temporarily 2

* Update PDS4_LRO_IngestLDD.xml

ping to rebuild

* Auto-generated LDDs by PDSEN CI Bot

* re-enable tests with build working

* Auto-generated LDDs by PDSEN CI Bot

---------

Co-authored-by: PDSEN CI Bot <pdsen-ci@jpl.nasa.gov>
  • Loading branch information
thareUSGS and pdsen-ci authored Dec 5, 2024
1 parent 8122587 commit cd5a69d
Show file tree
Hide file tree
Showing 191 changed files with 27,792 additions and 4,044 deletions.
29 changes: 29 additions & 0 deletions ChangeLog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# New Horizons Mission Dictionary Change Log

## Version 1.0.4.0

* 10/09/2024 APL/RCE Additional Mini-RF elements part 2

## Version 1.0.3.0

* 06/30/2023 GEO/JGW (v1030) Added 4 attributes to Diviner_Parameters and LRO_Parameters classes

## Version 1.0.2.0

* 04/05/2023 GEO/JGW (v1021) Bug fix - adding missing permissible values to dlre_instrument_mode_id
* 01/19/2023 APL/RCE (v1020) Additional Mini-RF elements

## Version 1.0.1.0

* 01/16/2023 IMG/TMH (v1010) Added 5th extended mission for under mission_phase_name and built for 1I00/1J00
* 01/27/2022 GEO/SHS Rebuilt with 1H00 IM
* 10/22/2021 GEO/JGW Added Geodetic_Model class
* 10/11/2021 GEO/JGW Added permissible values for product_type
* 07/29/2021 GEO/JGW Rebuilt with 1G00 IM
* 07/26/2021 GEO/JGW Added LOLA_INSTRUMENT_MODE_ID
* 04/27/2021 GEO/JGW Added Diviner, LOLA, and Mini-RF elements
* 01/09/2020 GEO/SHS Added elements identified by Paul Geissler

## Version 1.0.0.0

* 11/06/2019 GEO/SHS Initial version.
70 changes: 66 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,72 @@

The Lunar Reconnaissance Orbiter (LRO) mission dictionary contains classes that describe aspects of the LRO mission and related instruments.

### Steward
GeoScience Node (GEO)

# Documentation
The User's Guide and detailed documentation for using this dictionary in
label design and processing
are located at https://pds-data-dictionaries.github.io/ldd-lro.
# Latest Release
* Download dictionary files from the [PDS Data Dictionaries Page](https://pds.nasa.gov/datastandards/dictionaries/#ldd-lro})
* On [GitHub](../../releases/latest)
* Review the [Change log](ChangeLog.md)
# About This Repository
* **[build](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.
* **[doc](docs)/** - This directory contains the source tree for the
documentation at https://pds-data-dictionaries.github.io/ldd-lro. The
PDF of that documentation can also be found here in the `main` branch/
* **[logs](logs)/** - This directory contains the logs generated by the
GitHub-automated build and test processes of LDDTool and Validate.
* **[src](src)/** - The directory containing the managed *IngestLDD* file
that defines this namespace. This is where changes to the namespace
itself are made.
* **[test](test)/** - This directory contains regression tests (in the
form of documented labels) for this namespace.
* **[.github](.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**.
# Contributing to this Dictionary
## Suggest a Feature or Report a Bug
<!-- replace "repo id" below with the "ldd-xxx" string from the
GitHub repo URL.-->
There is a common place to request enhancements and report problems for
any PDS-curated dictionary - the [PDS4 Issue Repo](https://github.com/pds-data-dictionaries/PDS4-LDD-Issue-Repo/issues/new/choose).
Search for the \[ldd-lro\] update request block and click the green "Get Started" button.

## Contribute Code or documentation
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](https://pds-data-dictionaries.github.io/development/ldd-update.html).

# General Support for Dictionary Developers
See the [PDS Data Dictionaries pages](https://pds-data-dictionaries.github.io)
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](https://pds-data-dictionaries.github.io/teams/pds-dd-stewards.html). Documentation is in preparation.
# For Dictionary Stewards
See the [tutorial on updating and building an IngestLDD](https://pds-data-dictionaries.github.io/support/tutorials.html#ldd-update-and-build-tutorial) and the [LDD Update Process](https://pds-data-dictionaries.github.io/development/ldd-update.html) for documentation of those procedures.
## Building the dictionary
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](https://nasa-pds.github.io/pds4-information-model/model-lddtool/index.html) on the IngestLDD using the following command:

```
lddtool -lpsnJ {IngestLDD file name}.xml
```

## Versions (Source)

[1.0.2.1](src)
[PDS4_LRO_IngestLDD.xml](src/PDS4_LRO_IngestLDD.xml)

## Builds

Expand All @@ -13,10 +76,9 @@ The build process insures compatibility of the LDD with the core information mod

This LDD has been built for the following versions of the PDS4 information model.

[1.16.0.0](build/release/1.16.0.0)
[1.17.0.0](build/release/1.17.0.0)
[1.18.0.0](build/release/1.18.0.0)
[1.19.0.0](build/release/1.19.0.0)
[1.20.0.0](build/release/1.20.0.0)
[1.21.0.0](build/release/1.21.0.0)

## Notes

Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- PDS4 Schematron for Name Space Id:lro Version:1.0.4.0 - Tue Oct 22 00:29:06 UTC 2024 -->
<!-- PDS4 Schematron for Name Space Id:lro Version:1.0.4.0 - Thu Dec 05 17:47:40 UTC 2024 -->
<!-- Generated from the PDS4 Information Model Version 1.16.0.0 - System Build 11.1 -->
<!-- *** This PDS4 schematron file is an operational deliverable. *** -->
<sch:schema xmlns:sch="http://purl.oclc.org/dsdl/schematron" queryBinding="xslt2">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
PDS4 Local Data Dictionary Processing Report

Configuration:
LDDTool Version 15.1.0
LDDTool Version 15.2.3
LDD Version Id: 1.0.4.0
LDD Label Version Id: 1.22
LDD Discipline (T/F): false
LDD Namespace URL: http://pds.nasa.gov/pds4/
LDD URN Prefix: urn:nasa:pds:
Time Tue Oct 22 00:29:06 UTC 2024
Time Thu Dec 05 17:47:40 UTC 2024
Common Schema [PDS4_PDS_1G00.xsd]
Common Schematron [PDS4_PDS_1G00.sch]
IM Version Id: 1.16.0.0
Expand Down Expand Up @@ -47,7 +47,7 @@ Parsed Input - Header:
The LRO dictionary contains classes that describe aspects of the
Lunar Reconnaissance Orbiter mission and related instruments.

Last Modification Time 2024-10-09T00:00Z
Last Modification Time 2024-12-05T10:45Z
PDS4 Merge Flag false

Parsed Input - Attributes:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- PDS4 XML product label for PDS4 V1.16.0.0 Tue Oct 22 00:29:06 UTC 2024 -->
<!-- PDS4 XML product label for PDS4 V1.16.0.0 Thu Dec 05 17:47:40 UTC 2024 -->
<!-- Generated from the PDS4 Information Model V1.16.0.0 - System Build 11.1 -->
<!-- *** This PDS4 XML product label is an operational deliverable. *** -->
<?xml-model href="https://pds.nasa.gov/pds4/pds/v1/PDS4_PDS_1G00.sch"
Expand All @@ -17,7 +17,7 @@
<product_class>Product_XML_Schema</product_class>
<Modification_History>
<Modification_Detail>
<modification_date>2024-10-21</modification_date>
<modification_date>2024-12-05</modification_date>
<version_id>1.22</version_id>
<description>This is the system generated PDS4 product label for PDS4 XML Schema and Schematron files.</description>
</Modification_Detail>
Expand All @@ -26,7 +26,7 @@
<File_Area_XML_Schema>
<File>
<file_name>PDS4_LRO_1G00_1040.xsd</file_name>
<creation_date_time>2024-10-21T17:29:06</creation_date_time>
<creation_date_time>2024-12-05T09:47:40</creation_date_time>
<file_size unit="byte">105903</file_size>
<records>2470</records>
</File>
Expand All @@ -40,7 +40,7 @@
<File_Area_XML_Schema>
<File>
<file_name>PDS4_LRO_1G00_1040.sch</file_name>
<creation_date_time>2024-10-21T17:29:06</creation_date_time>
<creation_date_time>2024-12-05T09:47:40</creation_date_time>
<file_size unit="byte">31271</file_size>
<records>483</records>
</File>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- PDS4 XML/Schema for Name Space Id:lro Version:1.0.4.0 - Tue Oct 22 00:29:06 UTC 2024 -->
<!-- PDS4 XML/Schema for Name Space Id:lro Version:1.0.4.0 - Thu Dec 05 17:47:40 UTC 2024 -->
<!-- Generated from the PDS4 Information Model Version 1.16.0.0 - System Build 11.1 -->
<!-- *** This PDS4 product schema is an operational deliverable. *** -->
<!-- -->
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- PDS4 Schematron for Name Space Id:lro Version:1.0.4.0 - Tue Oct 22 00:29:06 UTC 2024 -->
<!-- PDS4 Schematron for Name Space Id:lro Version:1.0.4.0 - Thu Dec 05 17:47:40 UTC 2024 -->
<!-- Generated from the PDS4 Information Model Version 1.17.0.0 - System Build 12.0 -->
<!-- *** This PDS4 schematron file is an operational deliverable. *** -->
<sch:schema xmlns:sch="http://purl.oclc.org/dsdl/schematron" queryBinding="xslt2">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
PDS4 Local Data Dictionary Processing Report

Configuration:
LDDTool Version 15.1.0
LDDTool Version 15.2.3
LDD Version Id: 1.0.4.0
LDD Label Version Id: 1.23
LDD Discipline (T/F): false
LDD Namespace URL: http://pds.nasa.gov/pds4/
LDD URN Prefix: urn:nasa:pds:
Time Tue Oct 22 00:29:06 UTC 2024
Time Thu Dec 05 17:47:40 UTC 2024
Common Schema [PDS4_PDS_1H00.xsd]
Common Schematron [PDS4_PDS_1H00.sch]
IM Version Id: 1.17.0.0
Expand Down Expand Up @@ -47,7 +47,7 @@ Parsed Input - Header:
The LRO dictionary contains classes that describe aspects of the
Lunar Reconnaissance Orbiter mission and related instruments.

Last Modification Time 2024-10-09T00:00Z
Last Modification Time 2024-12-05T10:45Z
PDS4 Merge Flag false

Parsed Input - Attributes:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- PDS4 XML product label for PDS4 V1.17.0.0 Tue Oct 22 00:29:06 UTC 2024 -->
<!-- PDS4 XML product label for PDS4 V1.17.0.0 Thu Dec 05 17:47:40 UTC 2024 -->
<!-- Generated from the PDS4 Information Model V1.17.0.0 - System Build 12.0 -->
<!-- *** This PDS4 XML product label is an operational deliverable. *** -->
<?xml-model href="https://pds.nasa.gov/pds4/pds/v1/PDS4_PDS_1H00.sch"
Expand All @@ -17,7 +17,7 @@
<product_class>Product_XML_Schema</product_class>
<Modification_History>
<Modification_Detail>
<modification_date>2024-10-21</modification_date>
<modification_date>2024-12-05</modification_date>
<version_id>1.23</version_id>
<description>This is the system generated PDS4 product label for PDS4 XML Schema and Schematron files.</description>
</Modification_Detail>
Expand All @@ -26,7 +26,7 @@
<File_Area_XML_Schema>
<File>
<file_name>PDS4_LRO_1H00_1040.xsd</file_name>
<creation_date_time>2024-10-21T17:29:06</creation_date_time>
<creation_date_time>2024-12-05T09:47:40</creation_date_time>
<file_size unit="byte">105903</file_size>
<records>2470</records>
</File>
Expand All @@ -40,7 +40,7 @@
<File_Area_XML_Schema>
<File>
<file_name>PDS4_LRO_1H00_1040.sch</file_name>
<creation_date_time>2024-10-21T17:29:06</creation_date_time>
<creation_date_time>2024-12-05T09:47:40</creation_date_time>
<file_size unit="byte">31271</file_size>
<records>483</records>
</File>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- PDS4 XML/Schema for Name Space Id:lro Version:1.0.4.0 - Tue Oct 22 00:29:06 UTC 2024 -->
<!-- PDS4 XML/Schema for Name Space Id:lro Version:1.0.4.0 - Thu Dec 05 17:47:40 UTC 2024 -->
<!-- Generated from the PDS4 Information Model Version 1.17.0.0 - System Build 12.0 -->
<!-- *** This PDS4 product schema is an operational deliverable. *** -->
<!-- -->
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- PDS4 Schematron for Name Space Id:lro Version:1.0.4.0 - Tue Oct 22 00:29:09 UTC 2024 -->
<!-- PDS4 Schematron for Name Space Id:lro Version:1.0.4.0 - Thu Dec 05 17:47:38 UTC 2024 -->
<!-- Generated from the PDS4 Information Model Version 1.18.0.0 - System Build 12.1 -->
<!-- *** This PDS4 schematron file is an operational deliverable. *** -->
<sch:schema xmlns:sch="http://purl.oclc.org/dsdl/schematron" queryBinding="xslt2">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
PDS4 Local Data Dictionary Processing Report

Configuration:
LDDTool Version 15.1.0
LDDTool Version 15.2.3
LDD Version Id: 1.0.4.0
LDD Label Version Id: 1.24
LDD Discipline (T/F): false
LDD Namespace URL: http://pds.nasa.gov/pds4/
LDD URN Prefix: urn:nasa:pds:
Time Tue Oct 22 00:29:09 UTC 2024
Time Thu Dec 05 17:47:38 UTC 2024
Common Schema [PDS4_PDS_1I00.xsd]
Common Schematron [PDS4_PDS_1I00.sch]
IM Version Id: 1.18.0.0
Expand Down Expand Up @@ -47,7 +47,7 @@ Parsed Input - Header:
The LRO dictionary contains classes that describe aspects of the
Lunar Reconnaissance Orbiter mission and related instruments.

Last Modification Time 2024-10-09T00:00Z
Last Modification Time 2024-12-05T10:45Z
PDS4 Merge Flag false

Parsed Input - Attributes:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- PDS4 XML product label for PDS4 V1.18.0.0 Tue Oct 22 00:29:09 UTC 2024 -->
<!-- PDS4 XML product label for PDS4 V1.18.0.0 Thu Dec 05 17:47:38 UTC 2024 -->
<!-- Generated from the PDS4 Information Model V1.18.0.0 - System Build 12.1 -->
<!-- *** This PDS4 XML product label is an operational deliverable. *** -->
<?xml-model href="https://pds.nasa.gov/pds4/pds/v1/PDS4_PDS_1I00.sch"
Expand All @@ -17,7 +17,7 @@
<product_class>Product_XML_Schema</product_class>
<Modification_History>
<Modification_Detail>
<modification_date>2024-10-21</modification_date>
<modification_date>2024-12-05</modification_date>
<version_id>1.24</version_id>
<description>This is the system generated PDS4 product label for PDS4 XML Schema and Schematron files.</description>
</Modification_Detail>
Expand All @@ -26,7 +26,7 @@
<File_Area_XML_Schema>
<File>
<file_name>PDS4_LRO_1I00_1040.xsd</file_name>
<creation_date_time>2024-10-21T17:29:10</creation_date_time>
<creation_date_time>2024-12-05T09:47:38</creation_date_time>
<file_size unit="byte">105903</file_size>
<records>2470</records>
</File>
Expand All @@ -40,7 +40,7 @@
<File_Area_XML_Schema>
<File>
<file_name>PDS4_LRO_1I00_1040.sch</file_name>
<creation_date_time>2024-10-21T17:29:10</creation_date_time>
<creation_date_time>2024-12-05T09:47:38</creation_date_time>
<file_size unit="byte">31271</file_size>
<records>483</records>
</File>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- PDS4 XML/Schema for Name Space Id:lro Version:1.0.4.0 - Tue Oct 22 00:29:09 UTC 2024 -->
<!-- PDS4 XML/Schema for Name Space Id:lro Version:1.0.4.0 - Thu Dec 05 17:47:38 UTC 2024 -->
<!-- Generated from the PDS4 Information Model Version 1.18.0.0 - System Build 12.1 -->
<!-- *** This PDS4 product schema is an operational deliverable. *** -->
<!-- -->
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- PDS4 Schematron for Name Space Id:lro Version:1.0.4.0 - Tue Oct 22 00:29:07 UTC 2024 -->
<!-- PDS4 Schematron for Name Space Id:lro Version:1.0.4.0 - Thu Dec 05 17:47:36 UTC 2024 -->
<!-- Generated from the PDS4 Information Model Version 1.19.0.0 - System Build 13.0 -->
<!-- *** This PDS4 schematron file is an operational deliverable. *** -->
<sch:schema xmlns:sch="http://purl.oclc.org/dsdl/schematron" queryBinding="xslt2">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
PDS4 Local Data Dictionary Processing Report

Configuration:
LDDTool Version 15.1.0
LDDTool Version 15.2.3
LDD Version Id: 1.0.4.0
LDD Label Version Id: 1.25
LDD Discipline (T/F): false
LDD Namespace URL: http://pds.nasa.gov/pds4/
LDD URN Prefix: urn:nasa:pds:
Time Tue Oct 22 00:29:07 UTC 2024
Time Thu Dec 05 17:47:36 UTC 2024
Common Schema [PDS4_PDS_1J00.xsd]
Common Schematron [PDS4_PDS_1J00.sch]
IM Version Id: 1.19.0.0
Expand Down Expand Up @@ -47,7 +47,7 @@ Parsed Input - Header:
The LRO dictionary contains classes that describe aspects of the
Lunar Reconnaissance Orbiter mission and related instruments.

Last Modification Time 2024-10-09T00:00Z
Last Modification Time 2024-12-05T10:45Z
PDS4 Merge Flag false

Parsed Input - Attributes:
Expand Down
Loading

0 comments on commit cd5a69d

Please sign in to comment.