Skip to main content

Python interface to Piccolo and Picalor simulation kernel

Project description

Piccolo5/Piccolo6/Picalor6 Python API calling interface

What is it?
-----------
A python package enabling users to call a set of Picwin32.dll or Ganessa_SIM.dll API functions and subroutines within python scripts.

Installation
------------
:Windows only:

pip install ganessa

Requirements
------------

#) python requirements: numpy 1.7 or above
#) Piccolo or Picalor kernel library (picwin32.dll), starting from version 5 (141203)
#) valid Piccolo or Picalor license

This tool requires Picwin32.dll to be in the PATH or in one of the following folders:
[ C: or D: ] / ['Program Files/Adelior/Piccolo5_' or
'Program Files (x86)/Gfi Progiciels/Piccolo6_' or
'Program Files (x86)/Gfi Progiciels/Picalor6_']
'Program Files (x86)/Safege/Ganessa_']
+ ['fr' or 'uk' or 'esp' or 'eng']

Or one of Ganessa_SIM.dll or Ganessa_TH.dll in:
[ C: or D: ] / ['Program Files (x86)/Safege/Ganessa_']
+ ['fr' or 'uk' or 'esp' or 'eng']

Content
-------

The package provides:
#) 'sim' package:
- a few basic functions for reading or loading a model, running simulations
- 'getter' functions for individual objects and attributes, time series vectors, attribute vector of all object
- iterators over links, nodes, tanks, demands, and tables, or over Piccolo selections
#) 'th' package: same functions except running extended period simulations and time series getters
#) 'util' package: miscellaneous functions
#) 'OpenFileMMI' provides classes for opening dialog frame for a .dat/.bin model file, and output (result) file
#) 'sort' provides a heapsort based on heapq
#) 'midfile' provides minimal mif/mid functions similar to shp/dbf shapefile handler (pyshp package)
#) 'epanet' provides epanet2 python API (thanks to Assela Pathirana - mailto: assela@pathirana.net) for win32
similar to EpanetTools-0.4.0

Model object and parameters can be modified using Piccolo command language (see cmd, cmdfile and execute)

History of the document
-----------------------

Created 2013-07-04
Revised 2015-05-03: since 2014-12-04 Picwin32.dll is compatible with this API
Revised 2016-07-07: provided as .rst
Revised 2017-08-08: install using pip; Piccolo/Ganessa dll folder search order.
Revised 2017-09-12: split sim into core, core_sim, core_th
Revised 2017-11-13: added sort, midfile, epanet modules


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ganessa-1.8.4-cp27-cp27m-win32.whl (2.6 MB view details)

Uploaded CPython 2.7mWindows x86

File details

Details for the file ganessa-1.8.4-cp27-cp27m-win32.whl.

File metadata

File hashes

Hashes for ganessa-1.8.4-cp27-cp27m-win32.whl
Algorithm Hash digest
SHA256 3548efe9825a13324805d6ef9ebe027ab0b4504a6eb273d9d5de6f3c6d0e0b03
MD5 39072f10a68cf33c34a0d3fac67a8983
BLAKE2b-256 fd4efc0f5cf8ca4b9e5e42f16f3f0c2567c1f55058a811f156b29b6cd749d340

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page