diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 28d82f5..fff3c1c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -30,7 +30,5 @@ jobs: python -m pip install --upgrade pip python -m pip install build python -m pip install .[dev,docs,demo] - - name: Build the package - run: python -m build - name: Test with pytest run: python -m pytest diff --git a/README.md b/README.md index 7c4f94b..62e5b43 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# PyDePSI (Tenative name) +# PyDePSI (Tentative name) -This is the repository of WIP, where we are developing a Python package for inteferometric SAR processing. The software will be inspired by the MATLAB software DePSI, but implemented in Python and include recent developments in the field. +This is repository is WIP, where we are developing a Python package for inteferometric SAR processing. The software will be inspired by the MATLAB software DePSI, but implemented in Python and include recent developments in the field. ## Installation for development @@ -16,7 +16,7 @@ cd PyDePSI Create a new conda environment (here we give an example name `pydepsi-dev`) with `mamba`.: ```bash -mamba create -n pydepsi-dev python=3.12 +mamba create -c conda-forge -n pydepsi-dev python=3.12 ``` Here we use Python 3.12 since we aim to support python 3.10 and above. @@ -24,7 +24,7 @@ Here we use Python 3.12 since we aim to support python 3.10 and above. Activate the environment: ```bash -conda activate pydepsi-dev +mamba activate pydepsi-dev ``` Install this package in development mode: @@ -38,7 +38,7 @@ In the end, install the pre-commit hooks: pre-commit install ``` -## References +## Useful reading material - [Python packaging user guide](https://packaging.python.org/) - [Testing in Python](https://docs.kedro.org/en/stable/development/automated_testing.html)