Skip to main content

SIP Generator

Project description

Software for the Planetary Data System (PDS) to generate Archive Information Package (AIP) and Submission Information Package (SIP) products, based upon Open Archival Information System (OAIS) standards.

Features

  • Provides an exectuble Python script pds-deep-archive. Run pds-deep-archive --help for more details.

  • Provides an exectuble Python script aipgen. Run aipgen --help for more details.

  • Provides an exectuble Python script sipgen. Run sipgen --help for more details.

Installation

First, this requires Python 3.6, 3.7, or 3.8. Are you still using Python 2? It reached end-of-life on January 1st, 2020.

Make a virtualenv and run pip install pds-deep-archive into it. Or use a buildout or, if you absolutely must, install it into your system python you monster. This software depends on the lxml library which your Python installer should take care of, but your system will require libxml2 2.9.2 or later as well as libxsl2 1.1.28 or later.

  1. Download the tar.gz distribution

  2. Create a virtualenv and activate:

    bash> mkdir -p $HOME/.virtualenvs
    bash> virtualenv $HOME/.virtualenvs/pds-deep-archive
    bash> $HOME/.virtualenvs/pds-deep-archive/bin/activate
  3. Use the downloaded tar.gz from step 1 and pip to install pds-deep-archive and all of its dependencies:

    (pds-deep-archive) bash> pip install pds.deeparchive-0.0.0.tar.gz
  4. You should now be able to run the deep archive utilities:

    (pds-deep-archive) bash> pds-deep-archive --help
    (pds-deep-archive) bash> aipgen --help
    (pds-deep-archive) bash> sipgen --help

Build

To build the software for distribution:

  1. Boostrap the buildout (if needed):

    bash> python3 bootstrap.py
    bash> bin/buildout
  2. Create an install package:

    bash> buildout setup . sdist
  3. A tar.gz should now be available in the dist/ directory for distribution.

Documentation

Installation and Usage information can be found in the documentation online at https://nasa-pds-incubator.github.io/pds-deep-archive/ or the latest version is maintained under the docs directory.

Translations

This product has not been translated into any other languages than US English.

Contribute

Support

If you are having issues, please let us know. 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.

Changelog

0.0.0 (unreleased)

  • Initial unreleased release [kelly].

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pds.deeparchive-0.1.0.tar.gz (2.4 MB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page