Skip to content

DorianDepriester/Elasticipy

Repository files navigation

Elasticipy

PyPI - Version PyPI - Downloads PyPI - License ReadTheDoc DOI codecov

A python toolkit to manipulate strain and strain tensors, and other linear elasticity-related tensors (e.g. stiffness). This package also provides a collection of easy-to-use and very fast tools to work on stress and strain tensors.

Main features

Among other features, this package implements:

  • Computation of elasticity tensors,
  • Analysis of elastic anisotropy and wave propagation,
  • Working with multidimensional arrays of strain and stress tensors,
  • Thermal expansion tensors,
  • Rotation of tensors,
  • Integration with crystal symmetry groups,
  • Visualization and tutorials for ease of use,
  • A graphical user interface to plot the spatial dependence of engineering constants,
  • Compatibility with the Materials Project API.

Installation

Elasticipy can be installed with PIP:

pip install Elasticipy

Documentation

Tutorials and full documentation are available on ReadTheDoc.

Sources

The source code is available on GitHub under the MIT licence.

Tests and Code Coverage

The project uses unit tests with pytest and coverage reports generated using coverage. These reports are hosted on codecov.

Coverage Exclusions

Certain parts of the code, particularly those related to graphical user interfaces (GUIs) or visual plotting, are excluded from code coverage analysis. This includes the following file:

  • src/Elasticipy/gui.py