elasticipy 5.0.0__tar.gz → 6.0.1__tar.gz

{elasticipy-5.0.0 → elasticipy-6.0.1}/.github/workflows/Codecov.yml

@@ -28,7 +28,7 @@ jobs:
           pip install pytest pytest-cov codecov pymatgen orix
 
       - name: Install project and its dependencies
-        run: pip install -e .[dev]  # Installe Elasticipy et les dépendances dev
+        run: pip install -e .[dev]  # Installe elasticipy et les dépendances dev
 
       - name: Run tests
         env:
@@ -40,6 +40,6 @@ jobs:
         uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
-          slug: DorianDepriester/Elasticipy
+          slug: DorianDepriester/elasticipy
           flags: ${{ matrix.python-version }}
           name: python-${{ matrix.python-version }}

{elasticipy-5.0.0 → elasticipy-6.0.1}/CITATION.bib

@@ -1,6 +1,6 @@
 @software{dorian_depriester_2025_15188346,
   author       = {Dorian Depriester},
-  title        = {DorianDepriester/Elasticipy: v4.0.0},
+  title        = {DorianDepriester/elasticipy: v4.0.0},
   month        = apr,
   year         = 2025,
   publisher    = {Zenodo},
@@ -12,6 +12,6 @@
                    sit=swh:1:snp:20bf603cb1ae305b4d37a4567557ac860e09
                    d3e5;anchor=swh:1:rel:6dad2d91dcebe09e35d44f82a0c8
                    a46c77f0d057;path=DorianDepriester-
-                   Elasticipy-c8bfc05
+                   elasticipy-c8bfc05
                   },
 }

{elasticipy-5.0.0 → elasticipy-6.0.1}/Elasticipy_for_the_Impatient.ipynb

@@ -46,9 +46,7 @@
    "id": "95129202",
    "metadata": {},
    "outputs": [],
-   "source": [
-    "from Elasticipy.tensors.elasticity import StiffnessTensor"
-   ]
+   "source": "from elasticipy.tensors.elasticity import StiffnessTensor"
   },
   {
    "cell_type": "code",
@@ -187,7 +185,7 @@
     }
    ],
    "source": [
-    "from Elasticipy.tensors.stress_strain import StrainTensor\n",
+    "from elasticipy.tensors.stress_strain import StrainTensor\n",
     "eps = StrainTensor.tensile([1,0,0],1e-3)\n",
     "print(eps)"
    ]
@@ -273,7 +271,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from Elasticipy.tensors.stress_strain import StressTensor\n",
+    "from elasticipy.tensors.stress_strain import StressTensor\n",
     "sigma = StressTensor.tensile([1,0,0],100)"
    ]
   },
@@ -448,9 +446,7 @@
    "cell_type": "markdown",
    "id": "c47c6e4f-48f1-4dc1-9a2b-520b2ebfa00e",
    "metadata": {},
-   "source": [
-    "Most Elasticipy's commands can be broadcasted. E.g.:"
-   ]
+   "source": "Most Elasticipy's commands can be broadcast. E.g.:"
   },
   {
    "cell_type": "code",

{elasticipy-5.0.0 → elasticipy-6.0.1}/Examples/Elasticipy_vs_pymatgen.py

@@ -1,5 +1,5 @@
-from Elasticipy.tensors.stress_strain import StrainTensor
-from Elasticipy.tensors.elasticity 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
@@ -7,7 +7,7 @@ import numpy as np
 import time
 
 C = StiffnessTensor.transverse_isotropic(Ex=200, Ez=300, nu_yx=0.2, nu_zx=0.3, Gxz=80)
-## Elasticipy's stuff
+## elasticipy's stuff
 exp = np.arange(0, 8)
 n = 10**exp
 t_stress_elast=[]
@@ -37,9 +37,9 @@ for ni in n:
 
 fig, ax = plt.subplots()
 ax.plot(n, t_stress_mg, label="Generalized Hooke's law (Pymatgen)", marker="s")
-ax.plot(n, t_stress_elast, label="Generalized Hooke's law (Elasticipy)", marker="o")
+ax.plot(n, t_stress_elast, label="Generalized Hooke's law (elasticipy)", marker="o")
 ax.plot(n, t_vm_mg, label='von Mises eq. stress (Pymatgen)', linestyle='dotted', marker="s")
-ax.plot(n, t_vm_elast, label='von Mises eq. stress  (Elasticipy)', linestyle='dotted', marker="o")
+ax.plot(n, t_vm_elast, label='von Mises eq. stress  (elasticipy)', linestyle='dotted', marker="o")
 plt.legend()
 plt.xscale('log')
 plt.yscale('log')

{elasticipy-5.0.0 → elasticipy-6.0.1}/Examples/Elate_vs_Elasticipy.py

@@ -1,9 +1,9 @@
 import numpy as np
 from elastic import Elastic
-from Elasticipy.tensors.elasticity import StiffnessTensor
+from elasticipy.tensors.elasticity import StiffnessTensor
 import matplotlib as mpl
 mpl.use('Qt5Agg')   # Ensure interactive plot
-from Elasticipy.spherical_function import sph2cart, _plot3D
+from elasticipy.spherical_function import sph2cart, _plot3D
 import time
 import matplotlib.pyplot as plt
 
@@ -36,5 +36,5 @@ ax.set_title("Elate (t={:.3f} s)".format(t))
 start_time=time.perf_counter()
 fig, ax = C.Young_modulus.plot3D(n_phi=n_phi, n_theta=n_theta)
 t = time.perf_counter() - start_time
-#ax.set_title("Elasticipy (t={:.3f} s)".format(t))
+#ax.set_title("elasticipy (t={:.3f} s)".format(t))
 fig.savefig('../JOSS/Plot_E.png', dpi=300)

{elasticipy-5.0.0 → elasticipy-6.0.1}/Examples/Example_Stiffness_tensor.py

@@ -1,4 +1,4 @@
-from Elasticipy.tensors.elasticity import StiffnessTensor
+from elasticipy.tensors.elasticity import StiffnessTensor
 from scipy.spatial.transform import Rotation
 
 ################################################

{elasticipy-5.0.0 → elasticipy-6.0.1}/Examples/Example_StressStrain_arrays.py

@@ -1,6 +1,6 @@
 import numpy as np
-from Elasticipy.tensors.stress_strain import StressTensor, StrainTensor
-from Elasticipy.tensors.elasticity import StiffnessTensor
+from elasticipy.tensors.stress_strain import StressTensor, StrainTensor
+from elasticipy.tensors.elasticity import StiffnessTensor
 from scipy.spatial.transform import Rotation
 
 # ======================================================

{elasticipy-5.0.0 → elasticipy-6.0.1}/Examples/Example_WaveVelocity.py

@@ -1,4 +1,4 @@
-from Elasticipy.tensors.elasticity import StiffnessTensor
+from elasticipy.tensors.elasticity import StiffnessTensor
 from matplotlib import pyplot as plt
 
 C = StiffnessTensor.orthorhombic(phase_name='forsterite',

{elasticipy-5.0.0 → elasticipy-6.0.1}/Examples/Multiple_phases.py

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

{elasticipy-5.0.0 → elasticipy-6.0.1}/Examples/SelfConsistent.py

@@ -1,6 +1,6 @@
 import numpy as np
-from Elasticipy.tensors.fourth_order import FourthOrderTensor
-from Elasticipy.tensors.elasticity import StiffnessTensor
+from elasticipy.tensors.fourth_order import FourthOrderTensor
+from elasticipy.tensors.elasticity import StiffnessTensor
 from scipy.integrate import trapezoid
 from scipy.spatial.transform import Rotation
 

{elasticipy-5.0.0 → elasticipy-6.0.1}/Examples/essai_plasticity.py

@@ -1,6 +1,6 @@
-from Elasticipy.plasticity import JohnsonCook
-from Elasticipy.tensors.stress_strain import StressTensor, StrainTensor
-from Elasticipy.tensors.elasticity 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
 

{elasticipy-5.0.0 → elasticipy-6.0.1}/Examples/example_readwrite.py

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

{elasticipy-5.0.0 → elasticipy-6.0.1}/JOSS/paper.md

@@ -1,5 +1,5 @@
 ---
-title: 'Elasticipy: A Python package for linear elasticity and tensor analysis'
+title: 'elasticipy: A Python package for linear elasticity and tensor analysis'
 tags:
   - Python
   - Continuum Mechanics
@@ -143,7 +143,8 @@ This section presents the syntaxes of few basic operations performed with Elasti
 \autoref{fig:Young}.a) and b) were rendered with the following syntax:
 
 ````python
-from Elasticipy.tensors.elasticity import StiffnessTensor
+from elasticipy.tensors.elasticity import StiffnessTensor
+
 C = StiffnessTensor.cubic(C11=186, C12=134, C44=77)
 E = C.Young_modulus
 fig, _ = E.plot3D(n_phi=500, n_theta=500)
@@ -185,7 +186,8 @@ 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.tensors.stress_strain import StrainTensor
+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)

{elasticipy-5.0.0/src/elasticipy.egg-info → elasticipy-6.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: elasticipy
-Version: 5.0.0
+Version: 6.0.1
 Summary: A Python library for elasticity tensor computations
 Author-email: Dorian Depriester <dorian.dep@gmail.com>
 License: MIT
@@ -47,12 +47,12 @@ Dynamic: license-file
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/DorianDepriester/Elasticipy/HEAD?urlpath=%2Fdoc%2Ftree%2FElasticipy_for_the_Impatient.ipynb)
 
 
-# ![Elasticipy](docs/source/logo/logo_text.png)
+# ![Elasticipy](https://raw.githubusercontent.com/DorianDepriester/Elasticipy/refs/heads/main/docs/source/logo/logo_text.svg)
 
 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.
 
-## :rocket: Main features
+## 🚀 Main features
 Among other features, this package implements:
 
 - Computation of elasticity tensors,
@@ -66,10 +66,10 @@ Among other features, this package implements:
 - Compatibility with the [Materials Project](https://next-gen.materialsproject.org/) API, [pymatgen](https://pymatgen.org/) and 
 [orix](https://orix.readthedocs.io/).
 
-## :snake: Installation
+## 🐍 Installation
 Elasticipy can be installed with PIP:
 ````
-pip install Elasticipy
+pip install elasticipy
 ````
 
 On anaconda, one can also use:
@@ -77,18 +77,18 @@ On anaconda, one can also use:
 conda install conda-forge::elasticipy
 ````
 
-## :books: Documentation
+## 📚 Documentation
 Tutorials and full documentation are available on [ReadTheDoc](https://elasticipy.readthedocs.io/).
 
-## :hourglass_flowing_sand: Elasticipy in a nutshell
+## ⏱️ Elasticipy in a nutshell
 Take a 5-minute tour through Elasticipy's main features by running the online Jupyter Notebook, hosted on 
 [Binder](https://mybinder.org/v2/gh/DorianDepriester/Elasticipy/HEAD?urlpath=%2Fdoc%2Ftree%2FElasticipy_for_the_Impatient.ipynb).
  
 
-## :mag: Sources
+## 🔍 Sources
 The source code is available on [GitHub](https://github.com/DorianDepriester/Elasticipy) under the [MIT licence](https://github.com/DorianDepriester/Elasticipy/blob/c6c3d441a2d290ab8f4939992d5d753a1ad3bdb0/LICENSE).
 
-## :umbrella: Tests and Code Coverage
+## ☔ Tests and Code Coverage
 
 The project uses unit tests with `pytest` and coverage reports generated using `coverage`. These reports are hosted on 
 [codecov](https://app.codecov.io/gh/DorianDepriester/Elasticipy).
@@ -99,7 +99,7 @@ Certain parts of the code, particularly those related to graphical user interfac
 
 - **`src/Elasticipy/gui.py`**
 
-## :mortar_board: Cite this package
+## 🎓 Cite this package
 If you use Elasticipy, please cite [![DOI](https://joss.theoj.org/papers/10.21105/joss.07940/status.svg)](https://doi.org/10.21105/joss.07940)
 
 You can use the following BibTeX entry:
@@ -113,7 +113,7 @@ You can use the following BibTeX entry:
     number = {115}, 
     pages = {7940}, 
     author = {Depriester, Dorian and Kubler, Régis}, 
-    title = {Elasticipy: A Python package for linear elasticity and tensor analysis}, 
+    title = {elasticipy: A Python package for linear elasticity and tensor analysis}, 
     journal = {Journal of Open Source Software}
 }
 ````

{elasticipy-5.0.0 → elasticipy-6.0.1}/README.md

@@ -12,12 +12,12 @@
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/DorianDepriester/Elasticipy/HEAD?urlpath=%2Fdoc%2Ftree%2FElasticipy_for_the_Impatient.ipynb)
 
 
-# ![Elasticipy](docs/source/logo/logo_text.png)
+# ![Elasticipy](https://raw.githubusercontent.com/DorianDepriester/Elasticipy/refs/heads/main/docs/source/logo/logo_text.svg)
 
 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.
 
-## :rocket: Main features
+## 🚀 Main features
 Among other features, this package implements:
 
 - Computation of elasticity tensors,
@@ -31,10 +31,10 @@ Among other features, this package implements:
 - Compatibility with the [Materials Project](https://next-gen.materialsproject.org/) API, [pymatgen](https://pymatgen.org/) and 
 [orix](https://orix.readthedocs.io/).
 
-## :snake: Installation
+## 🐍 Installation
 Elasticipy can be installed with PIP:
 ````
-pip install Elasticipy
+pip install elasticipy
 ````
 
 On anaconda, one can also use:
@@ -42,18 +42,18 @@ On anaconda, one can also use:
 conda install conda-forge::elasticipy
 ````
 
-## :books: Documentation
+## 📚 Documentation
 Tutorials and full documentation are available on [ReadTheDoc](https://elasticipy.readthedocs.io/).
 
-## :hourglass_flowing_sand: Elasticipy in a nutshell
+## ⏱️ Elasticipy in a nutshell
 Take a 5-minute tour through Elasticipy's main features by running the online Jupyter Notebook, hosted on 
 [Binder](https://mybinder.org/v2/gh/DorianDepriester/Elasticipy/HEAD?urlpath=%2Fdoc%2Ftree%2FElasticipy_for_the_Impatient.ipynb).
  
 
-## :mag: Sources
+## 🔍 Sources
 The source code is available on [GitHub](https://github.com/DorianDepriester/Elasticipy) under the [MIT licence](https://github.com/DorianDepriester/Elasticipy/blob/c6c3d441a2d290ab8f4939992d5d753a1ad3bdb0/LICENSE).
 
-## :umbrella: Tests and Code Coverage
+## ☔ Tests and Code Coverage
 
 The project uses unit tests with `pytest` and coverage reports generated using `coverage`. These reports are hosted on 
 [codecov](https://app.codecov.io/gh/DorianDepriester/Elasticipy).
@@ -64,7 +64,7 @@ Certain parts of the code, particularly those related to graphical user interfac
 
 - **`src/Elasticipy/gui.py`**
 
-## :mortar_board: Cite this package
+## 🎓 Cite this package
 If you use Elasticipy, please cite [![DOI](https://joss.theoj.org/papers/10.21105/joss.07940/status.svg)](https://doi.org/10.21105/joss.07940)
 
 You can use the following BibTeX entry:
@@ -78,7 +78,7 @@ You can use the following BibTeX entry:
     number = {115}, 
     pages = {7940}, 
     author = {Depriester, Dorian and Kubler, Régis}, 
-    title = {Elasticipy: A Python package for linear elasticity and tensor analysis}, 
+    title = {elasticipy: A Python package for linear elasticity and tensor analysis}, 
     journal = {Journal of Open Source Software}
 }
 ````

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/API/API.rst

@@ -13,11 +13,3 @@ API documentation
    Elasticipy.spherical_function
    Elasticipy.interfaces.PRISMS
    Elasticipy.interfaces.FEPX
-
-Module contents
----------------
-
-.. automodule:: Elasticipy
-   :members:
-   :undoc-members:
-   :show-inheritance:

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/API/Elasticipy.interfaces.FEPX.rst

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

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/API/Elasticipy.interfaces.PRISMS.rst

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

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/API/Elasticipy.plasticity.rst

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

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/API/Elasticipy.spherical_function.rst

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

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/API/Elasticipy.tensors.elasticity.rst

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

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/API/Elasticipy.tensors.fourth_order.rst

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

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/API/Elasticipy.tensors.mapping.rst

@@ -1,7 +1,7 @@
 Elasticipy.tensors.mapping
 ====================================
 
-.. automodule:: Elasticipy.tensors.mapping
+.. automodule:: elasticipy.tensors.mapping
    :members:
    :undoc-members:
    :show-inheritance:

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/API/Elasticipy.tensors.second_order.rst

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

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/API/Elasticipy.tensors.stress_strain.rst

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

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/API/Elasticipy.tensors.thermal_expansion.rst

@@ -1,7 +1,7 @@
 Elasticipy.tensors.thermal_expansion
 ============================================
 
-.. automodule:: Elasticipy.tensors.thermal_expansion
+.. automodule:: elasticipy.tensors.thermal_expansion
    :members:
    :undoc-members:
    :show-inheritance:

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/Tutorials/FourthOrderTensors.rst

@@ -144,8 +144,8 @@ and
     0 & 0 & 0 & 0 & 0 & 1\\
     \end{bmatrix}
 
-In Elasticpy
-~~~~~~~~~~~~
+In Elasticipy
+~~~~~~~~~~~~~
 
 The Kelvin mapping preserves tensor norms and inner products between second-order tensors. This makes it particularly suitable
 for tensor algebra, projections and eigendecompositions. Therefore, in Elasticipy, the Kelvin mapping is used for all
@@ -156,7 +156,7 @@ For ``FourthOrderTensor`` and ``SymmetricFourthOrderTensor``, the default mappin
 
 .. doctest::
 
-    >>> from Elasticipy.tensors.fourth_order import FourthOrderTensor
+    >>> from elasticipy.tensors.fourth_order import FourthOrderTensor
     >>> I_kelvin = FourthOrderTensor.eye()
     >>> print(I_kelvin)
     4th-order tensor (in Kelvin mapping):
@@ -169,7 +169,7 @@ For ``FourthOrderTensor`` and ``SymmetricFourthOrderTensor``, the default mappin
 
 Still, the Voigt mapping can be used instead:
 
-    >>> from Elasticipy.tensors.mapping import VoigtMapping
+    >>> from elasticipy.tensors.mapping import VoigtMapping
     >>> I_voigt = FourthOrderTensor.eye(mapping=VoigtMapping())
     >>> print(I_voigt)
     4th-order tensor (in Voigt mapping):
@@ -269,7 +269,7 @@ Between 4th and a 2nd -order tensors
 
 The same applies when working with 2nd-order tensors (provided by the ``SecondOrderTensor`` class):
 
-    >>> from Elasticipy.tensors.second_order import SecondOrderTensor
+    >>> from elasticipy.tensors.second_order import SecondOrderTensor
     >>> t = SecondOrderTensor.rand(shape=(4,))
     >>> T1.ddot(t)
     Second-order tensor

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/Tutorials/GUI.rst

@@ -14,5 +14,10 @@ The figure bellow illustrates the Young's modulus of
 
 To launch this GUI, just run::
 
-    from Elasticipy.gui import crystal_elastic_plotter
-    crystal_elastic_plotter()
+    from elasticipy.gui import crystal_elastic_plotter
+    crystal_elastic_plotter()
+
+If you have installed Elasticipy with ``pip`` or ``conda``, just open a terminal (e.g. Powershell or Anaconda prompt)
+and run::
+
+    elasticipy-gui

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/Tutorials/Plasticity.rst

@@ -39,17 +39,17 @@ First, let us create the model:
 
 .. doctest::
 
-    >>> from Elasticipy.plasticity import JohnsonCook
+    >>> from elasticipy.plasticity import JohnsonCook
     >>> JC = JohnsonCook(A=363, B=792.7122, n=0.5756)
 
 The parameters are taken from [1]_. As we will also take elastic behaviour into account, we also need:
 
-    >>> from Elasticipy.tensors.elasticity import StiffnessTensor
+    >>> from elasticipy.tensors.elasticity import StiffnessTensor
     >>> C = StiffnessTensor.isotropic(E=210000, nu=0.27)
 
 Now, let say that we want to investigate the material's response for the tensile stress ranging from 0 to 725 MPa:
 
-    >>> from Elasticipy.tensors.stress_strain import StressTensor, StrainTensor
+    >>> from elasticipy.tensors.stress_strain import StressTensor, StrainTensor
     >>> import numpy as np
     >>> n_step = 100
     >>> stress_mag = np.linspace(0, 725, n_step)
@@ -75,6 +75,7 @@ That's all. Finally, let us plot the applied stress as a function of the overall
     >>> ax.set_xlabel(r'$\varepsilon_{xx}$') # doctest: +SKIP
     >>> ax.set_ylabel('Tensile stress (MPa)') # doctest: +SKIP
 
+
 .. image:: images/Stress-controlled.png
 
 

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/Tutorials/Tutorial_AveragingMethods.rst

@@ -17,7 +17,7 @@ As an example, let's consider the stiffness tensor for monoclinic TiNi:
 
 .. doctest::
 
-    >>> from Elasticipy.tensors.elasticity import StiffnessTensor
+    >>> from elasticipy.tensors.elasticity import StiffnessTensor
     >>> C = StiffnessTensor.monoclinic(phase_name='TiNi',
     ...                                C11=231, C12=127, C13=104,
     ...                                C22=240, C23=131, C33=175,
@@ -33,7 +33,7 @@ behaviour. In this case, the aforementioned averages can be estimated as follows
     >>> C_Reuss = C.Reuss_average()
     >>> C_Hill = C.Hill_average()
 
-    Let's see how ``C_Hill`` looks like:
+Let's see how ``C_Hill`` looks like:
 
     >>> print(C_Hill)
     Stiffness tensor (in Voigt mapping):
@@ -51,7 +51,7 @@ behaviour. In this case, the aforementioned averages can be estimated as follows
        40.66513606]]
     Phase: TiNi
 
-    As a comparison, let's see how the underlying assumption impair the Young moduli:
+As a comparison, let's see how the underlying assumption impair the Young moduli:
 
     >>> E_Voigt = C_Voigt.Young_modulus
     >>> E_Reuss = C_Reuss.Young_modulus
@@ -100,15 +100,27 @@ Above, we have only used the Hill average for estimating the macroscopic elastic
 influence of the method (namely Voigt, Reuss or Hill), we can plot the directional Young moduli on orthogonal
 sections (see :ref:`here<plotting>` for details) for each of the aforementioned methods as follows:
 
-    >>> for method in ['Reuss', 'Hill', 'Voigt']:
-    ...     C_avg = C_rotated.average(method)
-    ...     if method == 'Reuss':
-    ...         fig, axs = C_avg.Young_modulus.plot_xyz_sections(label='Reuss') # Create fig and axes (sections)
-    ...     else:
-    ...         fig, axs = C_avg.Young_modulus.plot_xyz_sections(fig=fig, axs=axs, label=method) # Use existing axes
-    >>> axs[-1].legend() # doctest: +SKIP
-
-which gives:
-
-
-.. image:: images/E_VRH_sections.png
+.. plot::
+
+    from scipy.spatial.transform import Rotation
+    import numpy as np
+    from elasticipy.tensors.elasticity import StiffnessTensor
+    C = StiffnessTensor.monoclinic(phase_name='TiNi',
+                                    C11=231, C12=127, C13=104,
+                                    C22=240, C23=131, C33=175,
+                                    C44=81, C55=11, C66=85,
+                                    C15=-18, C25=1, C35=-3, C46=3)
+    phi1 = np.random.random(10000)*2*np.pi # Random sampling from 0 to 2pi
+    Phi = phi2 = np.zeros(10000)
+    Euler_angles = np.array([phi1, Phi, phi2]).T
+    rotations = Rotation.from_euler('ZXZ', Euler_angles)    # Bunge-Euler angles
+    C_rotated = C * rotations
+    for method in ['Reuss', 'Hill', 'Voigt']:
+         C_avg = C_rotated.average(method)
+         if method == 'Reuss':
+             fig, axs = C_avg.Young_modulus.plot_xyz_sections(label='Reuss') # Create fig and axes (sections)
+         else:
+             fig, axs = C_avg.Young_modulus.plot_xyz_sections(fig=fig, axs=axs, label=method) # Use existing axes
+    axs[-1].legend()
+    fig.tight_layout()
+    fig.show()

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/Tutorials/Tutorial_MultiplePhases.rst

@@ -42,7 +42,7 @@ Let's start by creating the two stiffness tensors in Python:
 
 .. doctest::
 
-    >>> from Elasticipy.tensors.elasticity import StiffnessTensor
+    >>> from elasticipy.tensors.elasticity import StiffnessTensor
     >>> C_austenite = StiffnessTensor.cubic(C11=204, C12=137, C44=126)
     >>> C_ferrite = StiffnessTensor.cubic(C11=242, C12=146, C44=116)
 

{elasticipy-5.0.0 → elasticipy-6.0.1}/docs/source/Tutorials/Tutorial_ReadWriteFiles.rst

@@ -12,11 +12,11 @@ To save a given stiffness tensor to a plain text file, just use the ``save_to_tx
 
 .. doctest::
 
-    >>> from Elasticipy.tensors.elasticity import StiffnessTensor
+    >>> from elasticipy.tensors.elasticity import StiffnessTensor
     >>> C = StiffnessTensor.cubic(C11=186, C12=134, C44=77, phase_name='Cu')
     >>> C.save_to_txt('Stiffness_Cu.txt')
 
-By default, the file will contain the stiffness matrix, and additional data as well (symmetry and phase name). To save
+By default, the file will contain the stiffness matrix, and additional data as well (phase name). To save
 the matrix only, just use the option ``matrix_only=True``.
 
 Load stiffness from file