SATPLAN - A Toolbox for Satellite Task Planning Benchmarking

SATPLAN

SATPLAN is a package for training, benchmarking, and reference implementations for satellite task planning.

Installation

To install the SATPLAN toolbox, you can use pip. The package is available on PyPI, so you can install it directly from there.

pip install satplan

You can then import the library in your Python code:

import satplan

Development

This section provides instructions for setting up the development environment and running tests.

To start, we STRONGLY recommend using uv to manage your Python environment. This will ensure that you have the correct dependencies and versions installed.

Setting Up the Development Environment

1. Clone the repository:

   git clone git@github.com:duncaneddy/satplan.git
   cd satplan
   

2. Sync package dependencies:

   uv sync --dev
   

   This will create a .venv directory in the project root with all the necessary dependencies installed.

3. Install pre-commit hooks:

   uv run pre-commit install
   

   This will ensure that the linter (ruff), formatter (ruff), and type checker (mypy) is happy with your code every time you commit.

Running Tests

Assuming you've set up your environment using uv, you can run the tests using the following command:

pytest

or

uv run pytest

To generate local coverage reports, you can use:

uv run coverage run -m pytest
uv run coverage report # Generate CLI report
uv run coverage html   # Generate HTML report

Generating Documentation

To generate the documentation, you can use the following command:

uv run mkdocs serve

This will build the documentation and start a local server. You can then view the documentation in your web browser.