Skip to main content

Cortix is a Python library for network dynamics modeling and HPC simulation.

Project description

Cortix

A Python library for network dynamics modeling and HPC simulation.

Website Repo Size PyPI version PyPI - Python Version

codecov

What is Cortix?

  • Cortix is a massively parallel 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:
    • Module decoupling
    • Communication between modules
    • Data visualization
  • Cortix runs on top of MPI and scales across many cores.

Installation: start by installing MPI

Installing via PyPI

pip install --user cortix

if updating to a new version, you may need to specify the version

pip install --user cortix=="<version>"

NB: this will not install the GraphViz executables but only the python wrapper. Install the GraphViz library on your system by yourself.

Installing via Conda

In a Anaconda environment (MacOS terminal conda, or Windows Anaconda powershell) do:

pip install cortix
conda install graphviz

if updating to a new version, you may need to specify the version

pip install cortix=="<version>"

Installing from source

  1. Clone this repository to install the latest version of Cortix
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

Verify your Cortix install by running the Droplet example

mpiexec -n xx examples/run_droplet_swirl.py

where xx is the number of MPI processes which must match the number of modules plus 1. If there are 10 droplets and 1 vortex, use $xx = 12$.

Testing

Testing is facilitated by PyTest. Tests can be run locally from within the tests directory

cd tests && py.test

Using Cortix

Please refer to the documentation for more on getting started!

Team

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Location

Cortix Group

c/o UMass Innovation Hub

110 Canal St., 3rd Floor

Lowell, MA 01852

Project details


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

cortix-1.1.67.tar.gz (525.1 kB view details)

Uploaded Source

Built Distribution

cortix-1.1.67-py3-none-any.whl (578.8 kB view details)

Uploaded Python 3

File details

Details for the file cortix-1.1.67.tar.gz.

File metadata

  • Download URL: cortix-1.1.67.tar.gz
  • Upload date:
  • Size: 525.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for cortix-1.1.67.tar.gz
Algorithm Hash digest
SHA256 887bdd5b05a1788acedce986551b71bcc03255be0f5d3701b1baa64c3dd2d87f
MD5 ec5242e6f6cc662128146725855fe1b2
BLAKE2b-256 bf589810a46c021da6de1a1b917e51450c71f39722c9fe8460690a21e545bb2f

See more details on using hashes here.

File details

Details for the file cortix-1.1.67-py3-none-any.whl.

File metadata

  • Download URL: cortix-1.1.67-py3-none-any.whl
  • Upload date:
  • Size: 578.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for cortix-1.1.67-py3-none-any.whl
Algorithm Hash digest
SHA256 5e06c89074b488d43fab54b2b7f49753c6fa56a355340b4cf1b8bb763fcebfe2
MD5 73d71dc9f61c1020a209879ae263b260
BLAKE2b-256 d84cf7a8eb762fe77a392c65e68123db29138a81b323d474b5d36b6d4132b30c

See more details on using hashes here.

Supported by

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