Skip to content

Commit

Permalink
Merge pull request #237 from ASFHyP3/develop
Browse files Browse the repository at this point in the history
Release v0.13.0 -- packaging
  • Loading branch information
jhkennedy authored Oct 23, 2023
2 parents 263059f + 8192f5d commit 1e55af0
Showing 56 changed files with 151 additions and 143 deletions.
16 changes: 0 additions & 16 deletions .github/PULL_REQUEST_TEMPLATE/release.md

This file was deleted.

11 changes: 0 additions & 11 deletions .github/pull_request_template.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
@@ -13,6 +13,6 @@ on:

jobs:
call-changelog-check-workflow:
uses: ASFHyP3/actions/.github/workflows/reusable-changelog-check.yml@v0.4.0
uses: ASFHyP3/actions/.github/workflows/reusable-changelog-check.yml@v0.8.3
secrets:
USER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2 changes: 1 addition & 1 deletion .github/workflows/create-jira-issue.yml
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ on:

jobs:
call-create-jira-issue-workflow:
uses: ASFHyP3/actions/.github/workflows/reusable-create-jira-issue.yml@v0.8.0
uses: ASFHyP3/actions/.github/workflows/reusable-create-jira-issue.yml@v0.8.3
secrets:
JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
2 changes: 1 addition & 1 deletion .github/workflows/labeled-pr.yml
Original file line number Diff line number Diff line change
@@ -12,4 +12,4 @@ on:

jobs:
call-labeled-pr-check-workflow:
uses: ASFHyP3/actions/.github/workflows/reusable-labeled-pr-check.yml@v0.4.0
uses: ASFHyP3/actions/.github/workflows/reusable-labeled-pr-check.yml@v0.8.3
12 changes: 12 additions & 0 deletions .github/workflows/release-template-comment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
on:
pull_request:
types:
- opened
branches:
- main

jobs:
call-release-checklist-workflow:
uses: ASFHyP3/actions/.github/workflows/reusable-release-checklist-comment.yml@v0.8.3
secrets:
USER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ on:

jobs:
call-release-workflow:
uses: ASFHyP3/actions/.github/workflows/reusable-release.yml@v0.4.0
uses: ASFHyP3/actions/.github/workflows/reusable-release.yml@v0.8.3
with:
release_prefix: HyP3 autoRIFT
secrets:
6 changes: 3 additions & 3 deletions .github/workflows/static-analysis.yml
Original file line number Diff line number Diff line change
@@ -4,10 +4,10 @@ on: push

jobs:
call-flake8-workflow:
uses: ASFHyP3/actions/.github/workflows/reusable-flake8.yml@v0.4.0
uses: ASFHyP3/actions/.github/workflows/reusable-flake8.yml@v0.8.3
with:
local_package_names: hyp3_autorift
excludes: hyp3_autorift/vend
excludes: src/hyp3_autorift/vend

call-secrets-analysis-workflow:
uses: ASFHyP3/actions/.github/workflows/reusable-secrets-analysis.yml@v0.4.0
uses: ASFHyP3/actions/.github/workflows/reusable-secrets-analysis.yml@v0.8.3
2 changes: 1 addition & 1 deletion .github/workflows/tag-version.yml
Original file line number Diff line number Diff line change
@@ -7,6 +7,6 @@ on:

jobs:
call-bump-version-workflow:
uses: ASFHyP3/actions/.github/workflows/reusable-bump-version.yml@v0.4.0
uses: ASFHyP3/actions/.github/workflows/reusable-bump-version.yml@v0.8.3
secrets:
USER_TOKEN: ${{ secrets.TOOLS_BOT_PAK }}
11 changes: 5 additions & 6 deletions .github/workflows/test-and-build.yml
Original file line number Diff line number Diff line change
@@ -12,19 +12,18 @@ on:

jobs:
call-pytest-workflow:
uses: ASFHyP3/actions/.github/workflows/reusable-pytest.yml@v0.4.0
uses: ASFHyP3/actions/.github/workflows/reusable-pytest.yml@v0.8.3
with:
local_package_name: hyp3_autorift
conda_env_name: hyp3-autorift
python_versions: >-
["3.9"]
call-version-info-workflow:
uses: ASFHyP3/actions/.github/workflows/reusable-version-info.yml@v0.4.0
with:
conda_env_name: hyp3-autorift
uses: ASFHyP3/actions/.github/workflows/reusable-version-info.yml@v0.8.3

call-docker-ghcr-workflow:
needs: call-version-info-workflow
uses: ASFHyP3/actions/.github/workflows/reusable-docker-ghcr.yml@v0.4.0
uses: ASFHyP3/actions/.github/workflows/reusable-docker-ghcr.yml@v0.8.3
with:
version_tag: ${{ needs.call-version-info-workflow.outputs.version_tag }}
secrets:
43 changes: 27 additions & 16 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -7,23 +7,34 @@ 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.13.0]

### Changed
* Upgraded to ASFHyP3/actions v0.8.3
* `hyp3-autorift` now uses a `src` layout per this [recommendation](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/).
* `hyp3-autorift` now only uses `pyproject.toml` for package creation now that `setuptools` recommends [not using setup.py](https://setuptools.pypa.io/en/latest/userguide/quickstart.html#setuppy-discouraged).

### Fixed
* Patch [235](src/hyp3_autorift/vend/CHANGES-227.diff) was applied to make it easier for users to correct for ionosphere
streaks without needing to know the scale factor.

## [0.12.0]

### Added
* [`hyp3_autorift.crop`](hyp3_autorift/crop.py) provides a `crop_netcdf_product` function to crop HyP3 AutoRIFT products
* [`hyp3_autorift.crop`](src/hyp3_autorift/crop.py) provides a `crop_netcdf_product` function to crop HyP3 AutoRIFT products
to the extent of valid `v` data

### Changed
* HyP3 AutoRIFT products generated with the main workflow will be cropped to the extent of the valid `v` data

### Fixed
* Patch [227](hyp3_autorift/vend/CHANGES-227.diff) was applied to align the S1 granules velocity description with the
* Patch [227](src/hyp3_autorift/vend/CHANGES-227.diff) was applied to align the S1 granules velocity description with the
optical products

## [0.11.1]

### Fixed
* Patch [223](hyp3_autorift/vend/CHANGES-223.diff) was applied so that the polarization is correctly selected in the
* Patch [223](src/hyp3_autorift/vend/CHANGES-223.diff) was applied so that the polarization is correctly selected in the
sentinel-1 workflow

## [0.11.0]
@@ -36,7 +47,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
autoRIFT versions < 0.9.0, which was released November 2, 2022

### Changed
* Patch [nasa-jpl/autorift#78](hyp3_autorift/vend/CHANGES-UPSTREAM-78.diff) was applied from upstream to support the
* Patch [nasa-jpl/autorift#78](src/hyp3_autorift/vend/CHANGES-UPSTREAM-78.diff) was applied from upstream to support the
Sentinel-1 correction workflow

### Removed
@@ -66,14 +77,14 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

### Changed

* Patch [196](hyp3_autorift/vend/CHANGES-189.diff) was applied to update the `flag_meanings` netCDF attribute to be
inline with CF-Convention 1.8, as described in the [vendored software README.md](hyp3_autorift/vend/README.md)
* Patch [196](src/hyp3_autorift/vend/CHANGES-189.diff) was applied to update the `flag_meanings` netCDF attribute to be
inline with CF-Convention 1.8, as described in the [vendored software README.md](src/hyp3_autorift/vend/README.md)

## [0.10.1]

### Changed
* Patches [189](hyp3_autorift/vend/CHANGES-189.diff), [191](hyp3_autorift/vend/CHANGES-191.diff), and [194](hyp3_autorift/vend/CHANGES-194.diff)
were applied to update some netCDF variable attributes, as described in the [vendored software README.md](hyp3_autorift/vend/README.md)
* Patches [189](src/hyp3_autorift/vend/CHANGES-189.diff), [191](src/hyp3_autorift/vend/CHANGES-191.diff), and [194](src/hyp3_autorift/vend/CHANGES-194.diff)
were applied to update some netCDF variable attributes, as described in the [vendored software README.md](src/hyp3_autorift/vend/README.md)

## [0.10.0]

@@ -88,8 +99,8 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.9.1]

### Changed
* [A patch](hyp3_autorift/vend/CHANGES-176.diff) was applied to update some netCDF variable attributes, as described
in the [vendored software README.md](hyp3_autorift/vend/README.md)
* [A patch](src/hyp3_autorift/vend/CHANGES-176.diff) was applied to update some netCDF variable attributes, as described
in the [vendored software README.md](src/hyp3_autorift/vend/README.md)

## [0.9.0]

@@ -163,7 +174,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

### Changed
* Patches were applied to clean up some netCDF variable attributes, as described
in the [vendored software README.md](hyp3_autorift/vend/README.md)
in the [vendored software README.md](src/hyp3_autorift/vend/README.md)

## [0.7.3](https://github.com/ASFHyP3/hyp3-autorift/compare/v0.7.2...v0.7.3)

@@ -173,14 +184,14 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
* In the netCDF product, the default autoRIFT parameter file URL will always be reported
instead of reporting copies used to support custom HyP3 deployments
* A patch was applied to fix some Sentinel-1 and Sentinel-2 product metadata, as described
in the [vendored software README.md](hyp3_autorift/vend/README.md)
in the [vendored software README.md](src/hyp3_autorift/vend/README.md)

### Fixed
* Updated the upgrade to autoRIFT `v1.4.0` to account for the autoRIFT source repo
having moved the `v1.4.0` tag (between commits [`67e4996..b6700f9`](https://github.com/nasa-jpl/autoRIFT/compare/67e4996..b6700f9))
and changed the conda-forge package accordingly (new sha256 and bumped the build number).
* The autoRIFT workflow scripts are now based on the moved tag and any still
necessary fixes were applied as described in the [vendored software README.md](hyp3_autorift/vend/README.md)
necessary fixes were applied as described in the [vendored software README.md](src/hyp3_autorift/vend/README.md)
* For Sentinel-2 products, file names now include the full COG Id to ensure unique
file names are produced and to be consistent with other products.

@@ -193,15 +204,15 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

### Changed
* Applied a fix to the autoRIFT packaging script that updates the reference velocity
fields for projected velocity, as described in the [vendored software README.md](hyp3_autorift/vend/README.md)
fields for projected velocity, as described in the [vendored software README.md](src/hyp3_autorift/vend/README.md)

## [0.7.0](https://github.com/ASFHyP3/hyp3-autorift/compare/v0.6.3...v0.7.0)

### Changed
* Upgraded autoRIFT to [v1.4.0](https://github.com/leiyangleon/autoRIFT/releases/tag/v1.4.0)
and [ISCE2 v2.5.3 built with autoRIFT v1.4.0](https://anaconda.org/hyp3/isce2)
* Applied some fixes to the autoRIFT workflow scripts as described in the
[vendored software README.md](hyp3_autorift/vend/README.md)
[vendored software README.md](src/hyp3_autorift/vend/README.md)
* `hyp3_autorift.io.save_topsinsar_mat` has been renamed to `hyp3_autorift.io.get_topsinsar_config`
* It no longer writes a config `.mat` file and instead returns the config dictionary

@@ -215,7 +226,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

### Changed
* Applied some minor error estimate fixes and netCDF metadata attribute updates as
described in the [vendored software README.md](hyp3_autorift/vend/README.md)
described in the [vendored software README.md](src/hyp3_autorift/vend/README.md)
* `process.get_lc2_metadata()` now attempts to fetch STAC metadata from the
https://landsatlook.usgs.gov/ API and falls back the STAC json in the S3 bucket

2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -49,5 +49,5 @@ RUN wget https://github.com/nasa-jpl/autoRIFT/pull/79.diff && \
patch -d ${PYTHON_SITE_PACKAGES}/isce/components/contrib/geo_autoRIFT/autoRIFT < 79.diff && \
rm 79.diff

ENTRYPOINT ["/hyp3-autorift/hyp3_autorift/etc/entrypoint.sh"]
ENTRYPOINT ["/hyp3-autorift/src/hyp3_autorift/etc/entrypoint.sh"]
CMD ["-h"]
5 changes: 0 additions & 5 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
include LICENSE
include README.md

graft hyp3_autorift

global-exclude *.py[cod] __pycache__ *.so
6 changes: 3 additions & 3 deletions environment.yml
Original file line number Diff line number Diff line change
@@ -9,6 +9,7 @@ dependencies:
- python>=3.8,<3.10 # Top pin to fix ISCE2 incompatibility: https://github.com/isce-framework/isce2/issues/458
- pip
# For packaging, and testing
- build
- flake8
- flake8-import-order
- flake8-blind-except
@@ -18,9 +19,8 @@ dependencies:
- pytest-console-scripts
- pytest-cov
- responses
- setuptools
- setuptools_scm
- wheel
- setuptools>=61
- setuptools_scm>=6.2
# For running
- gdal>=3
- h5netcdf
69 changes: 68 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,69 @@
[build-system]
requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"]
requires = ["setuptools>=61.0", "setuptools_scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"

[project]
name = "hyp3_autorift"
requires-python = ">=3.8"
authors = [
{name="ASF APD/Tools Team", email="uaf-asf-apd@alaska.edu"},
]
description = "A HyP3 plugin for feature tracking processing with AutoRIFT-ISCE"
readme = "README.md"
license = {text = "BSD-3-Clause"}
classifiers=[
"Intended Audience :: Science/Research",
"License :: OSI Approved :: BSD License",
"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",
]
dependencies = [
'boto3',
'botocore',
'gdal',
'h5netcdf',
'hyp3lib==1.7.0',
'matplotlib',
'netCDF4',
'numpy',
'pyproj',
'requests',
'scipy',
'xarray',
]
dynamic = ["version"]

[project.optional-dependencies]
develop = [
'flake8',
'flake8-import-order',
'flake8-blind-except',
'flake8-builtins',
'pillow',
'pytest',
'pytest-cov',
'pytest-console-scripts',
'responses',
]

[project.scripts]
hyp3_autorift = "hyp3_autorift.process:main"
s1_correction = "hyp3_autorift.s1_correction:main"

[project.urls]
Homepage = "https://github.com/ASFHyP3/hyp3-autorift"
"Bug Tracker" = "https://github.com/ASFHyP3/hyp3-autorift/issues"
Documentation = "https://hyp3-docs.asf.alaska.edu"

[tool.setuptools]
include-package-data = true
zip-safe = false

[tool.setuptools.packages.find]
where = ["src"]

[tool.setuptools_scm]
Loading

0 comments on commit 1e55af0

Please sign in to comment.