Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nasa-pds/deep-archive
PDS Open Archival Information System (OAIS) utilities, including Submission Information Package (SIP) and Archive Information Package (AIP) generators
https://github.com/nasa-pds/deep-archive
nasa nasa-pds nssdca oais pds pds4
Last synced: about 1 month ago
JSON representation
PDS Open Archival Information System (OAIS) utilities, including Submission Information Package (SIP) and Archive Information Package (AIP) generators
- Host: GitHub
- URL: https://github.com/nasa-pds/deep-archive
- Owner: NASA-PDS
- License: other
- Created: 2020-01-24T21:27:51.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T22:41:52.000Z (2 months ago)
- Last Synced: 2024-10-18T20:40:44.704Z (2 months ago)
- Topics: nasa, nasa-pds, nssdca, oais, pds, pds4
- Language: HTML
- Homepage: https://nasa-pds.github.io/deep-archive/
- Size: 27 MB
- Stars: 7
- Watchers: 11
- Forks: 4
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# 🪐 PDS Deep Archive Utilities
[](https://doi.org/10.5281/zenodo.5750540) [](https://github.com/NASA-PDS/deep-archive/actions?query=workflow%3A%22%F0%9F%A4%AA+Unstable+integration+%26+delivery%22) [](https://github.com/NASA-PDS/deep-archive/actions?query=workflow%3A%22%F0%9F%98%8C+Stable+integration+%26+delivery%2)
Software for the [Planetary Data System](https://pds.nasa.gov/) to generate Archive Information Package (AIP) and Submission Information Package (SIP) products, based upon [Open Archival Information System](https://www2.archivists.org/groups/standards-committee/open-archival-information-system-oais) standards.
## ✨ Features
Installing this package will give you two different executable Python programs:
- `pds-deep-archive` for making Deep Archives of local, on-disk PDS products.
- `pds-deep-registry-archive` for making Deep Archives of proucts in a PDS Registry server.
## ⎆ Installation
See the online documentation for [Installation](https://nasa-pds.github.io/deep-archive/installation/) instructions.
You should then be able to run the deep archive utilities:
(pds-deep-archive) bash> pds-deep-archive --help
(pds-deep-archive) bash> pds-deep-registry-archive --help
👉 _Note:_ The above commands demonstrate typical usage with a command-line prompt, such as that provided by the popular `bash` shell; your own prompt may appear differently and may vary depending on operating system, shell choice, and so forth.
## 👷♂️ Build
See the [Development Guide](https://nasa-pds.github.io/deep-archive/development/index.html) for more information.
## 📄 Documentation
Installation and Usage information can be found in the documentation online at https://nasa-pds.github.io/deep-archive/ or the latest version is maintained under the `docs` directory.
### 🐈 Build Sphinx Docs
To build the Sphinx HTML documentation:
```console
$ python3.9 -m venv venv
$ venv/bin/python setup.py develop
$ venv/bin/python setup.py build_sphinx
running build_sphinx
…
The HTML pages are in build/sphinx/html.
```
## 🥖 Translations
This product has not been translated into any other languages than US English.
## 👏 Contribute
All users and developers of the NASA-PDS software are expected to abide by our [Code of Conduct](https://github.com/NASA-PDS/.github/blob/main/CODE_OF_CONDUCT.md). Please read this to ensure you understand the expectations of our community. For information on how to contribute to NASA-PDS codebases please take a look at our [Contributing guidelines](https://github.com/NASA-PDS/.github/blob/main/CONTRIBUTING.md).
- Issue Tracker: https://github.com/NASA-PDS/deep-archive/issues
- Source Code: https://github.com/NASA-PDS/deep-archive
- Wiki: https://github.com/NASA-PDS/deep-archive/wiki
### 💽 Getting Test Data
If you need to mirror a part of a website to add to the test data, try this handy invocation of `wget`:
```console
$ wget \
--quiet \
--execute robots=off \
--cut-dirs=2 \
--reject='index.html*' \
--no-host-directories \
--mirror \
--no-parent \
--relative \
--timestamping \
--no-check-certificate \
--recursive \
"https://whatever/some/path"
```
Note ⑴: Although the author typically reaches for `curl`, it lacks a direct mirroring option—hence `wget` here.
Note ⑵: This is mostly a "note-to-self" for the author of this subsection 😉.
## 💁♀️ Support
If you are having issues file a bug report in Github: https://github.com/NASA-PDS/deep-archive/issues
Or you can reach us at https://pds.nasa.gov/?feedback=true
## 💳 License
The project is licensed under the Apache License, version 2. See the `LICENSE.txt` file for details.