diff --git a/.github/workflows/testing_alpha.yml b/.github/workflows/testing_alpha.yml index 24336071..ce3461e3 100644 --- a/.github/workflows/testing_alpha.yml +++ b/.github/workflows/testing_alpha.yml @@ -46,8 +46,8 @@ jobs: run: | coverage run --source=geoprob_pipe -m pytest --ignore=_deprecated/tests coverage report -m - rm -f readme_images/coverage.svg - coverage-badge -o readme_images/coverage.svg + rm -f other/coverage.svg + coverage-badge -o other/coverage.svg - name: Commit & push coverage badge via GitHub App bot run: | diff --git a/README.md b/README.md index ea524151..80ce933a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Coverage](https://raw.githubusercontent.com/kkpdata/GeoProb-Pipe/alpha/readme_images/coverage.svg) +![Coverage](https://raw.githubusercontent.com/kkpdata/GeoProb-Pipe/alpha/other/coverage.svg) # GeoProb-Pipe Applicatie voor het uitvoeren van probabilistische piping berekeningen. De applicatie maakt gebruik van de probabilistische @@ -26,7 +26,7 @@ Vanuit de development omgeving (kloon van repository) start je de applicatie als Het volgende branch-schema wordt aangehouden: -![Branch-schema](./readme_images/geoprob-pipe-branch-scheme.png) +![Branch-schema](other/geoprob-pipe-branch-scheme.png) diff --git a/other/PyPI_README.md b/other/PyPI_README.md new file mode 100644 index 00000000..778767e1 --- /dev/null +++ b/other/PyPI_README.md @@ -0,0 +1,33 @@ +![Coverage](https://raw.githubusercontent.com/kkpdata/GeoProb-Pipe/alpha/other/coverage.svg) + +# GeoProb-Pipe +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. + + +# Contactpersonen +Het GeoProb-Pipe-team bestaat uit de volgende personen + +- Sander Kapinga, S.Kapinga@wsrl.nl +- Laura van der Doef, L.vanderDoef@wshd.nl +- Chris Pitzalis, ontwikkelaar, C.Pitzalis@wsrl.nl +- Vincent Jilesen, ontwikkelaar, V.Jilesen@wshd.nl + + +# Installatie en quickstart +GeoProb-Pipe installeer je zoals je gewend bent van Python: `pip install geoprob_pipe`. GeoProb-Pipe is een terminal +applicatie (TUI), je start hem middels het commando `geoprob_pipe`. + + +# Mee ontwikkelen +Wil je bijdragen aan de ontwikkeling van GeoProb-Pipe? Dat kan! :) + +Maak een nieuwe branch aan vanuit `alpha`, ga coden en wanneer je klaar bent, maak een pull en review request aan. Lees +voor het maken van de review request even de richtlijnen in de repository README. + + +# Disclaimer +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. diff --git a/readme_images/coverage.svg b/other/coverage.svg similarity index 100% rename from readme_images/coverage.svg rename to other/coverage.svg diff --git a/readme_images/geoprob-pipe-branch-scheme.graphml b/other/geoprob-pipe-branch-scheme.graphml similarity index 100% rename from readme_images/geoprob-pipe-branch-scheme.graphml rename to other/geoprob-pipe-branch-scheme.graphml diff --git a/readme_images/geoprob-pipe-branch-scheme.png b/other/geoprob-pipe-branch-scheme.png similarity index 100% rename from readme_images/geoprob-pipe-branch-scheme.png rename to other/geoprob-pipe-branch-scheme.png diff --git a/pyproject.toml b/pyproject.toml index 6b64d2ac..b7521ec3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,8 +1,16 @@ [tool.poetry] name = "geoprob_pipe" -version = "2.2.6" +version = "2.2.7" description = "Execute probabilistic piping calculations using the Deltares probabilic library." +keywords = [ + "levee", + "dike", + "piping", + "probabilistic", + "water-safety", + "hydrology", +] authors = [ "Chris Pitzalis ", "Vincent Jilesen ", @@ -10,11 +18,16 @@ authors = [ "Laura van der Doef ", ] license = "GPL-3.0-or-later" -readme = "README.md" +readme = "other/PyPI_README.md" +homepage = "https://kkpdata.github.io/GeoProb-Pipe/" repository = "https://github.com/kkpdata/GeoProb-Pipe" +documentation = "https://kkpdata.github.io/GeoProb-Pipe/" classifiers = [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", + "Intended Audience :: Science/Research", + "Topic :: Scientific/Engineering", + "Topic :: Scientific/Engineering :: Hydrology", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Programming Language :: Python :: 3.12", ]