Skip to main content

Toolkit to search, download and process Earth Observation data

Project description

satctl

Modular library and CLI utility to search, download and process satellite data from different sources, powered by satpy.

test passing coverage pypi version python versions

license documentation

Quickstart

satctl can be installed via pip, or uv, in different flavors.

# via pip
$ pip install satctl
# via uv
$ uv add satctl
# including CLI tools
$ uv add satctl[console]

Usage

satctl tries to be as modular as possible, giving the user the possibility to stop the process at any time in the pipeline, from searching to converting the raw data into a GeoTIFF.

Here's a simple example of usage.

from datetime import datetime
from pathlib import Path

from satctl.model import ConversionParams, SearchParams
from satctl.sources import create_source
from satctl.writers import create_writer

if __name__ == "__main__":
    # search available satellites and products
    names = list_sources(name="s2*")

    # or directly create any source
    source = create_source("slstr")

    # Define a research area, from file or as a simple Polygon
    area_file = Path("my_aoi.geojson")

    # filter by space, time or source options
    params = SearchParams.from_file(path=area_file, datetime(2025, 8, 15), end=datetime(2025, 8, 16))
    items = source.search(params)

    # download the tiles locally
    downloaded, fail = source.download(items, destination=Path("downloads/"), num_workers=4)

    # ... load an item as a satpy Scene ...
    sene = source.load_scene(items[0], datasets=["S3", "S2", "S1"])

    # ... or store them directly on file
    writer = create_writer("geotiff")
    source.save(
        downloaded,
        params=ConversionParams.from_file(
            path=area_file,
            target_crs="4326",
            datasets=["all_bands_h"],
            resolution=500,
        ),
        destination=Path("results/"),
        writer=writer,
        num_workers=4,
    )

For more examples and use cases, see the documentation.

Contributing

Contributing requires the following tools: uv for environment and project management, ruff for linting and formatting, pyright for standard type checking. Formatting, linting and type checking is enforced at pre-commit and CI level.

The easiest way to quickstart is the following:

# prepare the environment, requires uv
$ make install

More information about contributing will be added in the main documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

satctl-0.3.0.tar.gz (70.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

satctl-0.3.0-py3-none-any.whl (87.0 kB view details)

Uploaded Python 3

File details

Details for the file satctl-0.3.0.tar.gz.

File metadata

  • Download URL: satctl-0.3.0.tar.gz
  • Upload date:
  • Size: 70.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for satctl-0.3.0.tar.gz
Algorithm Hash digest
SHA256 39179aff97f4b6bdbcbb25a8cd27c994439183c68990dd65aa8e0b19c9c96d92
MD5 adf22a4f128cd0f63771766d504b7b9a
BLAKE2b-256 c14efa9cb6ed6bc692da7d6a53244c50a2c096f2698cad0a4f037b789e270921

See more details on using hashes here.

File details

Details for the file satctl-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: satctl-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 87.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for satctl-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d105df09bdfab8cf75e16ec16432a5813ba71e6a2aa492b1c80243da1a6632c3
MD5 3eaf0cbc8690625a0a9e22c91eab43da
BLAKE2b-256 5bde18f4627f9bd622785cdcf54c3f1b76aba3689903cc9e9e7c48e141b1dfe3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page