NAIF PDS4 Bundler Documentation

This documentation is a piece of the NAIF PDS4 Bundler package (NPB). NPB enables SPICE archive producers to understand, design, and generate Planetary Data System (PDS) SPICE archives from end to end using the applicable PDS4 standards.

NPB is hosted at the NASA PDS GitHub repository.

• Overview
  • Applicability
  • Motivation
  • How to Read This Document?
  • Reporting Bugs
  • Contact Information
  • References
    • Utility Programs
    • Tutorials
    • SPICE Kernel Archives
    • PDS Standards
    • PDS Validate Tool
  • A Very Brief Introduction to SPICE
    • SPICE Kernels Organization
• SPICE Kernel Archive Description
  • NAIF’s Approach to SPICE Kernel Archive Preparation
  • PDS4 SPICE Kernel Archive Description
    • Product Types
    • Directory Structure, File naming, Product Types, and LIDs/LIDVIDs
      • Directory Structure
      • SPICE Kernels Collection
      • Document Collection
      • Miscellaneous Collection
      • LIDs, VIDs, LIDVIDs, and File naming
    • LID/LIDVID Construction Rules
      • Path and full file name in LID
      • Path and file name without version in LID
      • Subdirectory name only in LID
      • No file name in LID
    • Bundle Products Construction Rules
    • Product Reference and Collection Inventory Construction Rules
    • Product Coverage Assignment Rules
    • Bundle Creation Date Time
    • Miscellaneous Collection Rules
    • Checksum files
    • Bundles with multiple observers and/or targets
    • PDS Information Model
    • Digital Objects Identifiers
    • Product set, label, LIDVID and inventory examples for MAVEN releases 1 and 2
  • PDS4 SPICE kernel archives examples
  • A note on SPICE Kernels dissemination
  • SPICE Kernel archive divergences rationale
• SPICE Kernel Archive Preparation Guide
  • Step 1: Preparing Data
    • Identifying Data
    • Collecting and Preparing Data
      • Merging Files
      • Sub-setting Files
      • Augmenting Files with Comments
      • Renaming Files
    • Validating Data
    • Binary Kernels Endianness
    • Preparing Meta-kernels
      • Generating MKs Manually
      • Generating MKs Automatically
      • Bundle coverage and MKs
      • Releases without MKs
    • A Word on Orbit Number Files
    • A Word on Other Files
    • Obtaining a DOI
    • Writing the Release Plan
      • Using no Release Plan
      • Meta-kernels in the release plan
  • Step 2: Preparing the NAIF PDS4 Bundler Setup
    • Workspace Setup
      • Working Directory
      • Kernels Directory
      • ORBNUM Directory
      • Staging Directory
      • Bundle Directory
    • Determination of the Archive Release Version
    • SPICE Kernel descriptions across the archive
    • SPICE Data Set Catalog File
    • Install and/or update the NAIF PDS4 Bundler
    • Write and/or update the NPB Configuration File
  • Step 3: Running NAIF PDS4 Bundler
    • Run NPB from the command line
    • Interactive step for Meta-kernels
    • Understanding NPB prompting and logging
    • What if something goes wrong?
    • Processing large binary kernels
    • Until you get it right
  • Step 4: Checking the Result and Finishing Up
    • Checking PDS artifacts
    • Verifying the Archive using the PDS Validate Tool
      • Running Validate manually
    • Deploying to the Final Archive Area
    • Cleaning up the Workspace
  • Step 5: Packaging and Delivering the Archive to the NAIF Node
  • Step-by-Step Summary
    • Steps for Creating a New Archive
    • Steps for Adding Data To an Existing Archive
• NAIF PDS4 Bundler User Guide
  • NPB Installation
    • Prerequisites
    • User Quickstart
    • Manual Installation
      • Known Installation Issues
  • Development and Contribution
    • Installation for developers
    • Packaging
    • Running Tests
    • Documentation
  • The Configuration File
    • Configuration File Format
    • PDS Parameters
      • The Information Model
      • Context Products
    • Bundle Parameters
      • SPICEDS
      • Readme File
      • Increment Start and Finish Times
      • Date Format
    • Mission Parameters
      • On Names and Acronyms
      • Kernels To Load
      • Kernel patterns
    • Directories
      • Templates Directory
    • Kernel List
      • Kernel Descriptions
        • Match by value
        • Match by pattern
        • Match from Comment
      • Mapping kernels
    • Meta-kernel
      • Automatic generation of Meta-kernels
        • Meta-kernel grammar
        • Kernel entries left padding
        • Meta-kernel metadata
      • Manual Input
      • Coverage determination
        • Final remarks
    • Orbit number file
      • ORBNUM Coverage determination
    • Summary
  • Using NPB
    • NPB Functional Scheme
    • Running NPB from the command line
    • Calling NPB from Python
    • Optional Arguments Description
      • -p PLAN, --plan PLAN
      • -f FAUCET, --faucet FAUCET
      • -l --log
      • -s, --silent
      • -v, --verbose
      • -d DIFF, --diff DIFF
      • -c CLEAR, --clear CLEAR
      • -k KERLIST, --kerlist KERLIST
      • -s, --checksum
    • Using NPB in label mode
    • Execution by-products
      • Release Plan
      • Kernel List
        • Kernel Lists in PDS3 data sets
      • Execution Log
      • Execution File List
      • Checksum Registry
      • Product Diff Files
      • PDS Validate Tool Configuration File
    • Checks performed by NPB
      • Kernel List Validation
      • Complete Kernel List Validation
      • Product in Kernel List Checks
      • SPICE Kernel Integrity Check
      • Meta-kernel Validation
      • SPICE Kernel Collection Validation
      • Inventory Product Validation
      • Checksum Validation
      • Product Comparison
        • Comparison output
  • Working Example
    • Setup the workspace
    • Prepare the Configuration File
    • Run NPB
    • Checking the Results
• API Reference
  • pds package
    • Subpackages
      • pds.naif_pds4_bundler package
        • Subpackages
          • pds.naif_pds4_bundler.classes package
            • Submodules
            • pds.naif_pds4_bundler.classes.bundle module
            • pds.naif_pds4_bundler.classes.collection module
            • pds.naif_pds4_bundler.classes.label module
            • pds.naif_pds4_bundler.classes.list module
            • pds.naif_pds4_bundler.classes.log module
            • pds.naif_pds4_bundler.classes.object module
            • pds.naif_pds4_bundler.classes.product module
            • pds.naif_pds4_bundler.classes.setup module
            • Module contents
          • pds.naif_pds4_bundler.utils package
            • Submodules
            • pds.naif_pds4_bundler.utils.decorators module
            • pds.naif_pds4_bundler.utils.files module
            • pds.naif_pds4_bundler.utils.time module
            • Module contents
        • Module contents
    • Module contents
  • tests package
    • Subpackages
      • tests.naif_pds4_bundler package
        • Subpackages
          • tests.naif_pds4_bundler.functional package
            • Submodules
            • tests.naif_pds4_bundler.functional.test_bc module
            • tests.naif_pds4_bundler.functional.test_dart module
            • tests.naif_pds4_bundler.functional.test_insight module
            • tests.naif_pds4_bundler.functional.test_ladee module
            • tests.naif_pds4_bundler.functional.test_m2020 module
            • tests.naif_pds4_bundler.functional.test_maven module
            • tests.naif_pds4_bundler.functional.test_mro module
            • Module contents
          • tests.naif_pds4_bundler.regression package
            • Submodules
            • tests.naif_pds4_bundler.regression.test_pds3 module
            • tests.naif_pds4_bundler.regression.test_pds4 module
            • Module contents
          • tests.naif_pds4_bundler.unittests package
            • Submodules
            • tests.naif_pds4_bundler.unittests.test_bundle_history module
            • tests.naif_pds4_bundler.unittests.test_checksums module
            • tests.naif_pds4_bundler.unittests.test_clear module
            • tests.naif_pds4_bundler.unittests.test_endianness module
            • tests.naif_pds4_bundler.unittests.test_extract_comment module
            • tests.naif_pds4_bundler.unittests.test_files module
            • tests.naif_pds4_bundler.unittests.test_im_format module
            • tests.naif_pds4_bundler.unittests.test_kernel_integrity module
            • tests.naif_pds4_bundler.unittests.test_kernel_list module
            • tests.naif_pds4_bundler.unittests.test_match_patterns module
            • tests.naif_pds4_bundler.unittests.test_mk_config module
            • tests.naif_pds4_bundler.unittests.test_orbnum module
            • tests.naif_pds4_bundler.unittests.test_permissions module
            • tests.naif_pds4_bundler.unittests.test_plan module
            • tests.naif_pds4_bundler.unittests.test_readme module
            • tests.naif_pds4_bundler.unittests.test_time module
            • tests.naif_pds4_bundler.unittests.zz_test_slicer module
            • Module contents
        • Submodules
        • tests.naif_pds4_bundler.test_functional module
        • tests.naif_pds4_bundler.test_regression module
        • tests.naif_pds4_bundler.test_unittests module
        • Module contents
    • Module contents
• Appendix: NPB for PDS3 Archives
  • Configuration File Particulars
  • Using NPB for PDS3 Archives
    • Binary kernels endianness in PDS3 archives
  • Known differences from archives generated with NAIF’s PDS3 archiving approach

Indices and tables

• Index

• Module Index

• Search Page