Skip to main content

Process files containing Cypher queries describing complicated models.

Project description

A tool to support the description and development of state-and-transition models using the Cypher graph query language.


State-and-transition models (STMs) are valuable tools for capturing and communicating qualitative ecological and geomorphic knowledge. However, they can become unwieldy when the richness of the available qualitative knowledge renders them difficult to represent in their entirety on a 2-dimensional surface.

Cymod aims to simplify the development and use of detailed STMs by allowing modellers to specify components of their models piecemeal in individual Cypher files. Cymod can then to do the work of wiring these components together into a complete model, stored in a Neo4j graph database.

Example usage

Having prepared a set of Cypher files specifying an STM in the ./cypher-files directory, a modeller can load those files into the graph database with the following Python commands:

from cymod import ServerGraphLoader

# Initialise a ServerGraphLoader object using your Neo4j credentials
gl = ServerGraphLoader(user="username", password="password")

# Read cypher queries from files in cypher-files directory

# Run these queries against the graph specified in the neo4j
# configuration file

Supported Python versions

Tested against Python 2.7, 3.5, 3.6, and 3.7.

Project details

Download files

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

Source Distribution

cymod-0.0.5.tar.gz (28.0 kB view hashes)

Uploaded Source

Built Distribution

cymod-0.0.5-py3-none-any.whl (21.3 kB view hashes)

Uploaded Python 3

Supported by

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