| Name | cortix JSON |
| Version |
1.1.64
JSON |
| download |
| home_page | https://cortix.org |
| Summary | Cortix is a Python library for network dynamics modeling and HPC simulation. |
| upload_time | 2025-01-15 01:36:12 |
| maintainer | None |
| docs_url | None |
| author | Cortix Computing |
| requires_python | >=3.09 |
| license | None |
| keywords |
simulation
math
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Cortix
A Python library for network dynamics modeling and HPC simulation.
+ [Cortix on Jupyter notebook examples](https://github.com/dpploy/cortix-nb)
+ [Documentation on the web](https://cortix.org)
[](https://cortix.org)
[](https://badge.fury.io/py/cortix)
[](https://badge.fury.io/py/cortix)
[](https://codecov.io/gh/dpploy/cortix)
## 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
```
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
```
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
```
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](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
Raw data
{
"_id": null,
"home_page": "https://cortix.org",
"name": "cortix",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.09",
"maintainer_email": null,
"keywords": "simulation, math",
"author": "Cortix Computing",
"author_email": "valmor_dealmeida@uml.edu",
"download_url": "https://files.pythonhosted.org/packages/15/e9/46d29e74530fbeff28e9204ad4fe586f61366c65db2d808175a507e7d9ca/cortix-1.1.64.tar.gz",
"platform": null,
"description": "# Cortix\nA Python library for network dynamics modeling and HPC simulation.\n + [Cortix on Jupyter notebook examples](https://github.com/dpploy/cortix-nb)\n + [Documentation on the web](https://cortix.org)\n\n\n[](https://cortix.org)\n[](https://badge.fury.io/py/cortix)\n[](https://badge.fury.io/py/cortix)\n\n[](https://codecov.io/gh/dpploy/cortix)\n\n\n\n## What is Cortix?\n\n* Cortix is a massively parallel Python library for system-level module coupling, execution, and\n analysis of dynamical system models that exchange time-dependent data.\n* Cortix takes as input a collection of computational modules and provides an \n environment for the coupling of these modules into a single simulation.\n* Cortix supports:\n - Module decoupling\n - Communication between modules\n - Data visualization\n* Cortix runs on top of [MPI](https://www.open-mpi.org/) and scales across many cores.\n\n\n## Installation: start by installing [MPI](https://www.open-mpi.org/)\n\n## Installing via PyPI\n```\npip install --user cortix\n```\nif updating to a new version, you may need to specify the version\n```\npip install --user cortix==\"<version>\"\n```\nNB: this will not install the GraphViz executables but only the python wrapper. Install the GraphViz library on your system by yourself.\n## Installing via Conda\nIn a `Anaconda` environment (MacOS terminal conda, or Windows Anaconda powershell) do:\n```\npip install cortix\nconda install graphviz\n```\nif updating to a new version, you may need to specify the version\n```\npip install cortix==\"<version>\"\n```\n## Installing from source\n1. Clone this repository to install the latest version of Cortix \n```\ngit clone https://github.com/dpploy/cortix.git\n```\n2. Install the required dependencies listed in `requirements.txt`\n```\npip install --user -r cortix/requirements.txt\n```\n3. Add ```cortix```'s parent path to your ```$PYTHONPATH``` variable\n```\nexport PYTHONPATH=$PYTHONPATH:$(pwd)\n```\nNote: you may want to add this line to your ```.bashrc``` in order for it to be persistent\n\n### Verify your Cortix install by running the Droplet example\n```\nmpiexec -n xx examples/run_droplet_swirl.py\n```\nwhere xx is the number of MPI processes which must match the number of modules plus 1. If there are\n10 droplets and 1 vortex, use $xx = 12$.\n\n## Testing\n\nTesting is facilitated by [PyTest](http://pytest.org). Tests can be run locally from within the `tests` directory\n```\ncd tests && py.test\n```\n\n## Using Cortix\n\nPlease refer to the [documentation](https://cortix.org/contents.html) for more on getting started!\n\n## Team \n\n- Valmor F. de Almeida: valmor\\_dealmeida@uml.edu\n- Taha M. Azzaoui: tazzaoui@cs.uml.edu\n- Seamus D. Gallagher: seamus\\_gallagher@student.uml.edu\n- Austin Rotker: austin_rotker@student.uml.edu\n- Gilberto E. Alas: gilberto\\_alas@student.uml.edu\n\n## Contributing\n\nPull 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.\n\nPlease make sure to update tests as appropriate.\n\n## Location \n\nCortix Group\n\nc/o [UMass Innovation Hub](https://www.uml.edu/Innovation-Hub/)\n\n110 Canal St., 3rd Floor\n\nLowell, MA 01852\n",
"bugtrack_url": null,
"license": null,
"summary": "Cortix is a Python library for network dynamics modeling and HPC simulation.",
"version": "1.1.64",
"project_urls": {
"Homepage": "https://cortix.org"
},
"split_keywords": [
"simulation",
" math"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9596c18abfda29fb11ea716221fcd1d7d0854682caabc30a28047e7701ee6d04",
"md5": "92e591e6b9139387d31c0fe2312cf530",
"sha256": "e20f383f8331cea6967e285fd537d7b51925df1209562add15b3080c610d33ef"
},
"downloads": -1,
"filename": "cortix-1.1.64-py3-none-any.whl",
"has_sig": false,
"md5_digest": "92e591e6b9139387d31c0fe2312cf530",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.09",
"size": 577839,
"upload_time": "2025-01-15T01:36:05",
"upload_time_iso_8601": "2025-01-15T01:36:05.904005Z",
"url": "https://files.pythonhosted.org/packages/95/96/c18abfda29fb11ea716221fcd1d7d0854682caabc30a28047e7701ee6d04/cortix-1.1.64-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "15e946d29e74530fbeff28e9204ad4fe586f61366c65db2d808175a507e7d9ca",
"md5": "5a97a0c3ffbd391587b61804948e81d6",
"sha256": "8e10e1fe84daad75ab140cfc4029778b7ef9dd8820b17245e57ec95015155b14"
},
"downloads": -1,
"filename": "cortix-1.1.64.tar.gz",
"has_sig": false,
"md5_digest": "5a97a0c3ffbd391587b61804948e81d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.09",
"size": 524178,
"upload_time": "2025-01-15T01:36:12",
"upload_time_iso_8601": "2025-01-15T01:36:12.702084Z",
"url": "https://files.pythonhosted.org/packages/15/e9/46d29e74530fbeff28e9204ad4fe586f61366c65db2d808175a507e7d9ca/cortix-1.1.64.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-15 01:36:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cortix"
}
