{"id":20065397,"url":"https://github.com/nens/threedi-results-analysis","last_synced_at":"2025-07-02T10:33:02.079Z","repository":{"id":7026468,"uuid":"55498704","full_name":"nens/threedi-results-analysis","owner":"nens","description":"Plugin for working with 3Di models in QGIS","archived":false,"fork":false,"pushed_at":"2025-06-17T20:27:11.000Z","size":284269,"stargazers_count":7,"open_issues_count":65,"forks_count":4,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-06-23T15:51:38.526Z","etag":null,"topics":["hydrologic-modeling","hydrology","netcdf","subgrid","threedi","water-management"],"latest_commit_sha":null,"homepage":"","language":"QML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nens.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":null,"funding":null,"license":"LICENSE.rst","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-04-05T10:25:10.000Z","updated_at":"2025-06-17T20:27:14.000Z","dependencies_parsed_at":"2024-04-02T09:55:34.521Z","dependency_job_id":"c302e35e-1595-4cb0-9460-ed464a0d5856","html_url":"https://github.com/nens/threedi-results-analysis","commit_stats":{"total_commits":2059,"total_committers":33,"mean_commits":62.39393939393939,"dds":0.736765420106848,"last_synced_commit":"76fbf8627297270cac84127f8cf2aed729fe07f5"},"previous_names":["nens/threedi-results-analysis","nens/threeditoolbox"],"tags_count":112,"template":false,"template_full_name":null,"purl":"pkg:github/nens/threedi-results-analysis","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nens%2Fthreedi-results-analysis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nens%2Fthreedi-results-analysis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nens%2Fthreedi-results-analysis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nens%2Fthreedi-results-analysis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nens","download_url":"https://codeload.github.com/nens/threedi-results-analysis/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nens%2Fthreedi-results-analysis/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263121098,"owners_count":23416934,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hydrologic-modeling","hydrology","netcdf","subgrid","threedi","water-management"],"created_at":"2024-11-13T13:49:59.722Z","updated_at":"2025-07-02T10:33:02.043Z","avatar_url":"https://github.com/nens.png","language":"QML","funding_links":[],"categories":[],"sub_categories":[],"readme":"3Di Results Analysis\n====================\n\nA QGIS plugin for analyzing 3Di results and visualize computational grids in the 3Di Modeller Interface.\n\n.. _`3Di`: https://3diwatermanagement.com/\n\nThe tools that this plugin provides allow you to:\n\n- Make (maximum) water depth or water level rasters from raw 3Di simulation results.\n- Visualize results on the map canvas for a specific timestep\n- Plot timeseries of discharge, water level or any other variable in a graph\n- Make side view plots of water levels and water level gradients at any time during the simulation\n- Calculate the water balance for any given area in the model domain\n- Calculate aggregated results such as maximum water level per node or total discharge per flowline\n- Calculate the total discharge crossing a user-defined line\n- Find the upstream or downstream area for any node or group of nodes\n\n\nInstallation\n------------\n\nPrerequisites\n^^^^^^^^^^^^^\n\n**Windows**\n\nInstall Qgis 3.28.5+ (the \"long term release\") from qgis.org. \n\n\n**Ubuntu**\n\nInstall QGIS and the required python3-h5py dependency::\n\n  $ sudo apt install qgis python-h5py\n\n\nGetting the plugin\n^^^^^^^^^^^^^^^^^^\n\n- In QGIS, goto \"Plugins \u003e Manage And Install Plugins... \u003e Settings\"\n- Add ``https://plugins.lizard.net/plugins.xml`` and reload\n- Install the plugin by selecting ``3Di Results Analysis``\n\n\nInstallation notes\n^^^^^^^^^^^^^^^^^^\n\nIf you have the ``PIP_REQUIRE_VIRTUALENV=1`` setting you may have to\n(temporally) remove that in order to install the plugin.\n\n\nLocal development\n-----------------\n\nOn Linux, local development happens with docker to make sure we're working in a nicely\nisolated environment. So first build the docker::\n\n  $ docker-compose build\n\nThe docker-qgis's settings are persisted in a \"named docker volume\",\n``qgis-docker``. To wipe it clean, run ``docker-compose down -v``.\n\nTo run the full tests including coverage report and flake8::\n\n  $ docker-compose run -e QT_QPA_PLATFORM=offscreen qgis-desktop make test\n\nYou can also just run pytest. You won't get the coverage report. You *can*\nhowever then use one of the pytest options, like ``-x``, which aborts the test\nat the first failure::\n\n  $ docker-compose run --rm qgis-desktop pytest -x\n\nTo get a \"coverage\" report for the docstrings or to run flake8::\n\n  $ docker-compose run --rm qgis-desktop make docstrings\n\nTo run black (standard pep8-compatible code formatting), isort (import\nsorting) and flake8 (reporting missing imports and so), run::\n\n  $ docker-compose run --rm qgis-desktop make beautiful\n\nTo run the QGIS application itself in the docker::\n\n  $ xhost +local:docker  # you may need this to run the gui\n  $ docker-compose run --rm qgis-desktop qgis\n\n\nRelease\n-------\n\nMake sure you have ``zest.releaser`` with ``qgispluginreleaser`` installed. The\n``qgispluginreleaser`` ensures the metadata.txt, which is used by the qgis plugin\nmanager is also updated to the new version. To make a new release enter the following\ncommands and follow their steps::\n\n    $ cd /path/to/the/plugin\n    $ fullrelease\n\nThis creates a new release and tag on github. Additionally, a zip file\n``threedi_results_analysis.\u003cversion\u003e.zip`` is created. Github actions is configured to also\ncreate this zip and upload it to https://plugins.lizard.net/ when a new tag is\ncreated, using the ``upload-artifact.sh`` script.\n\nYou can also manually create a zip file of the current checked out code with the\nfollowing command::\n\n    $ docker-compose run --rm qgis-desktop make zip\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnens%2Fthreedi-results-analysis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnens%2Fthreedi-results-analysis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnens%2Fthreedi-results-analysis/lists"}