Skip to content
Cortix is a Python library for system-level module coupling, execution, and analysis.
Branch: master
Clone or download
Latest commit b6f736d May 23, 2019

README.md

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

Physical Address

Cortix Group
c/o UMass Innovation Hub
110 Canal St., 3rd Floor
Lowell, MA 01852

You can’t perform that action at this time.