Python package for the threedigrid administration
Project description
Threedigrid: The 3Di grid admin framework
The Python package for the threedigrid administration.
Free software: BSD license
Documentation: https://threedigrid.readthedocs.io.
Overview
Features
access to the threedicore administration by a single instance of the GridH5Admin object
query the model data by pre-defined subsets and django style filters
export model data to gis formats like shapefile, geopackage
serialize model data as geojson
Quick start
The standard threedigrid distribution is pretty lightweight, installing as little dependencies as possible. If you want to make use of all capabilities threedigrid has to ofter (e.g. spatial operations and command line tools) install like this:
$ pip install threedigrid[geo,results]
Console scripts
Using the 3digrid_explore shortcut, simply run:
$ 3digrid_explore --grid-file=<path to grid file> --ipy
This will invoke an ipython session with a GridH5Admin instance already loaded.
To get a quick overview of the threedimodels meta data omit the --ipy option or explicitly run:
$ 3digrid_explore --grid-file=<the to grid file> --no-ipy
This will give you output like this:
Overview of model specifics: model slug: v2_bergermeer-v2_bergermeer_bres_maalstop-58-b1f8179f1f3c2333adb08c9e6933fa7b9a8cd163 threedicore version: 0-20180315-3578e9b-1 threedi version: 1.63.dev0 has 1d: True has 2d: True has groundwater: True has levees: True has breaches: True has pumpstations: True
(I)Python shell
Get a grid admin instance:
from threedigrid.admin.gridadmin import GridH5Admin f = 'gridadmin.h5' ga = GridH5Admin(f)
The grid admin directly holds some model specific attributes like whether the model has a 1D or 2D or groundwater section:
In [4]: ga.has_groundwater Out[4]: False In [5]: ga.has_1d Out[5]: True
There are different types of filters but a filter, generally speaking, acts on field. That means you can filter by value. If you have a line model instance you can filter the data by the kcu field:
ga.lines.filter(kcu__in=[100,102])
or by the lik value:
ga.lines.filter(lik__eq=4)
The filtering is lazy, that is, to retrieve data you have to call data explicitly:
ga.lines.filter(lik__eq=4).data # will return an ordered dict
Remote procedure calls
Currently only the client-side is included. The server-side might be added in a later stage. Note: this is an advanced feature used inside the 3Di stack, probably you don’t need this. Note2: you need Python 3.7 or higher for this to work.
Installation:
$ pip install threedigrid[rpc]
Basic usage:
ga = GridH5ResultAdmin('rpc://REDIS_HOST/SIMULATION_ID', 'rpc://REDIS_HOST/SIMULATION_ID')
# Replace REDIS_HOST and SIMULATION_ID with actual values.
future_result = ga.nodes.filter(lik__eq=4).data
data = await future_result.resolve()
Subscription usage:
subscription = await future_result.subscribe()
async for item in subscription.enumerate():
# do something with item
Credits
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
History
1.0.19rc2 (2020-01-14)
Fixed incorrect version number
1.0.19rc1 (2020-01-14)
Added RPC datasource which enables to use the majority of threedigrid in a RPC setting. Uses asyncio-rpc for sending/handling RPC calls.
RPC datasource allows both one time executing (resolve()) and pub/sub (subscribe()) functionialty.
Refactored to allow using RPC datasource
1.0.18 (2019-11-28)
Only use pyproj Transformer if it is present else revert to old transform method
1.0.17 (2019-11-28)
Added content_pk to the pumps model.
Bumped package versions
Reduced reprojection overhead of line_geometries.
1.0.16 (2019-07-08)
Removed max capacity from Orifice model/serializer.
1.0.15 (2019-07-05)
Fixed group update for default null values.
1.0.14 (2019-06-19)
Do not use 0 has a default when converting database objects to numpy arrays in the prepare phase.
1.0.13 (2019-05-01)
Fixed _field_model_dict being a class variable.
1.0.12 (2019-04-18)
Added sumax to nodes
1.0.11 (2019-02-01)
Bug fix in h5py_file method mapping.
1.0.10 (2019-01-31)
Added sources and sinks (q_sss) to threedigrid.
1.0.9 (2019-01-31)
Manholes preparation fixed mapping in connection_node_pk.
Added to_structured_array method for retrieving (filtered) results as Numpy structured array instead of an OrderedDict
1.0.8 (2019-01-03)
Set fixed type to the fields code, display_name and shape. These fields now have a fixed lenght of 32, 64 and 4 characters respectively.
1.0.7 (2018-11-21)
Bug fix: dict.values() and dict.keys() in python 3 are causing some unintended behaviour.
1.0.6 (2018-11-14)
New release due to failing uploads.
1.0.5 (2018-11-14)
Add aggregation option ‘current’ to volume and intercepted_volume.
Using a non-tuple sequence for multidimensional indexing is deprecated; use arr[tuple(seq)] instead of arr[seq].
Properties should be strings so we can use string methods on them.
Do not prepare levees if there aren’t any.
Split requirements file to allow for finer grained builds (for instance to generate the documentation).
Add ‘intercepted_volume’ to NodesAggregateResultsMixin.
Split requirements file to allow for finer grained builds (for instance to generate the documentation).
1.0.4 (2018-10-17)
Added BooleanArrayField for boolean values and use it for is_manhole filter. NO_DATA_VALUE is interpreted as False.
1.0.3 (2018-09-17)
Do not throw exception on cftime ImportError
1.0.2 (2018-09-17)
Add boolean filter for manholes.
1.0.1 (2018-09-11)
Patch for converting numpy strings/bytes to float for both python2/3.
Dropped NetCDF library and replaced opening NetCDF files with h5py
Bumped h5py to 2.8.0
1.0 (2018-09-04)
Made threedigrid >= Python 3.5 compatible.
0.2.8 (2018-07-23)
Bug fix for issue #44: use the method get_filtered_field_value() instead of get_field_value() for the count property.
Properly closes netcdf-file in GridH5ResultAdmin.
0.2.7 (2018-05-24)
Add export functions for 2D to the export_all() collection.
0.2.6 (2018-05-17)
Do not use pkg_resources to determine the current version but use zest_releaser to update the version string in threedigrid/init.py
0.2.5 (2018-05-16)
Use the custom NumpyEncoder to convert specific numpy types to native python types when calling (geo-)json.dumps().
0.2.4 (2018-05-15)
Introducing subset fields that can be used to query results that are collected only for subsets of the model, like the 2D section.
0.2.3 (2018-05-14)
Fix lookup_index functionality for composite fields.
Make model name property optional. That is, ‘unknown’ will be returned if the name cannot be derived.
Changed Depth/width fields on breach-timeseries to breach_depth and breach_width.
0.2.2 (2018-04-30)
_get_composite_meta() does not raise an AssertionError anymore if composite field attributes differ. Instead a warning is issued.
0.2.1 (2018-04-26)
Bug fix: threedicore_result_version must be a property.
0.2 (2018-04-26)
Added additional exporters for
2D_GROUNDWATER
2D_OPEN_WATER
2D_VERTICAL_INFILTRATION
Added method get_model_instance_by_field_name to the GridH5ResultAdmin class. This makes it possible to do reverse lookups in situations where you have a field name but do not know which model it belongs to. N.B the field must be unique otherwise an IndexError will be raised.
Added property dt_timestamps to the timeseries_mixin module.
The version number is added to the __init__ file dynamically using the pkg_resources API.
Timestamps of all timeseries fields are shown for aggregation results.
Timestamps in the aggregation results are filtered when retrieving subsets of timeseries.
Introducing the ModelMeta class. Its main purpose at this moment is to compute all possible combinations of composite_fields and aggregation variables.
Fixed return statement of method slice (in class Model) which now takes **new_class_kwargs.
Empty or missing datasets are now displayed as np.array(None) instead of raising an error.
0.1.6 (2018-04-18)
New release using twine 1.11.
0.1.5 (2018-04-18)
Added support for composite fields which can be used to fetch data from multiple source variables as a single field. Like this result_3di netcdfs can be queried the same way as gridadmin files.
0.1.4 (2018-04-08)
Changed ResultMixin to dynamically add attributes based on the netcdf variables.
Added basic result proccesing for line/node data.
The filter mask is computed only for array’s affected and before applying it to all array’s
The ‘only’ filter works much faster because the filter mask is only applied on fields that are affected.
The filter mask is cached on the line/node instance after getting the first value. You can thus do something like:
queryset = gridadmin.lines.filter(kcu=2) ids = queryset.id line_coords = queryset.line_coords
and the filter mask will only be computed once.
Add click console scripts 3digrid_explore and 3digrid_export for quick overviews and data exports.
Make ogr/gdal imports optional to avoid breaking parts of the documentation.
Added documentation and setup for sphinx documentation pipeline.
Use linear referencing for embedded channels to keep the original geometry intact when preparing line geometries for visualisation.
Define extra’s to make the standard threedigrid distribution as lightweight as possible.
Convert strings in attrs to numpy.string_ to fix crashes under Windows.
0.1.3 (2018-03-16)
Remove property has_groundwater from GridH5Admin. Should always be provided by the threedicore itself. Gives a warning for backwards compatibility.
0.1.2 (2018-03-12)
Get model extent now always returns a bbox (minX, minY, maxX, maxY)
0.1.1 (2018-03-06)
All imports are absolute.
Added install info using pip.
0.1.0 (2018-03-05)
First release with fullrelease.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for threedigrid-1.0.19rc2-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 51a00d01f9f9b9c420e45738984ad1a638cc55b5377486922273fea5af345066 |
|
| MD5 | 4344e4f38d39b6b1ae0c3e814c933558 |
|
| BLAKE2b-256 | 1d46a41c40c9fcd372b3ca0792cf3324c9a9ebd95c4dca6fca97c01fa9fa7459 |
