Skip to content

us-irs/spacepackets-py

Repository files navigation

ci Documentation Status codecov PyPI version

ECSS and CCSDS Spacepackets

This package contains generic implementations for various CCSDS (Consultative Committee for Space Data Systems) and ECSS (European Cooperation for Space Standardization) packet standards.

Currently, this includes the following components:

It also contains various helper modules which are commonly used when working with these standards:

  • PusVerificator module to track the verification of sent telecommands.
  • PTC and PFC definitions for ECSS packets.
  • Countdown utility class.
  • Sequence counter utility classes.

Install

You can install this package from PyPI

Linux:

python3 -m pip install spacepackets

Windows:

py -m pip install spacepackets

Examples

You can find all examples inside the documentation.

Tests

If you want to run the tests, it is recommended to install pytest and coverage (optional) first:

pip install coverage pytest

Running tests regularly:

pytest .

Running tests with coverage:

coverage run -m pytest

Documentation

The documentation is built with Sphinx and new documentation should be written using the NumPy format.

Install the required dependencies first:

pip install -r docs/requirements.txt

Then the documentation can be built with

cd docs
make html

You can run the doctests with

make doctest

Formatting and Linting

Linting:

ruff check .

Formatting:

ruff format .