threedi-scenario-downloader 0.2

Tools for downloading results for 3Di scenarios

threedi-scenario-downloader

The threedi-scenario-downloader package includes functions in order to automate most used download actions on the 3Di results. Example methods are:

• Download raw results

• Download logging

• Download maximum waterdepth (non-temporal raster)

• Download waterdepth (temporal raster, supply timestamp for snapshot)

• Find all scenarios model slug or scenario name

Installation

We can be installed with:

$ pip install threedi-scenario-downloader

(TODO: after the first release has been made)

Development installation of this project itself

We’re installed with pipenv, a handy wrapper around pip and virtualenv. Install that first with pip install pipenv. Then run:

$ PIPENV_VENV_IN_PROJECT=1 pipenv --three
$ pipenv install --dev

There will be a script you can run like this:

$ pipenv run run-threedi-scenario-downloader

It runs the main() function in threedi-scenario-downloader/scripts.py, adjust that if necessary. The script is configured in setup.py (see entry_points).

In order to get nicely formatted python files without having to spend manual work on it, run the following command periodically:

$ pipenv run black threedi-scenario-downloader

Run the tests regularly. This also checks with pyflakes, black and it reports coverage. Pure luxury:

$ pipenv run pytest

The tests are also run automatically on “travis”, you’ll see it in the pull requests. There’s also coverage reporting on coveralls.io (once it has been set up).

Changelog of threedi-scenario-downloader

0.2 (2019-01-24)

• Added automatic deploys to https://pypi.org/project/threedi-scenario-downloader/

0.1 (2019-01-23)

• Initial project structure created with cookiecutter and https://github.com/nens/cookiecutter-python-template

• Initial working version.