PyElastica Documentation

PyElastica Documentation#

Elastica is a free and open-source software project for the simulation of assemblies of slender, one-dimensional structures using Cosserat Rod theory.

More information about Elastica is available at the project website


Build_status codecov Documentation Status

PyElastica is the python implementation of Elastica. The easiest way to install PyElastica is with PIP:

$ pip install pyelastica

You can also download the source code for PyElastica directly from GitHub.

All options:

  • examples: installs dependencies to run example cases, found under the folder examples.

  • docs: packages to build documentation

Options can be combined, e.g.

$ pip install "pyelastica[examples,docs]"

If you want to simulate magnetic Cosserat rods interacting with external magnetic environments you can install the derived package using

$ pip install magneto_pyelastica

Details can be found here.


Elastica++ is a C++ implementation of Elastica. The expected release date for the beta version is 2024 Q4.


on gitter

We mainly use git-issue to communicate the roadmap, updates, helps, and bug fixes. If you have problem using PyElastica, check if similar issue is reported in git-issue.

We also opened gitter channel for short and immediate feedbacks.


If you are interested to contribute, please read contribution-guide first.

Indices and tables#