PyPolSAR is a python module for Polarimetric Synthetic Aperture Radar (PolSAR) data processing.
GPL-3.0 License
PyPolSAR is a python module for Polarimetric Synthetic Aperture Radar (PolSAR) data processing.
Documentation & Software Citation
To see the latest full documentation click on here.
If you use the software in a publication then please cite it using the Zenodo DOI. Be aware that this badge links to the latest package version.
Please select your specific version at [to do in future] to get the DOI of that version. You should normally always use the DOI for the specific version of your record in citations. This is to ensure that other researchers can access the exact research artefact you used for reproducibility.
You can find additional information regarding DOI versioning at http://help.zenodo.org/#versioning
Installation This package should be installable through pip which downloads the package from the python package repository Pypi. However, pypolsar also needs some packages that depend on C or Fortran libraries (like netCDF4). They should be installed first with conda. See http://conda.pydata.org/docs/ on how to use it. We recommend using either Anaconda or Miniconda.
conda install -c conda-forge numpy scipy pandas netCDF4 cython libgdal gdal
Afterwards pypolsar can be installed via pip.
pip install pypolsar
You can also install all needed (conda and pip) dependencies at once using the following commands after cloning this repository. This is recommended for developers of the package. Note that the git --recursive flag will clone test-data, which is needed by some tests.
git clone https://github.com/IslamAlam/pypolsar.git --recursive
cd pypolsar
conda create -n pypolsar python=3.6 # or any supported python version
source activate pypolsar
conda update -f environment.yml -n pypolsar
python setup.py develop
All manipulations with dependencies are executed through Poetry. If you're new to it, look through the documentation.
Poetry's commands are very intuitive and easy to learn, like:
poetry add numpy
poetry run pytest
poetry build
Building a new version of the application contains steps:
poetry version <version>
. You can pass the new version explicitly, or a rule such as major
, minor
, or patch
. For more details, refer to the Semantic Versions standard.GitHub
.GitHub release
.poetry publish --build
Well, that's up to you. I can only recommend the packages and articles that helped me.
Packages:
Typer
is great for creating CLI applications.Rich
makes it easy to add beautiful formatting in the terminal.FastAPI
is a type-driven asynchronous web framework.IceCream
is a little library for sweet and creamy debuggingArticles:
For your development we've prepared:
Python 3.7
and higher.Poetry
as the dependencies manager. See configuration in pyproject.toml
and setup.cfg
.black
, isort
and pyupgrade
formatters.pre-commit
hooks with formatters above.mypy
.pytest
.darglint
.safety
and bandit
..editorconfig
, .dockerignore
, and .gitignore
. You don't have to worry about those things.For building and deployment:
GitHub
integration.Makefile
for building routines. Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc. More details at Makefile summary).Github Actions
with predefined build workflow as the default CI/CD.@dependabot
(You will only enable it).Release Drafter
. It creates a list of changes based on labels in merged Pull Requests
. You can see labels (aka categories
) in release-drafter.yml
. Works perfectly with Semantic Versions specification.For creating your open source community:
LICENSE
, CONTRIBUTING.md
, CODE_OF_CONDUCT.md
, and SECURITY.md
are generated automatically.Stale bot
that closes abandoned issues after a period of inactivity. (You will only need to setup free plan). Configuration is here.Release Drafter
.pip install pypolsar
or install with Poetry
poetry add pypolsar
Then you can run
pypolsar --help
pypolsar --name Roman
or if installed with Poetry
:
poetry run pypolsar --help
poetry run pypolsar --name Roman
Makefile
contains many functions for fast assembling and convenient work.
make download-poetry
make install
If you do not want to install pre-commit hooks, run the command with the NO_PRE_COMMIT flag:
make install NO_PRE_COMMIT=1
make check-safety
This command launches a Poetry
and Pip
integrity check as well as identifies security issues with Safety
and Bandit
. By default, the build will not crash if any of the items fail. But you can set STRICT=1
for the entire build, or you can configure strictness for each item separately.
make check-safety STRICT=1
or only for safety
:
make check-safety SAFETY_STRICT=1
multiple
make check-safety PIP_STRICT=1 SAFETY_STRICT=1
List of flags for
check-safety
(can be set to1
or0
):STRICT
,POETRY_STRICT
,PIP_STRICT
,SAFETY_STRICT
,BANDIT_STRICT
.
The command is similar to check-safety
but to check the code style, obviously. It uses Black
, Darglint
, Isort
, and Mypy
inside.
make check-style
It may also contain the STRICT
flag.
make check-style STRICT=1
List of flags for
check-style
(can be set to1
or0
):STRICT
,BLACK_STRICT
,DARGLINT_STRICT
,ISORT_STRICT
,MYPY_STRICT
.
Codestyle uses pre-commit
hooks, so ensure you've run make install
before.
make codestyle
make test
make lint
the same as:
make test && make check-safety && make check-style
List of flags for
lint
(can be set to1
or0
):STRICT
,POETRY_STRICT
,PIP_STRICT
,SAFETY_STRICT
,BANDIT_STRICT
,BLACK_STRICT
,DARGLINT_STRICT
,ISORT_STRICT
,MYPY_STRICT
.
make docker
which is equivalent to:
make docker VERSION=latest
More information here.
make clean_docker
or to remove all build
make clean
More information here.
You can see the list of available releases on the GitHub Releases page.
We follow Semantic Versions specification.
We use Release Drafter
. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when youβre ready. With the categories option, you can categorize pull requests in release notes using labels.
For Pull Request this labels are configured, by default:
Label | Title in Releases |
---|---|
enhancement , feature
|
π Features |
bug , refactoring , bugfix , fix
|
π§ Fixes & Refactoring |
build , ci , testing
|
π¦ Build System & CI/CD |
breaking |
π₯ Breaking Changes |
documentation |
π Documentation |
dependencies |
β¬οΈ Dependencies updates |
You can update it in release-drafter.yml
.
GitHub creates the bug
, enhancement
, and documentation
labels for you. Dependabot creates the dependencies
label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.
This project is licensed under the terms of the GPL-3.0-or-later
license. See LICENSE for more details.
@misc{pypolsar,
author = {Earth-Observation},
title = {PyPolSAR is a python module for Polarimetric Synthetic Aperture Radar (PolSAR) data processing.},
year = {2020},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/IslamAlam/pypolsar}}
}
This project was generated with python-package-template
.