{"id":19292193,"url":"https://github.com/nasa-pds/supplementer","last_synced_at":"2026-05-17T10:35:04.157Z","repository":{"id":41866502,"uuid":"379018669","full_name":"NASA-PDS/supplementer","owner":"NASA-PDS","description":"A tool to ingest supplemental metadata for PDS products.","archived":false,"fork":false,"pushed_at":"2022-11-21T17:12:59.000Z","size":99,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-01-05T20:26:51.059Z","etag":null,"topics":["pds"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NASA-PDS.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null}},"created_at":"2021-06-21T17:55:13.000Z","updated_at":"2022-01-11T00:08:42.000Z","dependencies_parsed_at":"2022-08-21T22:41:13.996Z","dependency_job_id":null,"html_url":"https://github.com/NASA-PDS/supplementer","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":"NASA-PDS/template-repo-java","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-PDS%2Fsupplementer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-PDS%2Fsupplementer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-PDS%2Fsupplementer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-PDS%2Fsupplementer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NASA-PDS","download_url":"https://codeload.github.com/NASA-PDS/supplementer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240395809,"owners_count":19794580,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pds"],"created_at":"2024-11-09T22:29:36.590Z","updated_at":"2026-05-17T10:35:04.104Z","avatar_url":"https://github.com/NASA-PDS.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Supplementer\n\nSupplementer is a tool to ingest supplemental metadata for Planetary Data System (PDS) products into a PDS Registry. \n\n\n## Documentation\n\nYou can find documentation for the latest release of the Supplementer tool, including installation and operation \nat https://nasa-pds.github.io/pds-registry-app/\n\n\n\n\n## Build\n\nYou need JDK 11 and Maven to build this project. To create distribution package, run\n```\nmvn package\n```\n\n### Dependencies on other PDS Projects\n\n- https://github.com/NASA-PDS/pds4-jparser - PDS label data table parser.\n- https://github.com/NASA-PDS/pds-registry-common - Elasticsearch client, date conversion.\n\n## Installation\n\n- Either download binary release (ZIP or TGZ archives) from https://github.com/NASA-PDS/supplementer/releases\nor, if you built the project yourself, get the ZIP or TGZ archive from \"target\" directory.\n- Extract the archive to any folder, such as /home/pds\n\n\n## Usage\n\nGo to \"bin\" folder in the installation directory and run `supplementer` without any parameters to see the help screen.\n\n\n### Example 1: \n\nLoad supplemental data from Product_Metadata_Supplemental label into local registry (Elasticsearch)\n```\nsupplementer load-labels /home/user1/data/prod_supplemental_1.xml\n```\n\n### Example 2: \n\nLoad supplemental data from a list of Product_Metadata_Supplemental labels generated by Harvest\n\nHarvest 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:\n```\n/home/user1/data/my_supplemental_label.xml\n/home/user1/data/another_supplemental_product.xml\n```\n\nTo load this list into local registry, run the following command:\n```\nsupplementer load-labels /tmp/harvest/out/supplemental.txt\n```\n\n### Add DOI Metadata from Database\n\nRun following command to import data from Sqlite DOI database into the Registry\n\n```\nsupplementer add-doi -file /tmp/my_doi.db\n```\n\nYou can also pass optional parameters to configure Registry URL and authentication.\n\n```\nUsage: supplementer add-doi \u003coptions\u003e\n\nAdd DOIs to already registered products.\n\nRequired parameters:\n  -file \u003cpath\u003e     Path to Sqlite database\n\nOptional parameters:\n  -auth \u003cfile\u003e     Registry authentication configuration file\n  -es \u003curl\u003e        Registry (OpenSearch) URL. Default is http://localhost:9200\n  -index \u003cname\u003e    Registry index name. Default is 'registry'\n```\n\nOnce executed, check ops:Identifiers/ops:doi field in OpenSearch / Elasticsearch\n\n## Contributing\n\nWithin 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:\n\n-   Our [contributor's guide](https://github.com/NASA-PDS/.github/blob/main/CONTRIBUTING.md) delineates the kinds of contributions we accept.\n-   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.\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n\nPlease make sure to update tests as appropriate.\n\n## License\n\n[APLv2](https://www.apache.org/licenses/LICENSE-2.0)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnasa-pds%2Fsupplementer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnasa-pds%2Fsupplementer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnasa-pds%2Fsupplementer/lists"}