https://github.com/nasa-pds/supplementer
A tool to ingest supplemental metadata for PDS products.
https://github.com/nasa-pds/supplementer
pds
Last synced: 2 months ago
JSON representation
A tool to ingest supplemental metadata for PDS products.
- Host: GitHub
- URL: https://github.com/nasa-pds/supplementer
- Owner: NASA-PDS
- License: other
- Created: 2021-06-21T17:55:13.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-11-21T17:12:59.000Z (over 3 years ago)
- Last Synced: 2025-01-05T20:26:51.059Z (over 1 year ago)
- Topics: pds
- Language: Java
- Homepage:
- Size: 96.7 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Supplementer
Supplementer is a tool to ingest supplemental metadata for Planetary Data System (PDS) products into a PDS Registry.
## Documentation
You can find documentation for the latest release of the Supplementer tool, including installation and operation
at https://nasa-pds.github.io/pds-registry-app/
## Build
You need JDK 11 and Maven to build this project. To create distribution package, run
```
mvn package
```
### Dependencies on other PDS Projects
- https://github.com/NASA-PDS/pds4-jparser - PDS label data table parser.
- https://github.com/NASA-PDS/pds-registry-common - Elasticsearch client, date conversion.
## Installation
- Either download binary release (ZIP or TGZ archives) from https://github.com/NASA-PDS/supplementer/releases
or, if you built the project yourself, get the ZIP or TGZ archive from "target" directory.
- Extract the archive to any folder, such as /home/pds
## Usage
Go to "bin" folder in the installation directory and run `supplementer` without any parameters to see the help screen.
### Example 1:
Load supplemental data from Product_Metadata_Supplemental label into local registry (Elasticsearch)
```
supplementer load-labels /home/user1/data/prod_supplemental_1.xml
```
### Example 2:
Load supplemental data from a list of Product_Metadata_Supplemental labels generated by Harvest
Harvest generates `supplemental.txt` file with a list of Product_Metadata_Supplemental label files in its output directory. Content of `supplemental.txt` file might look like this:
```
/home/user1/data/my_supplemental_label.xml
/home/user1/data/another_supplemental_product.xml
```
To load this list into local registry, run the following command:
```
supplementer load-labels /tmp/harvest/out/supplemental.txt
```
### Add DOI Metadata from Database
Run following command to import data from Sqlite DOI database into the Registry
```
supplementer add-doi -file /tmp/my_doi.db
```
You can also pass optional parameters to configure Registry URL and authentication.
```
Usage: supplementer add-doi
Add DOIs to already registered products.
Required parameters:
-file Path to Sqlite database
Optional parameters:
-auth Registry authentication configuration file
-es Registry (OpenSearch) URL. Default is http://localhost:9200
-index Registry index name. Default is 'registry'
```
Once executed, check ops:Identifiers/ops:doi field in OpenSearch / Elasticsearch
## Contributing
Within the NASA Planetary Data System, we value the health of our community as much as the code. Towards that end, we ask that you read and practice what's described in these documents:
- Our [contributor's guide](https://github.com/NASA-PDS/.github/blob/main/CONTRIBUTING.md) delineates the kinds of contributions we accept.
- Our [code of conduct](https://github.com/NASA-PDS/.github/blob/main/CODE_OF_CONDUCT.md) outlines the standards of behavior we practice and expect by everyone who participates with our software.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[APLv2](https://www.apache.org/licenses/LICENSE-2.0)