elasticipy 3.0.0__tar.gz → 4.1.0__tar.gz

{elasticipy-3.0.0 → elasticipy-4.1.0}/.github/workflows/Codecov.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: ["3.11", "3.12"]
         
     steps:
       - name: Checkout

{elasticipy-3.0.0 → elasticipy-4.1.0}/.readthedocs.yaml

@@ -15,7 +15,7 @@ build:
     # golang: "1.20"
   jobs:
     post_create_environment:
-      - python -m pip install sphinx_rtd_theme mp_api
+      - python -m pip install sphinx_rtd_theme mp_api sphinx_copybutton
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:

elasticipy-4.1.0/CITATION.bib

@@ -0,0 +1,17 @@
+@software{dorian_depriester_2025_15188346,
+  author       = {Dorian Depriester},
+  title        = {DorianDepriester/Elasticipy: v4.0.0},
+  month        = apr,
+  year         = 2025,
+  publisher    = {Zenodo},
+  version      = {v4.0.0},
+  doi          = {10.5281/zenodo.15188346},
+  url          = {https://doi.org/10.5281/zenodo.15188346},
+  swhid        = {swh:1:dir:f9538575fb87ee10510bd51906012987986fc36a
+                   ;origin=https://doi.org/10.5281/zenodo.14501849;vi
+                   sit=swh:1:snp:20bf603cb1ae305b4d37a4567557ac860e09
+                   d3e5;anchor=swh:1:rel:6dad2d91dcebe09e35d44f82a0c8
+                   a46c77f0d057;path=DorianDepriester-
+                   Elasticipy-c8bfc05
+                  },
+}

elasticipy-4.1.0/CITATION.cff

@@ -0,0 +1,11 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Depriester"
+  given-names: "Dorian"
+  orcid: "https://orcid.org/0000-0002-2881-8942"
+title: "Elasticipy"
+version: 4.0.0
+doi: 10.5281/zenodo.15188346
+date-released: 2025-04-10
+url: "https://github.com/DorianDepriester/Elasticipy"

{elasticipy-3.0.0 → elasticipy-4.1.0}/CONTRIBUTING.md

@@ -25,7 +25,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
 ## Code of Conduct
 
 This project and everyone participating in it is governed by the
-[Elasticipy Code of Conduct](https://github.com/DorianDepriester/Elasticipy/blob//CODE_OF_CONDUCT.md).
+[Elasticipy Code of Conduct](https://github.com/DorianDepriester/Elasticipy/blob/main/CODE_OF_CONDUCT.md).
 By participating, you are expected to uphold this code. Please report unacceptable behavior
 to <dorian.dep@gmail.com>.
 

{elasticipy-3.0.0 → elasticipy-4.1.0}/Examples/Elasticipy_vs_pymatgen.py

@@ -1,7 +1,5 @@
-from docutils.utils.math.latex2mathml import layout_styles
-
-from Elasticipy.StressStrainTensors import StrainTensor
-from Elasticipy.FourthOrderTensor import StiffnessTensor
+from Elasticipy.tensors.stress_strain import StrainTensor
+from Elasticipy.tensors.elasticity import StiffnessTensor
 from matplotlib import pyplot as plt
 import matplotlib as mpl
 mpl.use('Qt5Agg')   # Ensure interactive plot

{elasticipy-3.0.0 → elasticipy-4.1.0}/Examples/Elate_vs_Elasticipy.py

@@ -1,9 +1,9 @@
 import numpy as np
 from elastic import Elastic
-from Elasticipy.FourthOrderTensor import StiffnessTensor
+from Elasticipy.tensors.elasticity import StiffnessTensor
 import matplotlib as mpl
 mpl.use('Qt5Agg')   # Ensure interactive plot
-from Elasticipy.SphericalFunction import sph2cart, _plot3D
+from Elasticipy.spherical_function import sph2cart, _plot3D
 import time
 import matplotlib.pyplot as plt
 
@@ -13,7 +13,7 @@ C = StiffnessTensor.monoclinic(phase_name='TiNi',
                                C22=240, C23=131, C33=175,
                                C44=81, C55=11, C66=85,
                                C15=-18, C25=1, C35=-3, C46=3)
-Celate = Elastic(list(C.matrix))
+Celate = Elastic(list(C._matrix))
 
 # Plotting with Elate
 start_time=time.perf_counter()

{elasticipy-3.0.0 → elasticipy-4.1.0}/Examples/Example_Stiffness_tensor.py

@@ -1,7 +1,14 @@
-from Elasticipy.FourthOrderTensor import StiffnessTensor
+from Elasticipy.tensors.elasticity import StiffnessTensor
 from scipy.spatial.transform import Rotation
+
+################################################
+# The lines below are only required in PyCharm
+################################################
 import matplotlib as mpl
-mpl.use('Qt5Agg')   # Ensure interactive plot
+mpl.use('Qt5Agg')
+from qtpy import QtWidgets
+app = QtWidgets.QApplication.instance() or QtWidgets.QApplication([])
+################################################
 
 # First, let consider the NiTi material:
 C = StiffnessTensor.fromCrystalSymmetry(symmetry='monoclinic', diad='y', phase_name='TiNi',
@@ -15,29 +22,43 @@ print(C)
 E = C.Young_modulus
 # See min/max values
 print(E)
+
 # Now illustrate the spatial dependence
-E.plot_xyz_sections()   # As 2D sections...
-E.plot3D()                # ...or in 3D
-E.plot_as_pole_figure()     # or even with PF
+fig,_ = E.plot_xyz_sections()   # As 2D sections...
+fig.show()
+fig,_ = E.plot3D()              # ...or in 3D
+fig.show()
+fig,_ =E.plot_as_pole_figure()  # or even with PF
+fig.show()
+
+# Print out the maximum value for the Young modulus
 print(E.max())
 
 # Apply a random rotation on stiffness tensor
 rotation = Rotation.from_euler('ZXZ', [90, 45, 0], degrees=True)
 Crot = C*rotation
 # Check that the Young modulus has changed as well
-Crot.Young_modulus.plot3D()
+fig, _ = Crot.Young_modulus.plot3D()
+fig.show()
 
 # Now let's consider the shear modulus
 G = C.shear_modulus
-G.plot_xyz_sections()   # Plot sections with min, max and mean
-G.plot3D()     # And plot it in 3D
+fig,_ = G.plot_xyz_sections()   # Plot sections with min, max and mean
+fig.show()
+
+fig,_ = G.plot3D()              # And plot it in 3D
+fig.show()
 print(G.min())
 print(G.max())
 
 # Finally, let's have a look on the Poisson ratio
 nu = C.Poisson_ratio
-nu.plot_xyz_sections()
-nu.plot3D(which='max')
+fig,_ = nu.plot_xyz_sections()
+fig.show()
+fig,_ = nu.plot3D(which='max')
+fig.show()
+
+# Check out the maximum and minimum values
 print(nu.min())
 print(nu.max())
 
@@ -45,7 +66,8 @@ print(nu.max())
 oris = Rotation.random(1000)
 Crotated = C*oris  # Compute the Voigt average
 Cvoigt = Crotated.Voigt_average()
-print(Cvoigt.Young_modulus) # Look at the corresponding Young modulis
+print(Cvoigt.Young_modulus) # Look at the corresponding Young moduli
 print(C.Voigt_average().Young_modulus) # Compare with infinite number of orientations
 
 
+app.exec() # Only required in PyCharm (see lines 7-10)

{elasticipy-3.0.0 → elasticipy-4.1.0}/Examples/Example_StressStrain_arrays.py

@@ -2,7 +2,7 @@
 # Imports and simple example of stress
 # ======================================================
 import numpy as np
-from Elasticipy.StressStrainTensors import StressTensor, StrainTensor
+from Elasticipy.tensors.stress_strain import StressTensor, StrainTensor
 
 
 stress = StressTensor([[0, 1, 0],
@@ -23,7 +23,7 @@ print(strain.volumetric_strain())
 # ======================================================
 # Linear elasticity
 # ======================================================
-from Elasticipy.FourthOrderTensor import StiffnessTensor
+from Elasticipy.tensors.elasticity import StiffnessTensor
 
 C = StiffnessTensor.fromCrystalSymmetry(symmetry='cubic', phase_name='ferrite',
                                         C11=274, C12=175, C44=89)
@@ -61,7 +61,7 @@ from scipy.spatial.transform import Rotation
 n_ori = 1000
 rotations = Rotation.random(n_ori)
 
-eps_rotated = eps.matmul(rotations)
+eps_rotated = eps.rotate(rotations, mode='cross')
 print(eps_rotated.shape)    # Just to check how it looks like
 
 sigma_rotated = C * eps_rotated
@@ -72,7 +72,7 @@ sigma_mean = sigma.mean(axis=1)     # Compute the mean over all orientations
 print(sigma_mean[-1])
 
 C_rotated = C * rotations
-C_Voigt = C_rotated.Voigt_average()
+C_Voigt = C_rotated.Voigt_average() # Now check that the previous result is consistent with Voigt average
 sigma_Voigt = C_Voigt * eps
 print(sigma_Voigt[-1])
 

{elasticipy-3.0.0 → elasticipy-4.1.0}/Examples/Example_WaveVelocity.py

@@ -1,16 +1,14 @@
-from Elasticipy.FourthOrderTensor import StiffnessTensor
-import matplotlib as mpl
-mpl.use('Qt5Agg')   # Ensure interactive plot
+from Elasticipy.tensors.elasticity import StiffnessTensor
 from matplotlib import pyplot as plt
 
-C = StiffnessTensor.fromCrystalSymmetry(symmetry='orthorombic', phase_name='forsterite',
+C = StiffnessTensor.fromCrystalSymmetry(symmetry='orthorhombic', phase_name='forsterite',
                                         C11=320, C12=68.2, C13=71.6,
                                         C22=196.5, C23=76.8, C33=233.5, C44=64, C55=77, C66=78.7)
 rho = 3.355
 
 cp, cs_fast, cs_slow = C.wave_velocity(rho)
-print(cp)
-
-fig, _ =cp.plot_as_pole_figure(subplot_args=(131,), title='p wave', show=False)
-cs_fast.plot_as_pole_figure(subplot_args=(132,), title='s wave (fast)', fig=fig, show=False)
-cs_slow.plot_as_pole_figure(subplot_args=(133,), title='s wave (slow)', fig=fig, show=True)
+fig = plt.figure(figsize=(12,4))
+cp.plot_as_pole_figure(subplot_args=(131,), title='p wave', fig=fig)
+cs_fast.plot_as_pole_figure(subplot_args=(132,), title='s wave (fast)', fig=fig)
+cs_slow.plot_as_pole_figure(subplot_args=(133,), title='s wave (slow)', fig=fig)
+fig.show()

{elasticipy-3.0.0 → elasticipy-4.1.0}/Examples/Multiple_phases.py

@@ -1,4 +1,4 @@
-from Elasticipy.FourthOrderTensor import StiffnessTensor
+from Elasticipy.tensors.elasticity import StiffnessTensor
 import numpy as np
 from matplotlib import pyplot as plt
 

elasticipy-4.1.0/Examples/SelfConsistent.py

@@ -0,0 +1,86 @@
+import numpy as np
+from Elasticipy.tensors.fourth_order import FourthOrderTensor
+from Elasticipy.tensors.elasticity import StiffnessTensor
+from scipy.integrate import trapezoid
+from scipy.spatial.transform import Rotation
+
+I = FourthOrderTensor.identity()
+
+def gamma(C_macro_local, phi, theta, a1, a2, a3):
+    s1 = np.sin(theta)*np.cos(phi) / a1
+    s2 = np.sin(theta)*np.sin(phi) / a2
+    s3 = np.cos(theta) / a3
+    s = np.array([s1, s2, s3])
+    D = np.einsum('lmnp,pqr,lqr->qrmn', C_macro_local.full_tensor(), s, s)
+    Dinv = np.linalg.inv(D)
+    return np.einsum('qrjk,iqr,lqr->qrijkl', Dinv, s, s) # The symmetrization is made afterward (see below)
+
+def polarization_tensor(C_macro_local, a1, a2, a3, n_phi, n_theta):
+    theta = np.linspace(0, np.pi, n_theta)
+    phi = np.linspace(0, 2 * np.pi, n_phi)
+    phi_grid, theta_grid = np.meshgrid(phi, theta, indexing='ij')
+    g = gamma(C_macro_local, phi_grid, theta_grid, a1, a2, a3)
+    gsin = (g.T*np.sin(theta_grid.T)).T
+    a = trapezoid(gsin, phi, axis=0)
+    b= trapezoid(a, theta, axis=0)/(4*np.pi)
+    return FourthOrderTensor(b, force_minor_symmetry=True) # Symmetrization here (see above)
+
+def localization_tensor(C_macro_local, C_incl, n_phi, n_theta, a1, a2, a3):
+    E = polarization_tensor(C_macro_local, a1, a2, a3, n_phi, n_theta)
+    delta = FourthOrderTensor(C_incl._matrix - C_macro_local._matrix)
+    Ainv = E.ddot(delta) + I
+    return Ainv.inv()
+
+def Kroner_Eshelby(Ci, g, method='strain', max_iter=5, atol=1e-3, rtol=1e-3, display=False, n_phi=100, n_theta=100, particle_size=None):
+    Ci_rotated = (Ci * g)
+    C_macro = Ci_rotated.Hill_average()
+    eigen_stiff = C_macro.eig_stiffnesses
+    keep_on = True
+    k = 0
+    message = 'Maximum number of iterations is reached'
+    m = len(g)
+    A_local = FourthOrderTensor.zeros(m)
+    if particle_size is None:
+        a1 = a2 = a3 = 1
+    else:
+        a1, a2, a3 = particle_size
+    while keep_on:
+        eigen_stiff_old = eigen_stiff
+        C_macro_local = C_macro * (g.inv())
+        for i in range(m):
+            A_local[i] = localization_tensor(C_macro_local[i], Ci, n_phi, n_theta, a1, a2, a3)
+        A = A_local * g
+        Q = Ci_rotated.ddot(A)
+        if method=='stress':
+            CiAi_mean = Q.mean()
+            C_macro = StiffnessTensor.from_Kelvin(CiAi_mean._matrix, force_symmetries=True)
+            err = A.mean() - FourthOrderTensor.identity()
+        else:
+            B = Q.ddot(C_macro.inv())
+            R = Ci_rotated.inv().ddot(B)
+            R_mean = R.mean()
+            C_macro = StiffnessTensor.from_Kelvin(R_mean.inv()._matrix, force_symmetries=True)
+            err = B.mean() - FourthOrderTensor.identity()
+
+        # Stopping criteria
+        eigen_stiff = C_macro.eig_stiffnesses
+        abs_change = np.abs(eigen_stiff - eigen_stiff_old)
+        rel_change = np.max(abs_change / eigen_stiff_old)
+        max_abs_change = np.max(abs_change)
+        k += 1
+        if  max_abs_change < atol:
+            keep_on = False
+            message = 'Absolute change is below threshold value'
+        if rel_change < rtol:
+            keep_on = False
+            message = 'Relative change is below threshold value'
+        if k == max_iter:
+            keep_on = False
+        if display:
+            err = np.max(np.abs(err._matrix))
+            print('Iter #{}: abs. change={:0.5f}; rel. change={:0.5f}; error={:0.5f}'.format(k, max_abs_change, rel_change,err))
+    return C_macro, message
+
+C=StiffnessTensor.cubic(C11=108, C44=28.3, C12=62)
+orientations = Rotation.random(1000)
+Cmacro, msg = Kroner_Eshelby(C, orientations, method='stress', display=True)

{elasticipy-3.0.0 → elasticipy-4.1.0}/Examples/essai_plasticity.py

@@ -1,10 +1,8 @@
-from Elasticipy.Plasticity import JohnsonCook
-from Elasticipy.StressStrainTensors import StressTensor, StrainTensor
-from Elasticipy.FourthOrderTensor import StiffnessTensor
+from Elasticipy.plasticity import JohnsonCook
+from Elasticipy.tensors.stress_strain import StressTensor, StrainTensor
+from Elasticipy.tensors.elasticity import StiffnessTensor
 import numpy as np
 from matplotlib import pyplot as plt
-import matplotlib as mpl
-mpl.use('Qt5Agg')   # Ensure interactive plot
 
 
 JC = JohnsonCook(A=363, B=792.7122, n=0.5756) # https://doi.org/10.1016/j.matpr.2020.05.213
@@ -70,4 +68,5 @@ for j, model in enumerate(models):
     ax.plot(eps_xy, stress_mag, label=labels[j])
 ax.set_xlabel(r'$\varepsilon_{xy}$')
 ax.set_ylabel('Shear stress (MPa)')
-ax.legend()
+ax.legend()
+fig.show()

{elasticipy-3.0.0 → elasticipy-4.1.0}/Examples/example_readwrite.py

@@ -1,4 +1,4 @@
-from Elasticipy.FourthOrderTensor import StiffnessTensor
+from Elasticipy.tensors.elasticity import StiffnessTensor
 
 C = StiffnessTensor.from_MP("mp-1048")
 C.save_to_txt("TiNi.txt")

{elasticipy-3.0.0 → elasticipy-4.1.0}/JOSS/paper.md

@@ -112,7 +112,7 @@ orthogonal sections.
 
 ![Young modulus (GPa) of Cu single crystal as a 3D surface (a) or a pole figure (b); 
 Young modulus of Cu polycrystal with $[001]$ fiber texture, plotted in three orthogonal sections, depending on the
-averaging method. \label{fig:Young}](YoungModulus.png)
+averaging method (c). \label{fig:Young}](YoungModulus.png)
 
 Elasticipy also introduces the concept of *tensor arrays*, in a similar way as in MTEX [@MTEX], allowing to 
 process several tensors at once with simple and highly efficient commands. In order to highlight the performances 
@@ -136,17 +136,20 @@ to other averaging methods (e.g. self-consistent models), possibly beyond linear
 with ease. It already implements thermal expansion.
 
 # Usage
+This section presents the syntaxes of few basic operations performed with Elasticipy v4.0.0.
 
 ## Plot directional engineering constants
 
 \autoref{fig:Young}.a) and b) were rendered with the following syntax:
 
 ````python
-from Elasticipy.FourthOrderTensor import StiffnessTensor
+from Elasticipy.tensors.elasticity import StiffnessTensor
 C = StiffnessTensor.cubic(C11=186, C12=134, C44=77)
 E = C.Young_modulus
-E.plot3D(n_phi=500, n_theta=500)
-E.plot_as_pole_figure()
+fig, _ = E.plot3D(n_phi=500, n_theta=500)
+fig.show()
+fig, _ = E.plot_as_pole_figure()
+fig.show()
 ````
 
 ## Create an array of rotated stiffness tensors and compute average
@@ -160,7 +163,7 @@ n = 10000
 phi1 = np.random.random(n)*2*np.pi  # Random sampling from 0 to 2pi
 Euler_angles = np.array([phi1,  np.zeros(n),  np.zeros(n)]).T # Fibre texture
 rotations = Rotation.from_euler('ZXZ', Euler_angles) # Bunge-Euler angles
-C_rotated = C * rotations # n-lenght tensor array
+C_rotated = C * rotations # n-length tensor array
 ````
 
 Then, the Voigt--Reuss--Hill average [@hill] can be computed from the tensor array:
@@ -172,7 +175,8 @@ C_VRH = C_rotated.Hill_average()
 Finally, the corresponding Young moduli can be plotted in orthogonal sections, as shown in \autoref{fig:Young}.c), with:
 
 ````python
-C_VRH.Young_modulus.plot_xyz_sections()
+fig, ax = C_VRH.Young_modulus.plot_xyz_sections()
+fig.show()
 ````
 
 ## Arrays of stress/strain tensor
@@ -181,17 +185,17 @@ Efforts have been made to provide out-of-the-box simple syntaxes for common oper
 will create a tensor array corresponding to evenly-spaced strain along $[1,0,0]$ axis:
 
 ````python
-from Elasticipy.StressStrainTensors import StrainTensor
-m = 1000                     # length of tensor array
-mag = np.linspace(0, 0.1, m) # Strain magnitude
-strain = StrainTensor.tensile([1,0,0], mag)
+from Elasticipy.tensors.stress_strain import StrainTensor
+m = 1000  # length of tensor array
+mag = np.linspace(0, 0.1, m)  # Strain magnitude
+strain = StrainTensor.tensile([1, 0, 0], mag)
 ````
 
 Given the stiffness tensor ``C`` (see above), one can compute the corresponding stress array with:
 ````python
 stress = C * strain
 ````
-Finally, ``stress.von_Mises()`` returns an array of length ``n`` and data type ``float64``, providing all the 
+Finally, ``stress.vonMises()`` returns an array of length ``n`` and data type ``float64``, providing all the 
 corresponding von Mises equivalent stresses.
 
 # References

{elasticipy-3.0.0/src/elasticipy.egg-info → elasticipy-4.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: elasticipy
-Version: 3.0.0
+Version: 4.1.0
 Summary: A Python library for elasticity tensor computations
 Author-email: Dorian Depriester <dorian.dep@gmail.com>
 License: MIT
@@ -15,20 +15,22 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy
 Requires-Dist: scipy
 Requires-Dist: matplotlib
+Requires-Dist: qtpy
+Requires-Dist: pandas
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pymatgen; extra == "dev"
 Requires-Dist: orix; extra == "dev"
-Requires-Dist: mp_api; extra == "dev"
+Requires-Dist: mp_api==0.45.9; extra == "dev"
+Dynamic: license-file
 
-# Elasticipy 
 [![PyPI - Version](https://img.shields.io/pypi/v/Elasticipy?link=https%3A%2F%2Fpypi.org%2Fproject%2FElasticipy%2F)](https://pypi.org/project/elasticipy/)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/Elasticipy?link=https%3A%2F%2Fpypi.org%2Fproject%2FElasticipy%2F)](https://pypistats.org/packages/elasticipy)
 [![PyPI - License](https://img.shields.io/pypi/l/Elasticipy)](https://github.com/DorianDepriester/Elasticipy/blob/main/LICENSE)
@@ -38,9 +40,9 @@ Requires-Dist: mp_api; extra == "dev"
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Elasticipy)
 [![status](https://joss.theoj.org/papers/8cce91b782f17f52e9ee30916cd86ad5/status.svg)](https://joss.theoj.org/papers/8cce91b782f17f52e9ee30916cd86ad5)
 
+# ![Elasticipy](docs/source/logo/logo_text.svg)
 
-
-A python toolkit to manipulate strain and strain tensors, and other linear elasticity-related tensors (e.g. stiffness). 
+A python toolkit to manipulate stress 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
@@ -48,7 +50,7 @@ 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,
+- Working with multidimensional arrays of tensors,
 - Thermal expansion tensors,
 - Rotation of tensors,
 - Integration with crystal symmetry groups,
@@ -79,3 +81,19 @@ Certain parts of the code, particularly those related to graphical user interfac
 **excluded from code coverage analysis**. This includes the following file:
 
 - **`src/Elasticipy/gui.py`**
+
+## Cite this package
+If you use Elasticipy, please cite [![DOI](https://zenodo.org/badge/876162900.svg)](https://doi.org/10.5281/zenodo.14501849)
+
+You can use the following BibTeX entry:
+````bibtex
+@software{Elasticipy,
+author = {Depriester, Dorian},
+doi = {10.5281/zenodo.15188346},
+month = apr,
+title = {{Elasticipy}},
+url = {https://github.com/DorianDepriester/Elasticipy},
+version = {4.0.0},
+year = {2025}
+}
+````

{elasticipy-3.0.0 → elasticipy-4.1.0}/README.md

@@ -1,4 +1,3 @@
-# Elasticipy 
 [![PyPI - Version](https://img.shields.io/pypi/v/Elasticipy?link=https%3A%2F%2Fpypi.org%2Fproject%2FElasticipy%2F)](https://pypi.org/project/elasticipy/)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/Elasticipy?link=https%3A%2F%2Fpypi.org%2Fproject%2FElasticipy%2F)](https://pypistats.org/packages/elasticipy)
 [![PyPI - License](https://img.shields.io/pypi/l/Elasticipy)](https://github.com/DorianDepriester/Elasticipy/blob/main/LICENSE)
@@ -8,9 +7,9 @@
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Elasticipy)
 [![status](https://joss.theoj.org/papers/8cce91b782f17f52e9ee30916cd86ad5/status.svg)](https://joss.theoj.org/papers/8cce91b782f17f52e9ee30916cd86ad5)
 
+# ![Elasticipy](docs/source/logo/logo_text.svg)
 
-
-A python toolkit to manipulate strain and strain tensors, and other linear elasticity-related tensors (e.g. stiffness). 
+A python toolkit to manipulate stress 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
@@ -18,7 +17,7 @@ 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,
+- Working with multidimensional arrays of tensors,
 - Thermal expansion tensors,
 - Rotation of tensors,
 - Integration with crystal symmetry groups,
@@ -48,4 +47,20 @@ The project uses unit tests with `pytest` and coverage reports generated using `
 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`**
+- **`src/Elasticipy/gui.py`**
+
+## Cite this package
+If you use Elasticipy, please cite [![DOI](https://zenodo.org/badge/876162900.svg)](https://doi.org/10.5281/zenodo.14501849)
+
+You can use the following BibTeX entry:
+````bibtex
+@software{Elasticipy,
+author = {Depriester, Dorian},
+doi = {10.5281/zenodo.15188346},
+month = apr,
+title = {{Elasticipy}},
+url = {https://github.com/DorianDepriester/Elasticipy},
+version = {4.0.0},
+year = {2025}
+}
+````

elasticipy-4.1.0/docs/source/Elasticipy.interfaces.FEPX.rst

@@ -0,0 +1,7 @@
+Elasticipy.interfaces.FEPX module
+====================================
+
+.. automodule:: Elasticipy.interfaces.FEPX
+   :members:
+   :undoc-members:
+   :show-inheritance:

elasticipy-4.1.0/docs/source/Elasticipy.interfaces.PRISMS.rst

@@ -0,0 +1,7 @@
+Elasticipy.interfaces.PRISMS module
+====================================
+
+.. automodule:: Elasticipy.interfaces.PRISMS
+   :members:
+   :undoc-members:
+   :show-inheritance:

elasticipy-4.1.0/docs/source/Elasticipy.plasticity.rst

@@ -0,0 +1,7 @@
+Elasticipy.plasticity module
+============================
+
+.. automodule:: Elasticipy.plasticity
+   :members:
+   :undoc-members:
+   :show-inheritance:

elasticipy-4.1.0/docs/source/Elasticipy.rst

@@ -0,0 +1,25 @@
+Elasticipy package
+==================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   Elasticipy.tensors.fourth_order
+   Elasticipy.tensors.elasticity
+   Elasticipy.tensors.second_order
+   Elasticipy.tensors.stress_strain
+   Elasticipy.spherical_function
+   Elasticipy.plasticity
+   Elasticipy.interfaces.PRISMS
+   Elasticipy.interfaces.FEPX
+
+Module contents
+---------------
+
+.. automodule:: Elasticipy
+   :members:
+   :undoc-members:
+   :show-inheritance:

elasticipy-4.1.0/docs/source/Elasticipy.spherical_function.rst

@@ -0,0 +1,7 @@
+Elasticipy.spherical_function module
+====================================
+
+.. automodule:: Elasticipy.spherical_function
+   :members:
+   :undoc-members:
+   :show-inheritance:

elasticipy-4.1.0/docs/source/Elasticipy.tensors.elasticity.rst

@@ -0,0 +1,7 @@
+Elasticipy.tensors.elasticity module
+====================================
+
+.. automodule:: Elasticipy.tensors.elasticity
+   :members:
+   :undoc-members:
+   :show-inheritance:

elasticipy-4.1.0/docs/source/Elasticipy.tensors.fourth_order.rst

@@ -0,0 +1,7 @@
+Elasticipy.tensors.fourth_order module
+======================================
+
+.. automodule:: Elasticipy.tensors.fourth_order
+   :members:
+   :undoc-members:
+   :show-inheritance:

elasticipy-4.1.0/docs/source/Elasticipy.tensors.second_order.rst

@@ -0,0 +1,7 @@
+Elasticipy.tensors.second_order module
+======================================
+
+.. automodule:: Elasticipy.tensors.second_order
+   :members:
+   :undoc-members:
+   :show-inheritance:

elasticipy-4.1.0/docs/source/Elasticipy.tensors.stress_strain.rst

@@ -0,0 +1,7 @@
+Elasticipy.tensors.stress_strain module
+=======================================
+
+.. automodule:: Elasticipy.tensors.stress_strain
+   :members:
+   :undoc-members:
+   :show-inheritance: