https://github.com/e-sensing/pysits
Python wrapper for the sits R package
https://github.com/e-sensing/pysits
cbers earth-observation eo-datacubes geospatial image-time-series landsat python r remote-sensing satellite-image-time-series sentinel-2 sits stac-api stac-catalog timeseries
Last synced: 6 months ago
JSON representation
Python wrapper for the sits R package
- Host: GitHub
- URL: https://github.com/e-sensing/pysits
- Owner: e-sensing
- License: gpl-2.0
- Created: 2025-03-14T22:00:47.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-11-18T17:32:32.000Z (7 months ago)
- Last Synced: 2025-11-18T19:18:56.571Z (7 months ago)
- Topics: cbers, earth-observation, eo-datacubes, geospatial, image-time-series, landsat, python, r, remote-sensing, satellite-image-time-series, sentinel-2, sits, stac-api, stac-catalog, timeseries
- Language: Python
- Homepage: https://e-sensing.github.io/sitsbook/
- Size: 4.85 MB
- Stars: 16
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pysits
Python wrapper for the [sits](https://github.com/e-sensing/sits) R package.
## 📦 Installation
To install `pysits` with pip:
```bash
pip install pysits
```
or the development version:
```bash
pip install git+https://github.com/e-sensing/pysits.git
```
> To use `pysits`, you must have [sits](https://github.com/e-sensing/sits) installed. For more information, refer to the [official sits documentation](https://e-sensing.github.io/sitsbook/setup.html).
## 🛠 Development setup (for contributors)
To set up a local development environment:
**1.** Clone the repo and access it:
```bash
git clone https://github.com/e-sensing/pysits.git
cd pysits
```
**2.** Create a virtual environment using [uv](https://github.com/astral-sh/uv)
```bash
uv venv
source .venv/bin/activate # or .venv\Scripts\activate on Windows
```
**3.** Install the project in editable mode with development tools:
```bash
uv pip install -e ".[dev]"
```
### 🔍 Run tests
We use `pytest` for testing:
```bash
pytest
```
### 🧹 Code formatting
To keep the codebase clean and consistent we use [ruff](https://github.com/astral-sh/ruff):
```bash
ruff format .
```
### 🧪 Linting
We use [ruff](https://github.com/astral-sh/ruff) for static analysis:
```bash
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](https://e-sensing.github.io/sitsbook/). 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](./LICENSE) for more details.