Skip to content

Commit 8ebe340

Browse files
gomezzzgomezzz
authored
Merge pull request #119 from aidotse/main
Release v0.1.0
2 parents cff8894 + bde1109 commit 8ebe340

File tree

76 files changed

+10263
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+10263
-2
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
# Issue
11+
## Problem Description
12+
13+
## Expected Behavior
14+
15+
## What Needs to be Done
16+
17+
## How Can It Be Tested or Reproduced
18+

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
# Feature
11+
## Desired Behavior / Functionality
12+
13+
## What Needs to Be Done
14+
15+
## How Can It Be Tested

‎.github/ISSUE_TEMPLATE/release.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: New Release
3+
about: Creating a new release version for PASEOS. Only for Maintainers.
4+
title: "Release "
5+
labels: "release"
6+
assignees: "gomezzz"
7+
---
8+
9+
# Feature
10+
11+
## Changelog
12+
13+
_to be written during release process_
14+
15+
## What Needs to Be Done (chronologically)
16+
17+
- [ ] Create PR to merge from current main into release branch
18+
- [ ] Write Changelog in PR and request review
19+
- [ ] Review the PR (if OK - merge, but DO NOT delete the branch)
20+
- [ ] Minimize packages in requirements.txt and conda-forge submission. Update packages in setup.py
21+
- [ ] Check unit tests -> Check all tests pass and there are tests for all important features
22+
- [ ] Check documentation -> Check presence of documentation for all features by locally building the docs on the release
23+
- [ ] Change version number in setup.py and docs (under conf.py)
24+
- [ ] Trigger the Upload Python Package to testpypi GitHub Action (https://github.com/aidotse/paseos/actions/workflows/deploy_to_test_pypi.yml) on the release branch (need to be logged in)
25+
- [ ] Test the build on testpypi (with `pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple paseos`)
26+
- [ ] Finalize release on the release branch
27+
- [ ] Create PR: release → main
28+
- [ ] PR Reviews
29+
- [ ] Merge release back into main
30+
- [ ] Create Release on GitHub from the last commit (the one reviewed in the PR)
31+
- [ ] Upload to PyPI
32+
- [ ] Update on conda following https://conda-forge.org/docs/maintainer/updating_pkgs.html

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Description
2+
3+
Summary of changes
4+
5+
* ...
6+
* ...
7+
8+
## Resolved Issues
9+
10+
- [ ] fixes #Issue
11+
12+
## How Has This Been Tested?
13+
14+
## Related Pull Requests
15+
16+
- #PR

‎.github/workflows/deploy_to_pypi.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# This workflows will upload a Python Package using Twine when a release is created
2+
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
3+
4+
name: Upload Python Package to pypi
5+
6+
on: workflow_dispatch
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: Set up Python
15+
uses: actions/setup-python@v2
16+
with:
17+
python-version: 3.8
18+
- name: Install dependencies
19+
run: |
20+
pip install --upgrade pip
21+
pip install setuptools wheel twine
22+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
23+
- name: Build and publish
24+
env:
25+
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
26+
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
27+
run: |
28+
python setup.py sdist bdist_wheel
29+
twine upload dist/*

‎.github/workflows/deploy_to_test_pypi.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# This workflows will upload a Python Package using Twine when a release is created
2+
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
3+
4+
name: Upload Python Package to testpypi
5+
6+
on: workflow_dispatch
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: Set up Python
15+
uses: actions/setup-python@v2
16+
with:
17+
python-version: 3.8
18+
- name: Install dependencies
19+
run: |
20+
pip install --upgrade pip
21+
pip install setuptools wheel twine
22+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
23+
- name: Build and publish
24+
env:
25+
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
26+
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
27+
run: |
28+
python setup.py sdist bdist_wheel
29+
twine upload -r testpypi dist/*

‎.github/workflows/run_tests.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# This workflow will install Python dependencies, run tests and lint with a single version of Python
2+
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
3+
name: Running tests
4+
5+
on:
6+
push:
7+
branches:
8+
- main
9+
pull_request:
10+
workflow_dispatch:
11+
jobs:
12+
lint_flake8:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Set up Python 3.9
18+
uses: actions/setup-python@v2
19+
with:
20+
python-version: 3.9
21+
- name: Lint with flake8
22+
run: |
23+
pip install flake8
24+
flake8 . --count --show-source --statistics --max-line-length=127 --ignore=E402,W503,E203
25+
26+
build:
27+
runs-on: ubuntu-latest
28+
29+
steps:
30+
- uses: actions/checkout@v2
31+
- name: Set up Python 3.9
32+
uses: actions/setup-python@v2
33+
with:
34+
python-version: 3.9
35+
- name: Search for severe code errors with flake8
36+
run: |
37+
# stop the build if there are Python syntax errors or undefined names
38+
pip install flake8
39+
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --max-line-length=127
40+
- name: provision-with-micromamba
41+
uses: mamba-org/provision-with-micromamba@main
42+
with:
43+
environment-file: environment.yml
44+
environment-name: paseos
45+
cache-downloads: true
46+
- name: Test with pytest
47+
shell: bash -l {0}
48+
run: |
49+
micromamba activate paseos
50+
cd paseos/tests
51+
micromamba install pytest
52+
pytest

‎.gitignore‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,3 +127,13 @@ dmypy.json
127127

128128
# Pyre type checker
129129
.pyre/
130+
131+
my_notebooks
132+
.vscode
133+
examples/Sentinel_2_example_notebook/Etna_00.tif
134+
examples/Sentinel_2_example_notebook/Mayon_02.tif
135+
examples/Sentinel_2_example_notebook/La_Palma_02.tif
136+
paseos/tests/de421.bsp
137+
test.csv
138+
thermal_test.csv
139+
results

‎.readthedocs.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Build documentation in the docs/ directory with Sphinx
9+
sphinx:
10+
configuration: docs/source/conf.py
11+
12+
# Optionally build your docs in additional formats such as PDF
13+
formats: all
14+
15+
build:
16+
os: ubuntu-20.04
17+
tools:
18+
python: "3.10"
19+
python: "mambaforge-4.10"
20+
21+
conda:
22+
environment: environment.yml

‎MANIFEST.in‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
include paseos/resources/default_cfg.toml
2+
include paseos/resources/de421.bsp
3+
include README.md

0 commit comments

Comments
 (0)