Skip to main content

Elastica is a software to simulate the dynamics of filaments that, at every cross-section, can undergo all six possible modes of deformation, allowing the filament to bend, twist, stretch and shear, while interacting with complex environments via muscular activity, surface contact, friction and hydrodynamics.

Reason this release was yanked:

This version in pypi package doesnt have the full Numba and Numpy code. Do not use this version!

Project description

PyElastica

Build_status Documentation Status codecov Downloads

PyElastica is the python implementation of Elastica, which 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 and Cosserat rod theory is available at the Elastica project website

New this Release

This release of PyElastica uses the Python package numba to enable just in time compilation leading to a ~8x speedup over the previous version. Numba is not required to run PyElastica and if numba is not installed, PyElastica will defualt to the non-numba implementation. As such, if you wish to take advantage of the speed-up afforded by numba, please be sure to install it separately.

Future releases of PyElastica will require numba and we will no longer be maintaining the non-numba code beyond this release.

We have also included an example script for visualizing PyElastica simulations using POVray. This script is located in the examples folder (examples/visualization).

Installation

PyPI version

PyElastica is compatible with Python 3.5 - 3.8. The easiest way to install PyElastica is with PIP.

$ pip install pyelastica 

To provide the best performance, this package requires the numba package. If for some reason you can not use numba you can still download PyElastica from here and run it locally without numba installed.

Previous PyElastica releases are available in the branches.

Documentation

Documentation Status

Documentation of PyElastica is available at docs.cosseratrods.org

PyElastica is developed by the Gazzola Lab at the University of Illinois at Urbana-Champaign.

Tutorials

Binder

We have created several Jupyter notebooks and Python scripts to help get users started with using PyElastica. The Jupyter notebooks are available on Binder, allowing you to try out some of the tutorials without having to install PyElastica.

Citation

We ask that any publications which use Elastica cite the following papers:

Zhang, Chan, Parthasarathy, Gazzola, Modeling and simulation of complex dynamic musculoskeletal architectures, Nature Communications, 2019. doi: 10.1038/s41467-019-12759-5

Gazzola, Dudte, McCormick, Mahadevan, Forward and inverse problems in the mechanics of soft filaments, Royal Society Open Science, 2018. doi: 10.1098/rsos.171628

@article{gazzola2018forward,
  title={Forward and inverse problems in the mechanics of soft filaments},
  author={Gazzola, M and Dudte, LH and McCormick, AG and Mahadevan, L},
  journal={Royal Society open science},
  volume={5},
  number={6},
  pages={171628},
  year={2018},
  publisher={The Royal Society Publishing},
  doi = {10.1098/rsos.171628},
  url = {https://doi.org/10.1098/rsos.171628},
}
@article{zhang2019modeling,
  title={Modeling and simulation of complex dynamic musculoskeletal architectures},
  author={Zhang, X and Chan, FK and Parthasarathy, T and Gazzola, M},
  journal={Nature Communications},
  volume={10},
  number={1},
  pages={1--12},
  year={2019},
  publisher={Nature Publishing Group},
  doi = {10.1038/s41467-019-12759-5},
  url = {https://doi.org/10.1038/s41467-019-12759-5},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyelastica-0.1.0.tar.gz (24.6 kB view details)

Uploaded Source

File details

Details for the file pyelastica-0.1.0.tar.gz.

File metadata

  • Download URL: pyelastica-0.1.0.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.0.0.post20200309 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for pyelastica-0.1.0.tar.gz
Algorithm Hash digest
SHA256 80ccfdb04fc1b09cb5c250a7ee49fc0cff3f63e3e0e927128de4537509873c63
MD5 c58be70a0b12e24c83e1c9af6bd13f38
BLAKE2b-256 ffe1dedb62e75b06052b123158d3c9cf95ddfac4e98187912dcd8ca73fcb10ca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page