Start gebruik main-branch

.github/workflows/testing.yml → .github/workflows/testing_main_dev.yml

@@ -1,10 +1,9 @@
-name: Automated testing and coverage
+name: Automated testing and coverage (in protected branches)
 
 
 on:
   push:
-    branches:
-      - 'cp_miscellaneous'
+    branches: [ "main", "dev" ]
   workflow_dispatch:
 
 
@@ -13,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Python
         uses: actions/setup-python@v2
@@ -23,12 +22,12 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-          pip install pytest coverage coverage-badge
+          if [ -f requirements_testing.txt ]; then pip install -r requirements_testing.txt; fi
+          pip install pytest coverage coverage-badge "setuptools<82.0.0"
 
       - name: Run tests with coverage
         run: |
-          coverage run --source=app -m pytest --ignore=tests
+          coverage run --source=geoprob_pipe -m pytest --ignore=_deprecated/tests
           coverage report -m
           if [ -f readme_images/coverage.svg ]; then rm readme_images/coverage.svg; fi
           coverage-badge -o readme_images/coverage.svg
@@ -37,6 +36,7 @@ jobs:
         run: |
           git config --local user.email "action@github.com"
           git config --local user.name "GitHub Actions"
+          git pull
           git add .
           if ! git diff --cached --quiet; then
             git commit -m "Testing and coverage"

.github/workflows/testing_pull_request.yml

@@ -0,0 +1,34 @@
+name: Automated testing and coverage (during pull request)
+
+
+on:
+  pull_request:
+    branches: [ "dev" ]
+    paths:
+      - 'geoprob_pipe/**'
+      - 'test_system.py'
+  workflow_dispatch:
+
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          if [ -f requirements_testing.txt ]; then pip install -r requirements_testing.txt; fi
+          pip install pytest coverage coverage-badge setuptools<82.0.0
+
+      - name: Run tests with coverage
+        run: |
+          coverage run --source=geoprob_pipe -m pytest --ignore=_deprecated/tests
+          coverage report -m

.gitignore

@@ -1,3 +1,7 @@
+# GeoProb-Pipe
+geoprob_pipe.ini
+geoprob_pipe.log
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -14,6 +18,8 @@ dist/
 downloads/
 eggs/
 .eggs/
+workspaces/example_new_calculations/output/
+**/output/
 lib/
 lib64/
 parts/
@@ -70,6 +76,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/autoapi/
 
 # PyBuilder
 .pybuilder/
@@ -169,4 +176,14 @@ _work_dir
 *.res
 #*.xlsx
 *.gdb
-*.sqlite
+*.sqlite
+!workspaces/traject_224/input/hlcd.sqlite
+!workspaces/traject_224/input/WBI2017_Bovenrijn_224_v04.config.sqlite
+!workspaces/traject_224/input/WBI2017_Bovenrijn_224_v04.sqlite
+!geoprob_pipe/pre_processing/test_files/hrd_files/hlcd.sqlite
+!geoprob_pipe/pre_processing/test_files/hrd_files/WBI2017_Bovenrijn_224_v04.config.sqlite
+!geoprob_pipe/pre_processing/test_files/hrd_files/WBI2017_Bovenrijn_224_v04.sqlite
+!tests/systeem_testen/224/hrd_files/hlcd.sqlite
+!tests/systeem_testen/224/hrd_files/WBI2017_Bovenrijn_224_v04.config.sqlite
+!tests/systeem_testen/224/hrd_files/WBI2017_Bovenrijn_224_v04.sqlite
+tests/systeem_testen/224/exports/

README.md

@@ -1,73 +1,53 @@
 ![Coverage](./readme_images/coverage.svg)
 
 # GeoProb-Pipe
-Tool voor het parallel uitvoeren van probabilistische pipingberekeningen. De tool maakt gebruik van de probabilistische bibliotheek van Deltares.
+Applicatie voor het uitvoeren van probabilistische piping berekeningen. De applicatie maakt gebruik van de probabilistische 
+bibliotheek van Deltares. Deze bibliotheek stuurt onder de motorkap de PTK-tool aan. 
 
-# Ontwikkeling
-Deze repository is in ontwikkeling. In `dev_kernel_structure` worden de functionaliteiten ontwikkeld om de structuur van de database en de rekenkernel inclusief testen op te nemen. In `main` staan de functionaliteiten voor data invoer/uitvoer, de koppeling met de probabilitistische bibliotheek en het uitvoeren van de probabilistische som.
 
 # Contactpersonen
+
+Het GeoProb-Pipe-team bestaat uit de volgende personen
+
 - Sander Kapinga, S.Kapinga@wsrl.nl
 - Laura van der Doef, L.vanderDoef@wshd.nl
-- Martijn Kriebel, mkriebel@avecodebondt.nl
+- Chris Pitzalis, ontwikkelaar, C.Pitzalis@wsrl.nl
+- Vincent Jilesen, ontwikkelaar, V.Jilesen@wshd.nl
+
 
 # Installatie
-Deze tool in ontwikkeld met Python versie 3.12.5.
-Installatie van de dependencies:
-- Conda (aanbevolen, environment incl. correcte Python versie wordt automatisch aangemaakt):
-  - Methode 1: via Anaconda Navigator. Ga naar "environments" en importeer het .yml bestand.
-  - Methode 2: via  Anaconda Prompt
-    ```console
-    # Install dependencies
-    conda env create -f environment.yml
-
-    # Activate env
-    conda activate GeoProb-Pipe
-    ```
-- Pip (gebruiker moet zelf de environment aanmaken met juiste Python versie):
-  ```console
-  # Create environnment (note: use aforementioned supported Python version)
-  python -m venv GeoProb-Pipe
-
-  # Activate env
-  GeoProb-Pipe/bin/activate
-
-  # Install dependencies
-  pip install -r requirements.txt
-  ```
-
-# Ontwikkeling
-
-- Pip (gebruiker moet zelf de environment aanmaken met juiste Python versie):
-  ```console
-  # Create environnment (note: use aforementioned supported Python version)
-  python -m venv GeoProb-Pipe
-
-  # Activate env
-  GeoProb-Pipe/bin/activate
-
-  # Install dependencies
-  pip install -r requirements.txt
-  pip install -r dev-requirements.txt
-  ```
+Op termijn wordt GeoProb-Pipe beschikbaar gesteld middels de Python Package Index (https://pypi.org) voor een eenvoudige 
+installatie via `pip install geoprob-pipe`. Voor nu is de installatie als volgt:
 
-# Documentatie
-De beschrijving van de rekenkernel is opgenomen in de documentatie. De documentatie kan worden gegeneerd door:
+ - Kloon de repository middels `git clone repo_weblink`.
+ - Maak een virtuele Python environment aan. Deze applicatie is ontwikkeld met Python versie 3.12. 
+ - Installeer alle dependencies middels `pip install -r requirements.txt`. 
 
-windows:
-```console
-sphinx-build -M html docs\ docs\_build
-```
 
 # Quickstart
-Tool wordt gestart door `main_piping.py` te runnen.
+Start de applicatie als volgt
+
+- Vanuit de gekloonde repository met het commando `python -m geoprob_pipe.questionnaire.cmd startup_geoprob_pipe`.
+- Wanneer de package/wheel geïnstalleerd is met het commando `geoprob-pipe`. 
+
+
+# Mee ontwikkelen
+Wil je bijdragen aan de ontwikkeling van GeoProb-Pipe? Dat kan! :)
+
+Maak een nieuwe branch aan vanuit `dev`, ga coden en wanneer je klaar bent, maak een pull en review request aan. Zorg 
+er voor dat de unit tests werken en dat je PEP8 als code stijl hanteert. Bij vragen, neem contact op met één van de 
+ontwikkelaars. Voor PEP8, de IDE PyCharm heeft deze out of the box ingesteld. PyCharm is daarom de geadviseerde IDE.  
+
+
+# Documentatie
+De documentatie genereer je middels het commando `sphinx-build -M html docs\ docs\_build`. Je vindt de 
+documentatie daarna terug in de map `GeoProb-Pipe\docs\_build\html\index.html`. Dit bestand opent in de browser. Tip: 
+voeg de documentatie toe aan je favorieten van de browser. 
 
-Benodigdheden:
-- Een projectmap in "workspaces" (bijv. .../workspaces/my_project) met daarin een submap "input" (.../workspaces/my_project/input)
-- De input-map bevat:
-  - input.xlsx (gebruik hiervoor het meegeleverde template input.xlsx)
-  - Unzipped HRD .sqlite (hydraulische database). Deze mag zowel in de input-map als in een submap staan.
 
 
 # Disclaimer
-Het gebruik van deze tool gebeurt volledig op eigen risico. Door deze tool te gebruiken, accepteert de gebruiker volledige verantwoordelijkheid. De ontwikkelaars kunnen geen garanties geven over de werking, nauwkeurigheid of volledigheid van de tool, en kunnen op geen enkele manier verantwoordelijk worden gehouden voor eventuele fouten, schade, of verliezen die voortvloeien uit het gebruik van deze software.
+Het gebruik van deze applicatie gebeurt volledig op eigen risico. Door deze applicatie te gebruiken, accepteert de 
+gebruiker volledige verantwoordelijkheid. Het GeoProb-Pipe-team kan geen garanties geven over de werking, 
+nauwkeurigheid of volledigheid van de applicatie, en kan op geen enkele manier verantwoordelijk worden gehouden voor 
+eventuele fouten, schade, of verliezen die voortvloeien uit het gebruik van deze software.