Installation

Instruction

PyElastica requires Python 3.10+, which needs to be installed prior to using PyElastica. For information on installing Python, see here. If you are interested in using a package manager like Conda, see here.

Note

Python version above 3.10 is tested only in Ubuntu and Mac OS.

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.

Dependencies

The core of PyElastica is developed using:

• numpy

• numba

• scipy

• tqdm

• matplotlib (visualization)

Above packages will be installed along with PyElastica if you used pip to install. If you have directly downloaded the source code, you must install these packages separately.