Metadata-Version: 2.1
Name: cortix
Version: 1.0.2
Summary: Cortix is a Python library for system-level                module coupling, execution, and analysis.
Home-page: https://cortix.org
Author: Cortix Computing
Author-email: tazzaoui@cs.uml.edu
License: UNKNOWN
Description: # Cortix
        > A Python library for system-level module coupling, execution, and analysis.
        
        ![Website](https://img.shields.io/website/https/github.com/dpploy/cortix.svg)
        [![Build Status](https://travis-ci.org/dpploy/cortix.svg?branch=master)](https://travis-ci.org/dpploy/cortix)
        [![PyPI version](https://badge.fury.io/py/cortix.svg)](https://badge.fury.io/py/cortix)
        [![Repo Size](https://img.shields.io/github/repo-size/dpploy/cortix.svg?style=flat)](https://cortix.org)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Django.svg)](https://badge.fury.io/py/cortix)
        
        ![](cortix/docs/cortix-cover.png)
        
        ## 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](https://www.open-mpi.org/) and scales across many cores.
        
        
        ## Installation: start by installing [MPI](https://www.open-mpi.org/)
        
        ## Installing via PyPI
        ```
        pip install --user cortix
        ```
        
        ## Installing from source
        1. Clone this repository to install the latest version of Cortix 
        ```
        git clone https://github.com/dpploy/cortix.git
        ```
        2. Install the required dependencies listed in `requirements.txt`
        ```
        pip install --user -r cortix/requirements.txt
        ```
        3. 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
        ```
        mpirun -np 12 examples/droplet_run.py
        ```
        
        ## Testing
        
        Testing is facilitated by [PyTest](http://pytest.org). Tests can be run locally from within the `tests` directory
        ```
        cd tests && py.test
        ```
        
        ## Using Cortix
        
        Please refer to the [documentation](https://cortix.org/contents.html) for more on getting started!
        
        ## Team 
        
        - Valmor F. de Almeida: valmor\_dealmeida@uml.edu
        - Taha M. Azzaoui: tazzaoui@cs.uml.edu
        - Seamus D. Gallagher: seamus\_gallagher@student.uml.edu
        - Austin Rotker: austin_rotker@student.uml.edu
        - Gilberto E. Alas: gilberto\_alas@student.uml.edu
        
        ## Contributing
        
        Pull requests are welcome. For major changes, please open an [issue](https://github.com/dpploy/cortix/issues) 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](https://www.uml.edu/Innovation-Hub/)
        
        110 Canal St., 3rd Floor
        
        Lowell, MA  01852
        
Keywords: simulation,math
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Topic :: Education
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
