lib-ccsds Library

🔭 Overview

Implements CCSDS packet frames.

Directory:

• src/: Source Code and Unit Tests
• tests/: Integration Tests
• docs/: Module Documentation

Installation

Install Rust with Rustup.

# Adds custom pre-commit hooks to .git through cargo-husky dependency
# !! Required for developers !!
cargo test

Make

Build and test

To ensure consistent build and test outputs, Arrow provides a Docker image with all required software installed to build and test Rust projects. Using the Makefile, you can easily test and build your code.

# Run tests
make test

# Run build
make build

Formatting

The Arrow docker image has some formatting tools installed which can fix your code formatting for you. Using the Makefile, you can easily run the formatters on your code. Make sure to commit your code before running these commands, as they might not always result in a desired outcome.

# Format TOML files
make toml-tidy

# Format Rust files
make rust-tidy

# Format Python files
make python-tidy

# Format all at once
make tidy

Spell check

Before being able to commit, cspell will be used as a spelling checker for all files, making sure no unintended spelling errors are found. You can run cspell yourself by using the following make target:

make cspell-test

If all spelling errors are fixed, but cspell still finds words that are unknown, you can add these words to the local project words list by running the following command:

make cspell-add-words

Other make targets

There are additional make targets available. You can find all possible targets by running make without a target or use make help

📜 Documentation

The following documents are relevant to this library:

• Concept of Operations
• 🚧 Requirements & User Stories 🚧
• Software Design Document

👥 Arrow DAO

Learn more about us:

• Website
• Arrow Docs
• Discord