gdmcbain / bice

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BICE

A numerical path continuation software written in Python.

TODO: find new name!

Example

Example of a bifurcation diagram with snaking in the Swift-Hohenberg equation obtained with bice, see the corresponding SHE demo. Sample bifurcation diagram with snaking

Installation

To install the latest published version from PyPI simply execute:

pip3 install bice

If you instead want to install the package locally, e.g. for development purposes, you may download the latest version from this git and install it using:

git clone https://zivgitlab.uni-muenster.de/s_hart20/bice
pip3 install -e bice/

in any directory of your choice. The installation is performed using setup.py.

Requirements

The software depends on Python 3 and the following third-party packages: numpy, scipy, matplotlib, findiff, and numdifftools. All will be installed automatically when installing bice.

Tutorials

We have first tutorials!

More will follow soon.

Meanwhile you can check out the less documented demos.

Documentation

Click here for the online version of the documentation.

Building the documentation locally

The documentation can also be generated locally with the commands

cd doc
make html

The documentation can then be found in the folder doc.

You will need to have Sphinx and sphinx_rtd_theme installed:

pip3 install Sphinx sphinx_rtd_theme

About

License:MIT License


Languages

Language:Python 100.0%