Release v0.1.0

.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     # Docs: https://github.com/ASFHyP3/actions
     uses: ASFHyP3/actions/.github/workflows/[email protected]
     with:
-      release_prefix: HyP3 opera-rtc-s1-browse
+      release_prefix: opera-rtc-s1-browse
       release_branch: main
       develop_branch: develop
       sync_pr_label: actions-bot

.github/workflows/test.yml

@@ -16,3 +16,5 @@ jobs:
     uses: ASFHyP3/actions/.github/workflows/[email protected]
     with:
       local_package_name: opera_rtc_s1_browse
+      python_versions: >-
+        ["3.10", "3.11", "3.12"]

CHANGELOG.md

@@ -6,5 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/)
 and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0](opera-rtc-s1-browse/compare/v0.0.0...v0.1.0) -- unreleased
+## [0.1.0]
 
+### Added
+* RTC granule download functionality
+* Browse image creation functionality
+
+### Removed
+* Unused functionality created during HyP3-Cookiecutter setup

README.md

@@ -1,3 +1,56 @@
 # opera-rtc-s1-browse
 
-A tool for create OPERA RTC S1 browse images
+A tool for creating OPERA RTC Sentinel-1 browse images for [NASA Worldview](https://worldview.earthdata.nasa.gov).
+
+## Usage
+Once installed (see below for details) you can run the tool using the command:
+```bash
+python -m opera_rtc_s1_browse OPERA_L2_RTC-S1_T035-073251-IW2_20240113T020816Z_20240113T113128Z_S1A_30_v1.0
+```
+Where you replace `OPERA_L2_RTC-S1_T035-073251-IW2_20240113T020816Z_20240113T113128Z_S1A_30_v1.0` with the name of OPERA RTC S1 product you want to create a browse image for.
+
+To explore the available options, run:
+```bash
+python -m opera_rtc_s1_browse --help
+```
+These options allow you to specify an AWS S3 bucket path where the browse image will be uploaded.
+
+## Setup
+### Installation
+1. Ensure that conda is installed on your system (we recommend using [mambaforge](https://github.com/conda-forge/miniforge#mambaforge) to reduce setup times).
+2. Download a local version of the `opera-s1-rtc-browse` repository (`git clone https://github.com/ASFHyP3/opera_rtc_s1_browse.git`)
+3. In the base directory for this project, call `mamba env create -f environment.yml` to create your Python environment and activate it (`mamba activate opera-s1-rtc-browse`)
+4. Finally, install a development version of the package (`python -m pip install -e .`)
+
+To run all commands in sequence use:
+```bash
+git clone https://github.com/ASFHyP3/opera-s1-rtc-browse.git
+cd opera-s1-rtc-browse
+mamba env create -f environment.yml
+mamba activate opera-s1-rtc-browse
+python -m pip install -e .
+```
+
+### Credentials
+To use `opera_rtc_s1_browse`, you must provide your Earthdata Login credentials via two environment variables (`EARTHDATA_USERNAME` and `EARTHDATA_PASSWORD`), or via your `.netrc` file.
+
+If you do not already have an Earthdata account, you can sign up [here](https://urs.earthdata.nasa.gov/home).
+
+If you would like to set up Earthdata Login via your `.netrc` file, check out this [guide](https://harmony.earthdata.nasa.gov/docs#getting-started) to get started.
+
+To use the S3 upload functionality, you will also need to have [AWS credentials configured](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) that have permission to write to the specified S3 bucket.
+
+## License
+`opera-rtc-s1-browse` is licensed under the BSD 2-Clause License. See the LICENSE file for more details.
+
+## Contributing
+Contributions to this project are welcome! If you would like to contribute, please submit a pull request on the GitHub repository.
+
+## Contact Us
+Want to talk about `opera-rtc-s1-browse`? We would love to hear from you!
+
+Found a bug? Want to request a feature?
+[open an issue](https://github.com/ASFHyP3/opera-rtc-s1-browse/issues/new)
+
+General questions? Suggestions? Or just want to talk to the team?
+[chat with us on gitter](https://gitter.im/ASFHyP3/community)

environment.yml

@@ -3,18 +3,12 @@ channels:
   - conda-forge
   - nodefaults
 dependencies:
-  - python>=3.8
+  - python>=3.10
   - pip
+  # For running
+  - asf_search
+  - boto3
+  - gdal
   # For packaging, and testing
-  - flake8
-  - flake8-import-order
-  - flake8-blind-except
-  - flake8-builtins
-  - setuptools
-  - setuptools_scm
-  - wheel
   - pytest
-  - pytest-console-scripts
   - pytest-cov
-  # For running
-  - hyp3lib>=3,<4

pyproject.toml

@@ -16,31 +16,29 @@ classifiers=[
     "Natural Language :: English",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
 ]
 dependencies = [
-    "hyp3lib>=3,<4",
-    # insert python dependencies as list here
+    "asf_search",
+    "boto3",
+    "gdal",
 ]
 dynamic = ["version", "readme"]
 
 [project.optional-dependencies]
 develop = [
-    "flake8",
-    "flake8-import-order",
-    "flake8-blind-except",
-    "flake8-builtins",
     "pytest",
     "pytest-cov",
-    "pytest-console-scripts",
 ]
 
 [project.urls]
 Homepage = "opera-rtc-s1-browse"
-Documentation = "https://hyp3-docs.asf.alaska.edu"
+Documentation = "https://github.com/asfhyp3/opera-rtc-s1-browse#opera-rtc-s1-browse"
+
+[project.scripts]
+create_browse = "opera_rtc_s1_browse.create_browse:main"
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]

src/opera_rtc_s1_browse/__init__.py

@@ -1,9 +0,0 @@
-"""A tool for create OPERA RTC S1 browse images"""
-
-from importlib.metadata import version
-
-__version__ = version(__name__)
-
-__all__ = [
-    '__version__',
-]

src/opera_rtc_s1_browse/auth.py

@@ -0,0 +1,77 @@
+import netrc
+import os
+from pathlib import Path
+from platform import system
+from typing import Tuple
+
+
+EARTHDATA_HOST = 'urs.earthdata.nasa.gov'
+
+
+def get_netrc() -> Path:
+    """Get the location of the netrc file.
+
+    Returns:
+        Path to the netrc file
+    """
+    netrc_name = '_netrc' if system().lower() == 'windows' else '.netrc'
+    netrc_file = Path.home() / netrc_name
+    return netrc_file
+
+
+def find_creds_in_env(username_name, password_name) -> Tuple[str, str]:
+    """Find credentials for a service in the environment.
+
+    Args:
+        username_name: Name of the environment variable for the username
+        password_name: Name of the environment variable for the password
+
+    Returns:
+        Tuple of the username and password found in the environment
+    """
+    if username_name in os.environ and password_name in os.environ:
+        username = os.environ[username_name]
+        password = os.environ[password_name]
+        return username, password
+
+    return None, None
+
+
+def find_creds_in_netrc(service) -> Tuple[str, str]:
+    """Find credentials for a service in the netrc file.
+
+    Args:
+        service: Service to find credentials for
+
+    Returns:
+        Tuple of the username and password found in the netrc file
+    """
+    netrc_file = get_netrc()
+    if netrc_file.exists():
+        netrc_credentials = netrc.netrc(netrc_file)
+        if service in netrc_credentials.hosts:
+            username = netrc_credentials.hosts[service][0]
+            password = netrc_credentials.hosts[service][2]
+            return username, password
+
+    return None, None
+
+
+def get_earthdata_credentials() -> Tuple[str, str]:
+    """Get NASA EarthData credentials from the environment or netrc file.
+
+    Returns:
+        Tuple of the NASA EarthData username and password
+    """
+    username, password = find_creds_in_env('EARTHDATA_USERNAME', 'EARTHDATA_PASSWORD')
+    if username and password:
+        return username, password
+
+    username, password = find_creds_in_netrc(EARTHDATA_HOST)
+    if username and password:
+        return username, password
+
+    raise ValueError(
+        'Please provide NASA Earthdata credentials via the '
+        'EARTHDATA_USERNAME and EARTHDATA_PASSWORD environment variables, or your netrc file.'
+    )