Merge pull request #5 from ACCESS-Cloud-Based-InSAR/dev

v0.0.1

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# These people will be requested for review when someone opens a pull request.
+       @ACCESS-Cloud-Based-InSAR/enumerator

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,22 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+### The bug
+<!-- Please include a clear and concise description of what the bug is. Describe
+what actually happened *and* what you expected to happen. -->
+
+### To Reproduce
+<!-- Please include the steps to reproduce the behavior. E.g.,
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error -->
+
+ ### Additional context
+<!-- Add any other context or screenshots about the bug here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+### Background
+<!-- Please include a clear and concise description of *the problem* this feature would solve. -->
+
+### Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen. -->
+
+### Alternatives
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+ ### Additional context
+<!-- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE/release.md

@@ -0,0 +1,16 @@
+<!--
+Please provide any additional description/context not captured in `CHANGELOG.md`
+and indicate any other packages/projects this is relevant to, including their
+associated issues and/or pull requests
+-->
+
+### Developer checklist
+
+- [ ] Assigned a reviewer
+- [ ] Indicated the level of changes to this package by affixing one of these labels:
+  * major -- Major changes to the API that may break current workflows
+  * minor -- Minor changes to the API that do not break current workflows
+  * patch -- Patches and bugfixes for the current version that do not break current workflows
+  * bumpless -- Changes to documentation, CI/CD pipelines, etc. that don't affect the software's version
+- [ ] (If applicable) Added/updated documentation for these changes
+- [ ] (If applicable) Added/updated tests for these changes

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "bumpless"

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+<!--
+If this is a pull request for a new release, please use the release template:
+   {{ cookiecutter.public_url }}/compare/main...develop?template=release.md
+ 
+If this PR does not include changes that should be reflected in CHANGELOG.md,
+please indicate so by affixing the `bumpless` label to this PR.
+
+NOTE: Pull requests should only be opened for merges to protected branches (required) and any 
+changes which you'd like reviewed. Do not open a pull request to update a feature or personal
+branch -- simply merge with `git`.
+-->

.github/workflows/changelog.yml

@@ -0,0 +1,26 @@
+name: Changelog updated?
+
+on:
+  pull_request:
+    types:
+      - opened
+      - labeled
+      - unlabeled
+      - synchronize
+    branches:
+      - main
+      - dev
+
+jobs:
+  changelog-udated:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Changelog check
+        uses: Zomzog/[email protected]
+        with:
+          fileName: CHANGELOG.md
+          noChangelogLabel: bumpless
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/labeled-pr.yml

@@ -0,0 +1,22 @@
+name: Is PR labeled?
+
+on:
+  pull_request:
+    types:
+      - opened
+      - labeled
+      - unlabeled
+      - synchronize
+    branches:
+      - main
+
+jobs:
+  bump-labeled:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Require Labels
+        uses: mheap/github-action-required-labels@v1
+        with:
+          mode: exactly
+          count: 1
+          labels: "major, minor, patch, bumpless"

.github/workflows/release-github.yml

@@ -0,0 +1,16 @@
+name: Create Release on Github
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  call-release-workflow:
+    uses: ASFHyP3/actions/.github/workflows/[email protected]
+    with:
+      release_prefix: s1_frame_enumerator
+      develop_branch: dev
+      sync_pr_label: team-bot
+    secrets:
+      USER_TOKEN: ${{ secrets.ACCESS_GITHUB_TOKEN }}

.github/workflows/release-pypi.yml

@@ -0,0 +1,37 @@
+name: Distribute to PyPI
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  distribute:
+    runs-on: ubuntu-latest
+    outputs:
+      SDIST_VERSION: ${{ steps.build.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade setuptools build "setuptools-scm[toml]"
+
+      - name: Build distribuion
+        id: build
+        run: |
+          git fetch origin +refs/tags/*:refs/tags/*
+          export SDIST_VERSION=$(python -m setuptools_scm)
+          echo "::set-output name=version::${SDIST_VERSION}"
+          python -m build
+
+      - name: upload to PyPI.org
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/static-analysis.yml

@@ -0,0 +1,15 @@
+name: Static Analysis (Flake8/Ruff)
+
+on: push
+
+jobs:
+  call-flake8-workflow:
+    uses: ASFHyP3/actions/.github/workflows/[email protected]
+    with:
+      local_package_names: s1_frame_enumerator
+
+  call-secrets-analysis-workflow:
+    uses: ASFHyP3/actions/.github/workflows/[email protected]
+
+  call-ruff-workflow:
+    uses: ASFHyP3/actions/.github/workflows/[email protected]

.github/workflows/tag-version.yml

@@ -0,0 +1,15 @@
+name: Tag Version on Main
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  call-bump-version-workflow:
+    uses: ASFHyP3/actions/.github/workflows/[email protected]
+    with:
+        user: access-cloud-insar-team
+        email: [email protected]
+    secrets:
+        USER_TOKEN: ${{ secrets.ACCESS_GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: mamba-org/provision-with-micromamba@main
+        with:
+          environment-name: s1-frame-enumerator
+          environment-file: environment.yml
+          extra-specs: |
+            python=${{ matrix.python-version }}
+      - name: Pytest in conda environment
+        shell: bash -l {0}
+        run: |
+          python -m pip install .
+          pytest .

.gitignore

@@ -14,11 +14,6 @@ deprecated/
 # Vim files
 *.sw[mnop]
 
-
-# Data Files
-*.zip
-*.tar.gz
-
 # .pyenv files
 .python-version
 
@@ -43,7 +38,7 @@ __pycache__/
 /dist/
 
 # Python egg metadata, regenerated from source files by setuptools.
-/*.egg-info
+**/*.egg-info
 
 # Environments
 .env
@@ -64,10 +59,13 @@ __pycache__/
 *.kmz
 *.jpg
 *.wld
-notebooks/*.geojson
+notebooks/**/*.geojson
+notebooks/**/*.json
+s1_frame_enumerator/**/*.geojson
 
 # Ignore logs
 *.log
 
-# Ignore until we have tests to run
-.github/
+# Ignore site specific notebooks
+notebooks/Submitting_to_Hyp3-*.ipynb
+notebooks/Untitled*.ipynb

.trufflehog.txt

@@ -1,2 +1,4 @@
 CHANGELOG.md
+README.md
 .*.ipynb$
+.*.json$

CHANGELOG.md

@@ -7,7 +7,11 @@ 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.0.1]
+## [0.0.0]
 
 Initial release of s1-frame-enumerator, a package for enumerating Sentinel-1 A/B pairs
 for interferograms using burst-derived frames.
+
+### Added
+* All frame instances are initialized with hemisphere property depending whether centroid is smaller than 0 deg lat.
+* Minimum frame coverage ratio (computed in epsg:4326) during enumeration is .2