Skip to content

Commit

Permalink
Add Features section and link to licence.
Browse files Browse the repository at this point in the history
  • Loading branch information
DorianDepriester committed Dec 6, 2024
1 parent aca9836 commit 03c69fe
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,28 @@
![PyPI - License](https://img.shields.io/pypi/l/Elasticipy)
![ReadTheDoc](https://readthedocs.org/projects/elasticipy/badge/?version=latest)

A python toolkit to manipulate elastic constants of materials.
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,
- 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.

## Installation
Elasticipy can be installed with PIP:
````
pip install Elasticipy
````

## Documentation
The full documentation is available on [ReadTheDoc](https://elasticipy.readthedocs.io/).
Tutorials and full documentation are available on [ReadTheDoc](https://elasticipy.readthedocs.io/).

## Sources
The source code is available on [GitHub](https://github.com/DorianDepriester/Elasticipy).
The source code is available on [GitHub](https://github.com/DorianDepriester/Elasticipy) under the [MIT licence](https://github.com/DorianDepriester/Elasticipy/blob/c6c3d441a2d290ab8f4939992d5d753a1ad3bdb0/LICENSE).

0 comments on commit 03c69fe

Please sign in to comment.