pycobi


Namepycobi JSON
Version 0.8.7 PyPI version JSON
download
home_pageNone
SummaryPython tool for parameter continuation and bifurcation analysis
upload_time2024-03-31 21:57:04
maintainerNone
docs_urlNone
authorRichard Gast
requires_python>=3.6
licenseGPL v3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # PyCoBi

[![License](https://img.shields.io/github/license/pyrates-neuroscience/PyCoBi.svg)](https://github.com/pyrates-neuroscience/PyCoBi)
[![Python](https://img.shields.io/pypi/pyversions/pycobi.svg?style=plastic)](https://badge.fury.io/py/pycobi)
[![PyPI version](https://badge.fury.io/py/pycobi.svg)](https://badge.fury.io/py/pycobi)
[![CircleCI](https://circleci.com/gh/pyrates-neuroscience/PyCoBi.svg?style=svg)](https://circleci.com/gh/pyrates-neuroscience/PyCoBi)
[![Documentation Status](https://readthedocs.org/projects/pycobi/badge/?version=latest)](https://pycobi.readthedocs.io/en/latest/?badge=latest)
[![DOI](https://zenodo.org/badge/448007450.svg)](https://zenodo.org/badge/latestdoi/448007450)

<img src="PyCoBi_logo_color.png" width="20%" heigth="20%" align="right">

*PyCoBi* is a **Py**thon tool for parameter **co**ntinuations and automated **bi**furcation analysis.
It provides a Python interface to *Auto-07p* [1], allowing for a more intuitive usage of *Auto-07p* commands within Python scripts. 
It provides direct access to solutions, branches, and their properties (i.e. special solutions, eigenvalues, etc.) as well as a range of plotting 
functions to visualize bifurcation diagrams and solutions.
Finally, it allows to automatically generate the user-supplied Fortran routines via [PyRates](https://github.com/pyrates-neuroscience/PyRates),
such that *Auto-07p* can be fully used/controlled from within a single Python script, 
without the need to supply additional non-Python files.

Installation
============

To use *PyCoBi*, it is required to install [Auto-07p](https://github.com/auto-07p/auto-07p).
You can follow these [installation instructions](https://github.com/auto-07p/auto-07p/tree/master/doc) for detailed 
information on how to install *Auto-07p* in your specific setup.
Note that it is not required to manually set any path variables, since *PyAuto* will take care of that for you.  
A typical installation procedure would be the following:

**Step 1:** Clone the *Auto-07p* github repository:

```shell
git clone https://github.com/auto-07p/auto-07p
```

**Step 2:** Configure the installation scripts

Go to the directory that you cloned the *Auto-07p* repository into and call

```shell
./configure
```

**Step 3:** Install *Auto-07p*

In the same directory, call

```shell
make
```

**Step 4:** Install the Python version of *Auto-07p*

After that, in the same directory, execute the following call from within the Python environment that you would like to use for *PyAuto*

```shell
python setup.py install
```

**Step 5:** Install *PyCoBi*

Use `pip` to install the latest stable version of *PyCoBi*

```shell
pip install pycobi
```

Alternatively, the development version of *PyCoBi* can be installed by cloning the github 
repository and using the `setup.py` for installation (see steps 1 and 4). 

Documentation
=============

A full API, documentation, and use examples can be found at [readthedocs](https://pycobi.readthedocs.io/en/latest/).

References
==========
 
[1] E.J. Doedel, T.F. Fairgrieve, B. Sandstede, A.R. Champneys, Y.A. Kuznetsov and W. Xianjun (2007) *Auto-07p:
       Continuation and bifurcation software for ordinary differential equations.* Technical report,
       Department of Computer Science, Concordia University, Montreal, Quebec.



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pycobi",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "Richard Gast",
    "author_email": "richard.gast@northwestern.edu",
    "download_url": "https://files.pythonhosted.org/packages/82/07/36f041e6ea0fc89737d879dde8f4602a3ffa520416e9e74d896fcd71cd52/pycobi-0.8.7.tar.gz",
    "platform": null,
    "description": "# PyCoBi\n\n[![License](https://img.shields.io/github/license/pyrates-neuroscience/PyCoBi.svg)](https://github.com/pyrates-neuroscience/PyCoBi)\n[![Python](https://img.shields.io/pypi/pyversions/pycobi.svg?style=plastic)](https://badge.fury.io/py/pycobi)\n[![PyPI version](https://badge.fury.io/py/pycobi.svg)](https://badge.fury.io/py/pycobi)\n[![CircleCI](https://circleci.com/gh/pyrates-neuroscience/PyCoBi.svg?style=svg)](https://circleci.com/gh/pyrates-neuroscience/PyCoBi)\n[![Documentation Status](https://readthedocs.org/projects/pycobi/badge/?version=latest)](https://pycobi.readthedocs.io/en/latest/?badge=latest)\n[![DOI](https://zenodo.org/badge/448007450.svg)](https://zenodo.org/badge/latestdoi/448007450)\n\n<img src=\"PyCoBi_logo_color.png\" width=\"20%\" heigth=\"20%\" align=\"right\">\n\n*PyCoBi* is a **Py**thon tool for parameter **co**ntinuations and automated **bi**furcation analysis.\nIt provides a Python interface to *Auto-07p* [1], allowing for a more intuitive usage of *Auto-07p* commands within Python scripts. \nIt provides direct access to solutions, branches, and their properties (i.e. special solutions, eigenvalues, etc.) as well as a range of plotting \nfunctions to visualize bifurcation diagrams and solutions.\nFinally, it allows to automatically generate the user-supplied Fortran routines via [PyRates](https://github.com/pyrates-neuroscience/PyRates),\nsuch that *Auto-07p* can be fully used/controlled from within a single Python script, \nwithout the need to supply additional non-Python files.\n\nInstallation\n============\n\nTo use *PyCoBi*, it is required to install [Auto-07p](https://github.com/auto-07p/auto-07p).\nYou can follow these [installation instructions](https://github.com/auto-07p/auto-07p/tree/master/doc) for detailed \ninformation on how to install *Auto-07p* in your specific setup.\nNote that it is not required to manually set any path variables, since *PyAuto* will take care of that for you.  \nA typical installation procedure would be the following:\n\n**Step 1:** Clone the *Auto-07p* github repository:\n\n```shell\ngit clone https://github.com/auto-07p/auto-07p\n```\n\n**Step 2:** Configure the installation scripts\n\nGo to the directory that you cloned the *Auto-07p* repository into and call\n\n```shell\n./configure\n```\n\n**Step 3:** Install *Auto-07p*\n\nIn the same directory, call\n\n```shell\nmake\n```\n\n**Step 4:** Install the Python version of *Auto-07p*\n\nAfter that, in the same directory, execute the following call from within the Python environment that you would like to use for *PyAuto*\n\n```shell\npython setup.py install\n```\n\n**Step 5:** Install *PyCoBi*\n\nUse `pip` to install the latest stable version of *PyCoBi*\n\n```shell\npip install pycobi\n```\n\nAlternatively, the development version of *PyCoBi* can be installed by cloning the github \nrepository and using the `setup.py` for installation (see steps 1 and 4). \n\nDocumentation\n=============\n\nA full API, documentation, and use examples can be found at [readthedocs](https://pycobi.readthedocs.io/en/latest/).\n\nReferences\n==========\n \n[1] E.J. Doedel, T.F. Fairgrieve, B. Sandstede, A.R. Champneys, Y.A. Kuznetsov and W. Xianjun (2007) *Auto-07p:\n       Continuation and bifurcation software for ordinary differential equations.* Technical report,\n       Department of Computer Science, Concordia University, Montreal, Quebec.\n\n\n",
    "bugtrack_url": null,
    "license": "GPL v3",
    "summary": "Python tool for parameter continuation and bifurcation analysis",
    "version": "0.8.7",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d7634ef9c57729972f7bf645ac2bff5800b31f6fe75d4ceefaf07d1694293bfa",
                "md5": "f8d09f998361d394e703c7c1d945d1ae",
                "sha256": "27c79ff2bbb4a53f46bb1778dbf866e1696c974d15709ab82cf2e18921b09401"
            },
            "downloads": -1,
            "filename": "pycobi-0.8.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f8d09f998361d394e703c7c1d945d1ae",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 34377,
            "upload_time": "2024-03-31T21:57:03",
            "upload_time_iso_8601": "2024-03-31T21:57:03.206980Z",
            "url": "https://files.pythonhosted.org/packages/d7/63/4ef9c57729972f7bf645ac2bff5800b31f6fe75d4ceefaf07d1694293bfa/pycobi-0.8.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "820736f041e6ea0fc89737d879dde8f4602a3ffa520416e9e74d896fcd71cd52",
                "md5": "979d114b28cadb9537d90a7d1ae85d10",
                "sha256": "ac95ea96eb3acd2a1b59fbd853167472bc027c490c127a766a75804b1f4326fb"
            },
            "downloads": -1,
            "filename": "pycobi-0.8.7.tar.gz",
            "has_sig": false,
            "md5_digest": "979d114b28cadb9537d90a7d1ae85d10",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 34238,
            "upload_time": "2024-03-31T21:57:04",
            "upload_time_iso_8601": "2024-03-31T21:57:04.539569Z",
            "url": "https://files.pythonhosted.org/packages/82/07/36f041e6ea0fc89737d879dde8f4602a3ffa520416e9e74d896fcd71cd52/pycobi-0.8.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-31 21:57:04",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pycobi"
}
        
Elapsed time: 0.22095s