https://github.com/nasa-pds/nucleus
Nucleus is a software platform used to create workflows for the Planetary Data (PDS).
https://github.com/nasa-pds/nucleus
data ingestion pds planetary workflow
Last synced: 5 months ago
JSON representation
Nucleus is a software platform used to create workflows for the Planetary Data (PDS).
- Host: GitHub
- URL: https://github.com/nasa-pds/nucleus
- Owner: NASA-PDS
- License: apache-2.0
- Created: 2021-10-20T14:35:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-07-10T18:25:41.000Z (12 months ago)
- Last Synced: 2025-07-11T00:54:51.802Z (12 months ago)
- Topics: data, ingestion, pds, planetary, workflow
- Language: HCL
- Homepage: https://nasa-pds.github.io/nucleus
- Size: 15.8 MB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Zenodo: .zenodo.json
Awesome Lists containing this project
README
# Nucleus
[](https://doi.org/10.5281/zenodo.7996080)
PDS **Nucleus** is a software platform used to create workflows for the Planetary Data System (PDS).
---
## User Documentation
Please visit the documentation at:
👉 https://nasa-pds.github.io/nucleus/
---
## Developers
https://github.com/NASA-PDS/nucleus/graphs/contributors
### Prerequisites
The prerequisites to deploy and use Nucleus are available at:
https://github.com/NASA-PDS/nucleus/tree/main/terraform#prerequisites-to-deploy-nucleus-baseline-system
---
## Test
The **Nucleus** workflows are tested using a basic **Registry Loader** workflow, which is deployed as part of the initial Nucleus deployment.
This workflow includes several PDS tools such as **Validate**, **Harvest**, and **Archive**.
To test Nucleus:
1. Log in to the Nucleus web interface (URL and user credentials can be obtained from the Planetary Data System team).
2. Execute the **basic registry loader** workflow.
3. Verify that each workflow task reaches a **successful** state.
A successful execution of all tasks in this workflow indicates that the Nucleus integration test has passed.
---
## Deploy
The Terraform-based Nucleus deployment guide is available at:
https://github.com/NASA-PDS/nucleus/tree/main/terraform
---
### Design
Requirements, trade studies, and design documents are available at:
https://github.com/NASA-PDS/nucleus/tree/main/docs
or in the `docs` directory within the source package.
---
### User Documentation and Documentation Management
User documentation is managed with **Sphinx**, which is also installed in your Python virtual environment when you run:
```bash
python3 -m venv venv
source venv/bin/activate
pip install 'sphinx~=8.2.3' 'sphinx_rtd_theme~=3.0.2' 'myst-parser~=4.0.1'
sphinx-build -b html docs/source docs/build/html