Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Facilitate private repo #37

Merged
merged 13 commits into from
Jan 10, 2025
Merged
35 changes: 35 additions & 0 deletions .github/workflows/build_group.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Build and test for the private repository for TUDelft Radar group
# Only test on PR for dev branch, not triggered for draft PR

name: Build and pytest

on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
branches: [ "dev" ]

jobs:
build:

runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: ['ubuntu-latest']
python-version: ["3.10", "3.11", "3.12"]

steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install build
python -m pip install ".[dev,docs,demo]"
rogerkuou marked this conversation as resolved.
Show resolved Hide resolved
- name: Build the package
run: python -m build
- name: Test with pytest
run: python -m pytest
15 changes: 15 additions & 0 deletions .github/workflows/ruff.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Lint and format check
# For dev branch on private repo, only test on PR, not triggered for draft PR

name: Ruff
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main", "dev" ]
jobs:
ruff:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: astral-sh/ruff-action@v3
rogerkuou marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@

DePSI (van Leijen, 2014) is an open source software for processing Persistent Scatterer Interferometry (PS-InSAR) data, originally implemented in MATLAB. From 2024, TUDelft and Netherlands eScience Center are collaborating to develop a Python version of DePSI, with recent advances in PS-InSAR.


rogerkuou marked this conversation as resolved.
Show resolved Hide resolved
## Developer Guide

Please refer to the [Developer Guide](docs/dev_guide.md) for installation instructions, testing, and other development-related information.


rogerkuou marked this conversation as resolved.
Show resolved Hide resolved
## Useful reading material

- [Python packaging user guide](https://packaging.python.org/)
Expand Down
5 changes: 3 additions & 2 deletions docs/dev_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ The Python implementation of DePSI is under development. At present you can only

It is assumed that you have `mamba` installed. If not, you can find the installation instructions [here](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html). Other package managers like `conda` or `venv` can be used as well.

Clone this repository and `cd` into it:
Before you start, make sure you have access to the correct DePSI repository. You can contribute to the pubilic DePSI repository by forking it to your own GitHub account. If you are a member of the TUDelftGeodesy organization, you can also contribute to the group DePSI repository.

Clone this GitHub repository, then `cd` into the cloned repository.

```bash
git clone [email protected]:TUDelftGeodesy/DePSI.git
cd DePSI
```

Expand Down
Loading