stactools-sentinel1


Namestactools-sentinel1 JSON
Version 0.8.0 PyPI version JSON
download
home_pagehttps://github.com/stactools-packages/sentinel1
Summarystactools subpackage for creating sentinel1 STACs
upload_time2024-02-16 19:25:54
maintainer
docs_urlNone
authorstac-utils
requires_python>=3.8
license
keywords stactools pystac catalog stac sentinel grd radar
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # stactools-sentinel1

[![CI](https://github.com/stactools-packages/sentinel1/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/stactools-packages/sentinel1/actions/workflows/continuous-integration.yml)
![PyPI](https://img.shields.io/pypi/v/stactools-sentinel1)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/stactools-packages/sentinel1/main?filepath=docs/installation_and_basic_usage.ipynb)

- Name: sentinel1
- Package: `stactools.sentinel1`
- PyPI: <https://pypi.org/project/stactools-sentinel1/>
- Owners: @scottyhq (RTC), @maximlamare (GRD)
- Dataset homepages:
  - [RTC](https://registry.opendata.aws/sentinel-1-rtc-indigo/)
  - [GRD](https://registry.opendata.aws/sentinel-1/)
- STAC extensions used:
  - [projection](https://github.com/stac-extensions/projection/)
  - [sar](https://github.com/stac-extensions/sar)
  - [sat](https://github.com/stac-extensions/sat)
  - [raster](https://github.com/stac-extensions/raster)
  - [mgrs](https://github.com/stac-extensions/mgrs)
  - [processing](https://github.com/stac-extensions/processing)

Sentinel-1 subpackage for [stactools](https://github.com/stac-utils/stactools)

This project contains multiple subpackages that work with different Sentinel 1
data products.

## RTC

The `stactools.sentinel1.rtc` subpackage and `stac sentinel1 rtc` commands deal
with the Sentinel 1 Radiometric Terrain Corrected (RTC) data hosted on AWS and
produced by Indigo Ag. This data was processed from original Ground Range
Detected (GRD) scenes into a Radiometrically Terrain Corrected, tiled product
suitable for analysis.

See <https://registry.opendata.aws/sentinel-1-rtc-indigo> for more information
about this dataset.

## GRD

The `stactools.sentinel1.grd` subpackage and `stac sentinel1 grd` commands deal
with [Sentinel 1 Ground Range Detected (GRD)
Level-1](https://sentinel.esa.int/web/sentinel/user-guides/sentinel-1-sar/resolutions/level-1-ground-range-detected)
product. It is used to create STAC Items from the SAFE manifest format of the
data hosted on Microsoft Azure.

## SLC

The `stactools.sentinel1.slc` subpackage and `stac sentinel1 slc` commands deal
with [Sentinel 1 Single Look Complex (SLC)
Level-1](https://sentinel.esa.int/web/sentinel/user-guides/sentinel-1-sar/resolutions/level-1-single-look-complex)
product.

## Example Outputs

### RTC

- [Collection](examples/rtc/sentinel1-rtc-aws/collection.json)
- [Item (S1B_20161121_12SYJ_ASC)](examples/rtc/sentinel1-rtc-aws/2016/S1B_20161121_12SYJ_ASC/S1B_20161121_12SYJ_ASC.json)
- [Item (S1A_20200103_17RMJ_ASC)](examples/rtc/sentinel1-rtc-aws/2020/S1A_20200103_17RMJ_ASC/S1A_20200103_17RMJ_ASC.json)

### GRD

- [Item (S1A_EW_GRDM_1SDH_20221130T014342_20221130T014446_046117_058549)](examples/grd/S1A_EW_GRDM_1SDH_20221130T014342_20221130T014446_046117_058549/S1A_EW_GRDM_1SDH_20221130T014342_20221130T014446_046117_058549.json)
- [Item (S1A_IW_GRDH_1SDV_20210809T173953_20210809T174018_039156_049F13)](examples/grd/S1A_IW_GRDH_1SDV_20210809T173953_20210809T174018_039156_049F13/S1A_IW_GRDH_1SDV_20210809T173953_20210809T174018_039156_049F13.json)

### SLC

- [Collection](examples/slc/collection.json)
- [Item (S1A_IW_SL1__1_SH_20141031T095929_20141031T100002_003072_003842)](examples/slc/S1A_IW_SL1__1_SH_20141031T095929_20141031T100002_003072_003842/S1A_IW_SL1__1_SH_20141031T095929_20141031T100002_003072_003842.json)

## How to use

### Install package

```shell
pip install stactools-sentinel1
```

### RTC usage

#### Create a STAC Item (RTC)

<!-- markdownlint-disable MD013 -->
```shell
stac sentinel1 rtc create-item \
  s3://sentinel-s1-rtc-indigo/tiles/RTC/1/IW/12/S/YJ/2016/S1B_20161121_12SYJ_ASC \
  S1B_20161121_12SYJ_ASC
```
<!-- markdownlint-restore -->

#### Create a STAC Static Catalog (RTC)

<https://github.com/scottyhq/sentinel1-rtc-stac>

### GRD usage

Description of the command line functions

```bash
stac sentinel1 grd create-item source destination
```

Use `stac sentinel1 grd --help` to see all subcommands and options.

### SLC usage

Description of the command line functions

```bash
stac sentinel1 slc create-item source destination
```

Use `stac sentinel1 slc --help` to see all subcommands and options.

## Development instructions

### Set up virtual environment

```shell
git clone https://github.com/YOUR_FORK/sentinel1
# Use a virtual environment
conda env create
conda activate stactools-sentinel1
# Development install of dependencies
pip install -e ./
pip install -r requirements-dev.txt
```

### Make changes on a new branch, test, open a pull request

```shell
git checkout -b newfeature
# make changes

# Run CI tests locally
./scripts/cibuild

# Or run individual scripts
./scripts/lint
./scripts/format
./scripts/test

# If you're changing the output STAC metadata, update the examples
./scripts/create_examples.py

# Once tests pass, commit changes and create a pull request
```

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/stactools-packages/sentinel1",
    "name": "stactools-sentinel1",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "stactools,pystac,catalog,STAC,sentinel,GRD,radar",
    "author": "stac-utils",
    "author_email": "stac@radiant.earth",
    "download_url": "https://files.pythonhosted.org/packages/97/76/35d81e20220f0f1719f6e053929cc67211a499fa7a7e9d320a7c5d650608/stactools-sentinel1-0.8.0.tar.gz",
    "platform": null,
    "description": "# stactools-sentinel1\n\n[![CI](https://github.com/stactools-packages/sentinel1/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/stactools-packages/sentinel1/actions/workflows/continuous-integration.yml)\n![PyPI](https://img.shields.io/pypi/v/stactools-sentinel1)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/stactools-packages/sentinel1/main?filepath=docs/installation_and_basic_usage.ipynb)\n\n- Name: sentinel1\n- Package: `stactools.sentinel1`\n- PyPI: <https://pypi.org/project/stactools-sentinel1/>\n- Owners: @scottyhq (RTC), @maximlamare (GRD)\n- Dataset homepages:\n  - [RTC](https://registry.opendata.aws/sentinel-1-rtc-indigo/)\n  - [GRD](https://registry.opendata.aws/sentinel-1/)\n- STAC extensions used:\n  - [projection](https://github.com/stac-extensions/projection/)\n  - [sar](https://github.com/stac-extensions/sar)\n  - [sat](https://github.com/stac-extensions/sat)\n  - [raster](https://github.com/stac-extensions/raster)\n  - [mgrs](https://github.com/stac-extensions/mgrs)\n  - [processing](https://github.com/stac-extensions/processing)\n\nSentinel-1 subpackage for [stactools](https://github.com/stac-utils/stactools)\n\nThis project contains multiple subpackages that work with different Sentinel 1\ndata products.\n\n## RTC\n\nThe `stactools.sentinel1.rtc` subpackage and `stac sentinel1 rtc` commands deal\nwith the Sentinel 1 Radiometric Terrain Corrected (RTC) data hosted on AWS and\nproduced by Indigo Ag. This data was processed from original Ground Range\nDetected (GRD) scenes into a Radiometrically Terrain Corrected, tiled product\nsuitable for analysis.\n\nSee <https://registry.opendata.aws/sentinel-1-rtc-indigo> for more information\nabout this dataset.\n\n## GRD\n\nThe `stactools.sentinel1.grd` subpackage and `stac sentinel1 grd` commands deal\nwith [Sentinel 1 Ground Range Detected (GRD)\nLevel-1](https://sentinel.esa.int/web/sentinel/user-guides/sentinel-1-sar/resolutions/level-1-ground-range-detected)\nproduct. It is used to create STAC Items from the SAFE manifest format of the\ndata hosted on Microsoft Azure.\n\n## SLC\n\nThe `stactools.sentinel1.slc` subpackage and `stac sentinel1 slc` commands deal\nwith [Sentinel 1 Single Look Complex (SLC)\nLevel-1](https://sentinel.esa.int/web/sentinel/user-guides/sentinel-1-sar/resolutions/level-1-single-look-complex)\nproduct.\n\n## Example Outputs\n\n### RTC\n\n- [Collection](examples/rtc/sentinel1-rtc-aws/collection.json)\n- [Item (S1B_20161121_12SYJ_ASC)](examples/rtc/sentinel1-rtc-aws/2016/S1B_20161121_12SYJ_ASC/S1B_20161121_12SYJ_ASC.json)\n- [Item (S1A_20200103_17RMJ_ASC)](examples/rtc/sentinel1-rtc-aws/2020/S1A_20200103_17RMJ_ASC/S1A_20200103_17RMJ_ASC.json)\n\n### GRD\n\n- [Item (S1A_EW_GRDM_1SDH_20221130T014342_20221130T014446_046117_058549)](examples/grd/S1A_EW_GRDM_1SDH_20221130T014342_20221130T014446_046117_058549/S1A_EW_GRDM_1SDH_20221130T014342_20221130T014446_046117_058549.json)\n- [Item (S1A_IW_GRDH_1SDV_20210809T173953_20210809T174018_039156_049F13)](examples/grd/S1A_IW_GRDH_1SDV_20210809T173953_20210809T174018_039156_049F13/S1A_IW_GRDH_1SDV_20210809T173953_20210809T174018_039156_049F13.json)\n\n### SLC\n\n- [Collection](examples/slc/collection.json)\n- [Item (S1A_IW_SL1__1_SH_20141031T095929_20141031T100002_003072_003842)](examples/slc/S1A_IW_SL1__1_SH_20141031T095929_20141031T100002_003072_003842/S1A_IW_SL1__1_SH_20141031T095929_20141031T100002_003072_003842.json)\n\n## How to use\n\n### Install package\n\n```shell\npip install stactools-sentinel1\n```\n\n### RTC usage\n\n#### Create a STAC Item (RTC)\n\n<!-- markdownlint-disable MD013 -->\n```shell\nstac sentinel1 rtc create-item \\\n  s3://sentinel-s1-rtc-indigo/tiles/RTC/1/IW/12/S/YJ/2016/S1B_20161121_12SYJ_ASC \\\n  S1B_20161121_12SYJ_ASC\n```\n<!-- markdownlint-restore -->\n\n#### Create a STAC Static Catalog (RTC)\n\n<https://github.com/scottyhq/sentinel1-rtc-stac>\n\n### GRD usage\n\nDescription of the command line functions\n\n```bash\nstac sentinel1 grd create-item source destination\n```\n\nUse `stac sentinel1 grd --help` to see all subcommands and options.\n\n### SLC usage\n\nDescription of the command line functions\n\n```bash\nstac sentinel1 slc create-item source destination\n```\n\nUse `stac sentinel1 slc --help` to see all subcommands and options.\n\n## Development instructions\n\n### Set up virtual environment\n\n```shell\ngit clone https://github.com/YOUR_FORK/sentinel1\n# Use a virtual environment\nconda env create\nconda activate stactools-sentinel1\n# Development install of dependencies\npip install -e ./\npip install -r requirements-dev.txt\n```\n\n### Make changes on a new branch, test, open a pull request\n\n```shell\ngit checkout -b newfeature\n# make changes\n\n# Run CI tests locally\n./scripts/cibuild\n\n# Or run individual scripts\n./scripts/lint\n./scripts/format\n./scripts/test\n\n# If you're changing the output STAC metadata, update the examples\n./scripts/create_examples.py\n\n# Once tests pass, commit changes and create a pull request\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "stactools subpackage for creating sentinel1 STACs",
    "version": "0.8.0",
    "project_urls": {
        "Documentation": "https://github.com/stactools-packages/sentinel1",
        "Homepage": "https://github.com/stactools-packages/sentinel1",
        "Issues": "https://github.com/stactools-packages/sentinel1/issues"
    },
    "split_keywords": [
        "stactools",
        "pystac",
        "catalog",
        "stac",
        "sentinel",
        "grd",
        "radar"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1ec6f9d8e456c0b71c69d32db3de3d9813b3febc6c352c8f94de7ff48b9fad16",
                "md5": "5f9fdbd9936083024e47c359cd08d007",
                "sha256": "8db775fd0c5618fff892d802f4c8cbd63a40e8cacf2ed2a17afeb757a29b866f"
            },
            "downloads": -1,
            "filename": "stactools_sentinel1-0.8.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5f9fdbd9936083024e47c359cd08d007",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 37915,
            "upload_time": "2024-02-16T19:25:53",
            "upload_time_iso_8601": "2024-02-16T19:25:53.433536Z",
            "url": "https://files.pythonhosted.org/packages/1e/c6/f9d8e456c0b71c69d32db3de3d9813b3febc6c352c8f94de7ff48b9fad16/stactools_sentinel1-0.8.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "977635d81e20220f0f1719f6e053929cc67211a499fa7a7e9d320a7c5d650608",
                "md5": "a216c701e906ae7809fb5878d31b61a6",
                "sha256": "15d89ed9c7590fc8144b5898fe797f23f671843fc732d2f46106bb9d9f900c4c"
            },
            "downloads": -1,
            "filename": "stactools-sentinel1-0.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a216c701e906ae7809fb5878d31b61a6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 30204,
            "upload_time": "2024-02-16T19:25:54",
            "upload_time_iso_8601": "2024-02-16T19:25:54.720239Z",
            "url": "https://files.pythonhosted.org/packages/97/76/35d81e20220f0f1719f6e053929cc67211a499fa7a7e9d320a7c5d650608/stactools-sentinel1-0.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-16 19:25:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "stactools-packages",
    "github_project": "sentinel1",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "stactools-sentinel1"
}
stac-utils
Elapsed time: 4.12197s