pysits

Python wrapper for the sits R package.

📦 Installation

To install pysits with pip:

pip install pysits

or the development version:

pip install git+https://github.com/e-sensing/pysits.git

To use pysits, you must have sits installed. For more information, refer to the official sits documentation.

🛠 Development setup (for contributors)

To set up a local development environment:

1. Clone the repo and access it:

git clone https://github.com/e-sensing/pysits.git
cd pysits

2. Create a virtual environment using uv

uv venv
source .venv/bin/activate  # or .venv\Scripts\activate on Windows

3. Install the project in editable mode with development tools:

uv pip install -e ".[dev]"

🔍 Run tests

We use pytest for testing:

pytest

🧹 Code formatting

To keep the codebase clean and consistent we use ruff:

ruff format .

🧪 Linting

We use ruff for static analysis:

ruff check .

The examples/ directory is excluded from linting.

📚 Learn more

To learn all about sits, including its concepts, API, and real-world examples, we recommend accessing the official sits book. The book provides examples in both R and Python.

🤝 Contributing

We welcome contributions! Please:

• Fork the repository
• Create a feature branch
• Submit a pull request with a clear description

📄 License

pysits is distributed under the GPL-2.0 license. See LICENSE for more details.