space-packet-parser 5.1.0rc1__tar.gz → 6.0.0.dev1__tar.gz

{space_packet_parser-5.1.0rc1 → space_packet_parser-6.0.0.dev1}/CITATION.cff

@@ -1,7 +1,7 @@
 cff-version: 1.2.0
 title: 'space_packet_parser'
 type: software
-version: '5.1.0rc1'
+version: '6.0.0dev1'
 description: A CCSDS telemetry packet decoding library based on the XTCE packet format description standard.
 license: BSD-3-Clause
 abstract: The Space Packet Parser Python library is a generalized, configurable packet decoding library for CCSDS telemetry
@@ -29,5 +29,8 @@ maintainers:
 - email: gavin.medley@lasp.colorado.edu
   name: Gavin Medley
   orcid: "0000-0002-3520-9715"
-repository-code: "https://github.com/medley56/space_packet_parser"
+- email: greg.lucas@lasp.colorado.edu
+  name: Greg Lucas
+  orcid: "0000-0003-1331-1863"
+repository-code: "https://github.com/lasp/space_packet_parser"
 url: "https://space-packet-parser.readthedocs.io"

space_packet_parser-6.0.0.dev1/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.3
+Name: space_packet_parser
+Version: 6.0.0.dev1
+Summary: A CCSDS telemetry packet decoding library based on the XTCE packet format description standard.
+License: BSD-3-Clause
+Keywords: ccsds,xtce,space data systems,space packet protocol,packet parsing,lasp,university of colorado,data processing,data extraction,data manipulation,data transformation,data encoding,data decoding,packet inspection,binary data,python
+Author: Gavin Medley
+Author-email: gavin.medley@lasp.colorado.edu
+Maintainer: Gavin Medley
+Maintainer-email: gavin.medley@lasp.colorado.edu
+Requires-Python: >=3.9
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: BSD License
+Provides-Extra: docs
+Provides-Extra: examples
+Provides-Extra: test
+Provides-Extra: xarray
+Requires-Dist: click (>=8.0)
+Requires-Dist: lxml (>=4.8.0)
+Requires-Dist: matplotlib (>=3.4) ; extra == "examples"
+Requires-Dist: myst-parser ; extra == "docs"
+Requires-Dist: numpy (>=2.0.0) ; extra == "xarray"
+Requires-Dist: numpy ; extra == "test"
+Requires-Dist: pre-commit ; extra == "test"
+Requires-Dist: pytest ; extra == "test"
+Requires-Dist: pytest-benchmark ; extra == "test"
+Requires-Dist: pytest-cov ; extra == "test"
+Requires-Dist: pytest-randomly ; extra == "test"
+Requires-Dist: pyyaml ; extra == "docs"
+Requires-Dist: pyyaml ; extra == "test"
+Requires-Dist: rich (>=13.0)
+Requires-Dist: ruff ; extra == "test"
+Requires-Dist: sphinx ; extra == "docs"
+Requires-Dist: sphinx-autoapi ; extra == "docs"
+Requires-Dist: sphinx-rtd-theme ; extra == "docs"
+Requires-Dist: tomli ; extra == "test"
+Requires-Dist: xarray (>2024.0.0) ; extra == "xarray"
+Requires-Dist: xarray ; extra == "test"
+Project-URL: Documentation, https://space-packet-parser.readthedocs.io
+Project-URL: Homepage, https://github.com/lasp/space_packet_parser
+Project-URL: Repository, https://github.com/lasp/space_packet_parser
+Description-Content-Type: text/markdown
+
+# Space Packet Parser
+
+[![Conda](https://img.shields.io/conda/vn/lasp/space_packet_parser?color=42B029&logo=anaconda&logoColor=white)](https://anaconda.org/lasp/space_packet_parser)
+[![PyPI](https://img.shields.io/pypi/v/space_packet_parser?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/space-packet-parser/)
+[![DOI](https://zenodo.org/badge/612253190.svg)](https://doi.org/10.5281/zenodo.7735001)
+
+[![Test Status](https://github.com/lasp/space_packet_parser/actions/workflows/tests.yml/badge.svg)](https://github.com/lasp/space_packet_parser/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/gh/lasp/space_packet_parser/graph/badge.svg?token=VUFIN94O05)](https://codecov.io/gh/lasp/space_packet_parser)
+
+**Documentation:** [https://space-packet-parser.readthedocs.io/en/latest/](https://space-packet-parser.readthedocs.io/en/latest/)
+
+| **Stable ReadTheDocs Build** | [![Stable Docs](https://readthedocs.org/projects/space-packet-parser/badge/?version=stable)](https://app.readthedocs.org/projects/space-packet-parser/builds/?version__slug=stable)   |
+|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Latest ReadTheDocs Build** | [!["Latest Docs"](https://readthedocs.org/projects/space-packet-parser/badge/?version=latest)](https://app.readthedocs.org/projects/space-packet-parser/builds/?version__slug=latest) |
+
+
+Space Packet Parser is a package for decoding CCSDS telemetry packets according to an XTCE packet structure definition.
+It is based on the UML model of the XTCE spec and aims to support all but the most esoteric elements of the
+XTCE telemetry packet specification.
+
+Resources:
+- [XTCE (Green Book - Informational Report)](https://public.ccsds.org/Pubs/660x2g2.pdf)
+- [XTCE Element Description (Green Book - Informational Report)](https://public.ccsds.org/Pubs/660x1g2.pdf)
+- [XTCE (Blue Book - Recommended Standard)](https://public.ccsds.org/Pubs/660x0b2.pdf)
+
+## Installation
+From PyPI
+```bash
+pip install space_packet_parser
+```
+
+From Anaconda (distributed on the `lasp` channel):
+```bash
+conda install -c lasp space_packet_parser
+```
+
+## Proud Member of the Python in Heliophysics Community (PyHC)
+
+[<img src="https://heliopython.org/img/PyHC%20header%20logo%20500x500.png" alt="PyHC" height="70"/>](https://heliopython.org)
+
+## Missions using Space Packet Parser
+
+[<img src="https://imap.princeton.edu/sites/g/files/toruqf7171/files/imap-mark-hor-multicolor-dark.png" alt="IMAP" height="70"/>](https://imap.princeton.edu/)
+[<img src="https://clarreo-pathfinder.larc.nasa.gov/wp-content/uploads/sites/133/2019/08/clarreo_pathfinder_mission_patch_design_v4_decal_1_24_17.png" alt="CLARREO" height="140"/>](https://clarreo-pathfinder.larc.nasa.gov/)
+[<img src="https://lasp.colorado.edu/libera/files/2021/02/Libera-Logo-HiRes.png" alt="Libera" height="70"/>](https://lasp.colorado.edu/libera/)
+[<img src="https://lasp.colorado.edu/ctim/files/2023/01/CTIM_LOGO_350x100_centered_transparent.png" alt="CTIM-FD" height="70"/>](https://lasp.colorado.edu/ctim/)
+[<img src="https://mms.gsfc.nasa.gov/images/promotional_materials/mms_decal_rgb_4in_trabk_72dpi.png" alt="MMS-FEEPS" height="140"/>](https://lasp.colorado.edu/mms/sdc/public/)
+

space_packet_parser-6.0.0.dev1/README.md

@@ -0,0 +1,47 @@
+# Space Packet Parser
+
+[![Conda](https://img.shields.io/conda/vn/lasp/space_packet_parser?color=42B029&logo=anaconda&logoColor=white)](https://anaconda.org/lasp/space_packet_parser)
+[![PyPI](https://img.shields.io/pypi/v/space_packet_parser?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/space-packet-parser/)
+[![DOI](https://zenodo.org/badge/612253190.svg)](https://doi.org/10.5281/zenodo.7735001)
+
+[![Test Status](https://github.com/lasp/space_packet_parser/actions/workflows/tests.yml/badge.svg)](https://github.com/lasp/space_packet_parser/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/gh/lasp/space_packet_parser/graph/badge.svg?token=VUFIN94O05)](https://codecov.io/gh/lasp/space_packet_parser)
+
+**Documentation:** [https://space-packet-parser.readthedocs.io/en/latest/](https://space-packet-parser.readthedocs.io/en/latest/)
+
+| **Stable ReadTheDocs Build** | [![Stable Docs](https://readthedocs.org/projects/space-packet-parser/badge/?version=stable)](https://app.readthedocs.org/projects/space-packet-parser/builds/?version__slug=stable)   |
+|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Latest ReadTheDocs Build** | [!["Latest Docs"](https://readthedocs.org/projects/space-packet-parser/badge/?version=latest)](https://app.readthedocs.org/projects/space-packet-parser/builds/?version__slug=latest) |
+
+
+Space Packet Parser is a package for decoding CCSDS telemetry packets according to an XTCE packet structure definition.
+It is based on the UML model of the XTCE spec and aims to support all but the most esoteric elements of the
+XTCE telemetry packet specification.
+
+Resources:
+- [XTCE (Green Book - Informational Report)](https://public.ccsds.org/Pubs/660x2g2.pdf)
+- [XTCE Element Description (Green Book - Informational Report)](https://public.ccsds.org/Pubs/660x1g2.pdf)
+- [XTCE (Blue Book - Recommended Standard)](https://public.ccsds.org/Pubs/660x0b2.pdf)
+
+## Installation
+From PyPI
+```bash
+pip install space_packet_parser
+```
+
+From Anaconda (distributed on the `lasp` channel):
+```bash
+conda install -c lasp space_packet_parser
+```
+
+## Proud Member of the Python in Heliophysics Community (PyHC)
+
+[<img src="https://heliopython.org/img/PyHC%20header%20logo%20500x500.png" alt="PyHC" height="70"/>](https://heliopython.org)
+
+## Missions using Space Packet Parser
+
+[<img src="https://imap.princeton.edu/sites/g/files/toruqf7171/files/imap-mark-hor-multicolor-dark.png" alt="IMAP" height="70"/>](https://imap.princeton.edu/)
+[<img src="https://clarreo-pathfinder.larc.nasa.gov/wp-content/uploads/sites/133/2019/08/clarreo_pathfinder_mission_patch_design_v4_decal_1_24_17.png" alt="CLARREO" height="140"/>](https://clarreo-pathfinder.larc.nasa.gov/)
+[<img src="https://lasp.colorado.edu/libera/files/2021/02/Libera-Logo-HiRes.png" alt="Libera" height="70"/>](https://lasp.colorado.edu/libera/)
+[<img src="https://lasp.colorado.edu/ctim/files/2023/01/CTIM_LOGO_350x100_centered_transparent.png" alt="CTIM-FD" height="70"/>](https://lasp.colorado.edu/ctim/)
+[<img src="https://mms.gsfc.nasa.gov/images/promotional_materials/mms_decal_rgb_4in_trabk_72dpi.png" alt="MMS-FEEPS" height="140"/>](https://lasp.colorado.edu/mms/sdc/public/)

space_packet_parser-6.0.0.dev1/pyproject.toml

@@ -0,0 +1,153 @@
+[project]
+name = "space_packet_parser"
+version = "6.0.0dev1"
+description = "A CCSDS telemetry packet decoding library based on the XTCE packet format description standard."
+license = { text = "BSD-3-Clause" }
+readme = "README.md"
+requires-python = ">=3.9"
+authors = [
+    { name = "Gavin Medley", email = "gavin.medley@lasp.colorado.edu" },
+    { name = "Greg Lucas", email = "greg.lucas@lasp.colorado.edu" },
+    { name = "Michael Chambliss", email = "michael.chambliss@lasp.colorado.edu" }
+]
+maintainers = [
+    { name = "Gavin Medley", email = "gavin.medley@lasp.colorado.edu" },
+    { name = "Greg Lucas", email = "greg.lucas@lasp.colorado.edu" }
+]
+keywords = [
+    "ccsds",
+    "xtce",
+    "space data systems",
+    "space packet protocol",
+    "packet parsing",
+    "lasp",
+    "university of colorado",
+    "data processing",
+    "data extraction",
+    "data manipulation",
+    "data transformation",
+    "data encoding",
+    "data decoding",
+    "packet inspection",
+    "binary data",
+    "python"
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "License :: OSI Approved :: BSD License"
+]
+# These are the dependencies used for metadata when building the project
+dependencies = [
+    "lxml>=4.8.0",
+    "click>=8.0",
+    "rich>=13.0"
+]
+
+[project.urls]
+repository = "https://github.com/lasp/space_packet_parser"
+homepage = "https://github.com/lasp/space_packet_parser"
+documentation = "https://space-packet-parser.readthedocs.io"
+
+[project.scripts]
+spp = "space_packet_parser.cli:spp"
+
+# These are the project extras used for metadata when building the project
+[project.optional-dependencies]
+xarray = [
+    "xarray>2024.0.0",
+    "numpy>=2.0.0"
+]
+examples = [
+    "matplotlib>=3.4"
+]
+test = [
+    "pre-commit",
+    "pytest",
+    "pytest-benchmark",
+    "pytest-randomly",
+    "pytest-cov",
+    "pyyaml",  # needed by check_metadata.py
+    "ruff",
+    "tomli",  # for support of python<3.11 toml parsing in check_metadata.py
+    "xarray",  # for testing extra
+    "numpy"  # for testing extra
+]
+docs = [
+    "pyyaml",
+    "sphinx",
+    "myst-parser",
+    "sphinx-autoapi",
+    "sphinx-rtd-theme"
+]
+
+[tool.poetry]
+packages = [
+    { include = "space_packet_parser" }
+]
+include = [
+    "LICENSE.txt",
+    "CITATION.cff"
+]
+
+[tool.poetry.group.xarray.dependencies]
+xarray = ">2024.0.0"
+numpy = ">=2.0.0"
+
+[tool.poetry.group.examples.dependencies]
+matplotlib = ">=3.4"
+
+[tool.poetry.group.test.dependencies]
+pre-commit = "*"
+pytest = "*"
+pytest-benchmark = "*"
+pytest-randomly = "*"
+pytest-cov = "*"
+pyyaml = "*"
+ruff = "*"
+tomli = "*"
+
+[tool.poetry.group.docs.dependencies]
+pyyaml = "*"
+sphinx = "*"
+myst-parser = "*"
+sphinx-autoapi = "*"
+sphinx-rtd-theme = "*"
+
+[build-system]
+requires = ["poetry-core>=2.0.1"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "error",
+    "ignore:You are encoding a BooleanParameterType:UserWarning"
+]
+
+# Note: Ruff uses the "nearest" configuration file at runtime so configurations may be overridden
+# e.g. see ruff.toml in the tests directory
+[tool.ruff]
+line-length = 120
+extend-include = [
+    "space_packet_parser/**/*.py",
+    "examples/**/*.py",
+    "tests/**/*.py"
+]
+extend-exclude = []
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort import sorting
+    "S",  # flake8-bandit security
+    "PT",  # flake8-pytest-style
+    "UP"  # pyupgrade syntax upgrader
+]
+per-file-ignores = { "tests/*" = ["S"] }

space_packet_parser-6.0.0.dev1/space_packet_parser/__init__.py

@@ -0,0 +1,20 @@
+"""Space Packet Parser"""
+from pathlib import Path
+from typing import Union
+
+from space_packet_parser.xtce.definitions import XtcePacketDefinition
+
+
+def load_xml(filename: Union[str, Path]) -> XtcePacketDefinition:
+    """Create an XtcePacketDefinition object from an XTCE XML file
+
+    Parameters
+    ----------
+    filename : Union[str, Path]
+        XTCE XML file
+
+    Returns
+    -------
+    : definitions.XtcePacketDefinition
+    """
+    return XtcePacketDefinition.from_xtce(filename)

{space_packet_parser-5.1.0rc1 → space_packet_parser-6.0.0.dev1}/space_packet_parser/cli.py

@@ -10,21 +10,20 @@ Use
     spp --help
     spp --describe <packet_file>
 """
-# Standard
 import logging
 from pathlib import Path
 from typing import Optional
-# Installed
+
 import click
+from rich import pretty
 from rich.console import Console
-from rich.table import Table
 from rich.logging import RichHandler
 from rich.panel import Panel
+from rich.table import Table
 from rich.tree import Tree
-from rich import pretty
-# Local
+
 from space_packet_parser.packets import ccsds_generator
-from space_packet_parser.definitions import XtcePacketDefinition, DEFAULT_ROOT_CONTAINER
+from space_packet_parser.xtce.definitions import DEFAULT_ROOT_CONTAINER, XtcePacketDefinition
 
 # Initialize a console instance for rich output
 console = Console()
@@ -75,18 +74,17 @@ def describe_xtce(
         root_container: str
 ) -> None:
     """Describe the contents and structure of an XTCE packet definition file."""
-    # pylint: disable=protected-access
     logging.debug(f"Describing XTCE file: {file_path}")
-    definition = XtcePacketDefinition(file_path, root_container_name=root_container)
+    definition = XtcePacketDefinition.from_xtce(file_path, root_container_name=root_container)
     tree = Tree(definition.root_container_name)
 
     # Recursively add nodes based on the inheritors of each container
     def add_nodes(tree_node, parent_key):
-        children = definition._sequence_container_cache[parent_key].inheritors
+        children = definition.containers[parent_key].inheritors
         for child_key in children:
             # Create a new child node (name + comparisons used to distinguish between containers)
             child_node = tree_node.add(
-                f"{child_key} {definition._sequence_container_cache[child_key].restriction_criteria}")
+                f"{child_key} {definition.containers[child_key].restriction_criteria}")
             # Recursively add any children of this child
             add_nodes(child_node, child_key)
 
@@ -94,16 +92,16 @@ def describe_xtce(
 
     console.print(Panel(tree, title="XTCE Container Layout", border_style="cyan", expand=False))
     if sequence_containers:
-        console.print(Panel(pretty.Pretty(definition._sequence_container_cache),
-                            title=f"Sequence Containers ({len(definition._sequence_container_cache)})",
+        console.print(Panel(pretty.Pretty(definition.containers),
+                            title=f"Sequence Containers ({len(definition.containers)})",
                             border_style="blue", expand=False))
     if parameters:
-        console.print(Panel(pretty.Pretty(definition._parameter_cache),
-                            title=f"Parameters ({len(definition._parameter_cache)})",
+        console.print(Panel(pretty.Pretty(definition.parameters),
+                            title=f"Parameters ({len(definition.parameters)})",
                             border_style="green", expand=False))
     if parameter_types:
-        console.print(Panel(pretty.Pretty(definition._parameter_type_cache),
-                            title=f"Parameter Types ({len(definition._parameter_type_cache)})",
+        console.print(Panel(pretty.Pretty(definition.parameter_types),
+                            title=f"Parameter Types ({len(definition.parameter_types)})",
                             border_style="magenta", expand=False))
 
 
@@ -159,7 +157,7 @@ def describe_packets(file_path: Path) -> None:
 @click.option("--max-items", type=int, default=20, help="Maximum number of items to display")
 @click.option("--max-string", type=int, default=40, help="Maximum length of string data")
 @click.option("--skip-header-bytes", type=int, default=0, help="Number of bytes to skip before each packet")
-def parse(  # pylint: disable=too-many-positional-arguments
+def parse(
         packet_file: Path,
         definition_file: Path,
         packet: Optional[int],
@@ -172,7 +170,14 @@ def parse(  # pylint: disable=too-many-positional-arguments
     logging.debug(f"Using packet definition file: {definition_file}")
 
     with open(packet_file, "rb") as f:
-        packets = list(XtcePacketDefinition(definition_file).packet_generator(f, skip_header_bytes=skip_header_bytes))
+        packets = list(
+            XtcePacketDefinition.from_xtce(
+                definition_file
+            ).packet_generator(
+                f,
+                skip_header_bytes=skip_header_bytes
+            )
+        )
 
     if packet is not None:
         if packet > len(packets):