Merge pull request #37 from TUDelftGeodesy/dev_private

Facilitate private repo

.github/workflows/build.yml

@@ -20,9 +20,9 @@ jobs:
         python-version: ["3.10", "3.11", "3.12"]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

.github/workflows/build_group.yml

@@ -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@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      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]"
+    - name: Build the package
+      run: python -m build
+    - name: Test with pytest
+      run: python -m pytest

.github/workflows/doc_deploy.yml

@@ -14,11 +14,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout main
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Python 3.12
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: "3.12"
       - name: Install dependencies

.github/workflows/ruff.yml

@@ -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

docs/dev_guide.md

@@ -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
 ```