Skip to main content

Cortix is a Python library for system-level module coupling, execution, and analysis.

Project description

Cortix

A Python library for system-level module coupling, execution, and analysis.

Website Repo Size Build Status PyPI version PyPI - Python Version

What is Cortix?

  • Cortix is a Python library for system-level module coupling, execution, and analysis of dynamical system models that exchange time-dependent data.
  • Cortix takes as input a collection of computational modules and provides an environment for the coupling of these modules into a single simulation.
  • Cortix supports:
    • Communication between modules
    • Time synchronization
    • Data visualization

The basic concepts in Cortix are the creation of an Application and a Simulation involving Tasks.

Installation: Cortix can be installed on any Unix-based environment

Installing via PyPI

pip install --user cortix

Installing from source

  1. Clone this repository to install the current version of Cortix in PyPI.
git clone https://github.com/dpploy/cortix.git
  1. Install the required dependencies listed in requirements.txt
pip install --user -r cortix/requirements.txt
  1. Add cortix's parent path to your $PYTHONPATH variable
export PYTHONPATH=$PYTHONPATH:$(pwd)

Note: you may want to add this line to your .bashrc in order for it to be persistent

Testing

Testing is facilitated through PyTest. To test your Cortix install, run the droplet example from the python shell

   >> from cortix.examples.console_run import droplet_run as droplet 
   >> droplet.run()

Using Cortix

Cortix requires a set of input files, a driver, and a configuration file. See examples/console_run for working examples of Cortix simulations. Cortix will output logging information to stdout by default, extensive logging of runtime information is also stored in the <work_dir> directory specified in the cortix-config.xml input file.

Developers

Documentation

Project details


Download files

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

Files for cortix, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size cortix-0.1.2-py3-none-any.whl (433.8 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size cortix-0.1.2.tar.gz (392.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page