Skip to content

Commit

Permalink
Merge branch 'init_repo' into 16_generate_arcs
Browse files Browse the repository at this point in the history
  • Loading branch information
thijsvl committed Oct 24, 2024
2 parents 71ed406 + 127e39b commit 8304e17
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -16,15 +16,15 @@ 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.

Activate the environment:

```bash
conda activate pydepsi-dev
mamba activate pydepsi-dev
```

Install this package in development mode:
Expand All @@ -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)
Expand Down

0 comments on commit 8304e17

Please sign in to comment.