llg3d 3.0.0__py3-none-any.whl → 3.1.0__py3-none-any.whl

llg3d/__init__.py

@@ -1,4 +1,4 @@
 """Main llg3d package."""
 
-__version__ = "3.0.0"
+__version__ = "3.1.0"
 __all__ = ["__version__"]

llg3d/post/extract.py

@@ -1,18 +1,23 @@
 """
 Extract scalar values from .npz result files.
 
-The extraction paths correspond to the hierarchical structure returned by
-`load_results()` (see io.py), where metrics and observables are JSON-decoded
-and stored under the 'results' key.
+Use the ``llg3d.extract`` command line tool to extract scalar values from .npz result
+files:
 
-Usage:
+.. command-output:: llg3d.extract --help
 
-.. code-block:: sh
 
-    llg3d.extract run.npz params/np results/metrics/total_time
+Extract the total execution time from a ``run.npz`` file:
 
-This will extract the number of processes and total simulation time from the run.npz file.
-Paths are separated by '/' and navigate through nested dictionaries and object attributes.
+.. command-output:: llg3d.extract run.npz results/metrics/total_time
+    :cwd: ../execute
+
+
+Extract both the total execution time and the time per iteration:
+
+.. command-output:: llg3d.extract run.npz results/metrics/total_time \
+    results/metrics/time_per_ite
+    :cwd: ../execute
 """
 
 import argparse
@@ -49,8 +54,10 @@ def _navigate(value: object, levels: list[str]):
 
     return _navigate(next_value, levels[1:])
 
+
 ExtractedValue = float | int | str | bool | np.integer | np.floating
 
+
 def extract_values(npz_file: Path, *keys: str) -> list[ExtractedValue]:
     """
     Extract scalar values from a .npz file.

llg3d/post/info.py

@@ -1,4 +1,18 @@
-"""Dump simulation results from a .npz file."""
+"""
+Dump simulation results from a .npz file.
+
+To browse the content of the ``run.npz`` file, use the ``llg3d.info`` command:
+
+.. command-output:: llg3d.info run.npz
+    :cwd: ../execute/
+
+The numpy arrays cans be previewed with more detailed information using the ``--verbose``
+option:
+
+.. command-output:: llg3d.info run.npz --verbose
+    :cwd: ../execute/
+
+"""
 
 import argparse
 import textwrap

llg3d/post/m1_vs_T.py

@@ -1,4 +1,21 @@
-"""Plot the magnetization vs temperature and determine the Curie temperature."""
+"""
+Plot the magnetization vs temperature and determine the Curie temperature.
+
+Use the ``llg3d.m1_vs_T`` command line tool to plot the average magnetization versus
+temperature from multiple result files:
+
+.. command-output:: llg3d.m1_vs_T -h
+   :cwd: ../execute/temperatures
+
+When calling the tool on a selection of result files:
+
+.. command-output:: llg3d.m1_vs_T run_*.npz -i m1_vs_T.png
+   :cwd: ../execute/temperatures
+   :shell:
+
+.. image:: ../execute/temperatures/m1_vs_T.png
+   :alt: Magnetization versus temperature for multiple files
+"""
 
 from pathlib import Path
 
@@ -82,7 +99,7 @@ def main():  # pragma: no cover
     from .utils import get_cli_args
 
     args = get_cli_args(
-        description=__doc__,
+        description="Plot the magnetization vs temperature and determine the Curie temperature.",
         default_image_filepath=Path("m1_vs_T.png"),
     )
 

llg3d/post/m1_vs_time.py

@@ -1,4 +1,29 @@
-"""Plot m1 vs time from one or more result files."""
+"""
+Plot m1 vs time from one or more result files.
+
+Use the ``llg3d.m1_vs_time`` command line tool to plot the average magnetization versus time from multiple result files:
+
+.. command-output:: llg3d.m1_vs_time -h
+   :cwd: ../execute/temperatures
+
+When calling the tool on a result files:
+
+.. command-output:: llg3d.m1_vs_time run_1100K.npz -i m1_vs_time.png
+   :cwd: ../execute/temperatures
+   :shell:
+
+.. image:: ../execute/temperatures/m1_vs_time.png
+   :alt: Magnetization versus time for a single file
+
+Now when calling the tool on a selection of result files:
+
+.. command-output:: llg3d.m1_vs_time run_*.npz -i m1_vs_time_multiple.png
+   :cwd: ../execute/temperatures
+   :shell:
+
+.. image:: ../execute/temperatures/m1_vs_time_multiple.png
+   :alt: Magnetization versus time for multiple files
+"""
 
 from pathlib import Path
 
@@ -45,7 +70,7 @@ def plot_m1_vs_time(
 def main():  # pragma: no cover
     """Parse CLI arguments and call the plot function."""
     args = get_cli_args(
-        description=__doc__,
+        description="Plot m1 vs time from one or more result files.",
         default_image_filepath=Path("m1_vs_time.png"),
     )
 

llg3d/post/x_profiles.py

@@ -1,4 +1,24 @@
-"""Plot x-profiles of magnetization from a result file."""
+"""
+Plot x-profiles of magnetization from a result file.
+
+Use the ``llg3d.x_profiles`` command line tool to plot the x-profiles of magnetization
+from a result file:
+
+.. command-output:: llg3d.x_profiles -h
+   :cwd: ../execute/domain_wall
+
+See :doc:`here </execute/domain_wall/index>` for how to generate the ``run.npz`` file
+used in this example.
+
+When calling the tool on a result file:
+
+.. command-output:: llg3d.x_profiles run.npz -m 1 -t ::4 -i x_profiles_4.png
+   :cwd: ../execute/domain_wall
+   :shell:
+
+.. image:: ../execute/domain_wall/x_profiles_4.png
+   :alt: Longitudinal profiles of magnetization
+"""
 
 import argparse
 from pathlib import Path
@@ -128,7 +148,7 @@ def get_cli_args(
 def main():  # pragma: no cover
     """Parse CLI arguments and call the plot function."""
     args = get_cli_args(
-        description=__doc__,
+        description="Plot x-profiles of magnetization from a result file.",
         default_image_filepath=Path("x_profile.png"),
     )
 

{llg3d-3.0.0.dist-info → llg3d-3.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: llg3d
-Version: 3.0.0
+Version: 3.1.0
 Summary: A solver for the stochastic Landau-Lifshitz-Gilbert equation in 3D
 Author-email: Clémentine Courtès <clementine.courtes@math.unistra.fr>, Matthieu Boileau <matthieu.boileau@math.unistra.fr>
 Project-URL: Homepage, https://gitlab.math.unistra.fr/llg3d/llg3d

{llg3d-3.0.0.dist-info → llg3d-3.1.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-llg3d/__init__.py,sha256=MssuCTRN-5px2s7MXHPvkp4Mo7HxaGQ_Hsy2HW9bg8Q,75
+llg3d/__init__.py,sha256=WFiJ87Ng-E_9zla-6KjvxFzq8xI8SluspEH02TTQgvM,75
 llg3d/__main__.py,sha256=3D1q7AG5vU6gr-V0iuo5oNYl-Og2SvJ4YaBTdqOVVaw,115
 llg3d/element.py,sha256=GnafEd8vrDr59ixi05zyMesUCUAFhFccdZ-I1y-NAlA,7259
 llg3d/grid.py,sha256=iaT8QUZPAjt1fD39H64-c4EF4SY-qt4406pbHlO8l0s,4158
@@ -11,13 +11,13 @@ llg3d/benchmarks/compare_commits.py,sha256=9fY6RMXlEfDKKvz4D5NO3jtuf4JB26zIF5L9m
 llg3d/benchmarks/efficiency.py,sha256=PrDE3KxVAtWVRotcod0CiegQ_2PZa6qI9ByRRadHq7s,15461
 llg3d/benchmarks/utils.py,sha256=XSECFgoquWu7LcgCsPYx5YG3CtRlPHXUewMPGthP5wY,708
 llg3d/post/__init__.py,sha256=S4UiquBtCm_iHQ0vaU0E4T69TZfhiYq7i26AOz7Vs40,29
-llg3d/post/extract.py,sha256=73FWYE1-HYLzU1tjjAOvhHrZFe6SVLMLa78jJxgz0pM,3301
-llg3d/post/info.py,sha256=7dAWsfO9IkCkiWgBVxVm36Y3rK78PBzL_rb6LuajANU,5232
-llg3d/post/m1_vs_T.py,sha256=t7HAPlcH_v1iLmbFplhZRmHRVoQLSA9t287ITZ47Fhw,2715
-llg3d/post/m1_vs_time.py,sha256=6ynl4OK4lPPDLnhY_k-qSBovldO4Wa95-Z8LfiohIr0,1507
+llg3d/post/extract.py,sha256=45J2mfVU6wR2j-Vr_fNoouQsr65aRWG4knZ-B4L_pFQ,3321
+llg3d/post/info.py,sha256=sCaGJR7nxqrpWjZMINWFJR8unZ83ISCtrfP-URKCUIE,5548
+llg3d/post/m1_vs_T.py,sha256=WZK1wL66yGOFZgKcgESA564V7qwzNMSAlTTu16APNw8,3251
+llg3d/post/m1_vs_time.py,sha256=VtwyAAjuUPQO2Kl1H-5DeOwS5xj_DdUo6wi5rs9VDxo,2298
 llg3d/post/process.py,sha256=usvRLnvHDqaV3EKiP6il3se7ha_G_PHVS0LP_8c87KM,3845
 llg3d/post/utils.py,sha256=oZBYbPhJJYzHsRrnENyxmZotylLlYVOOFePr3zc-Fo0,1114
-llg3d/post/x_profiles.py,sha256=pexMn2hUPPNvdTOsc5ilXm6JN3zlV5xu4xU2LXXOp4I,3993
+llg3d/post/x_profiles.py,sha256=wRTz7IDrM_3A-259SV-SduU8-n0mmS_EFUYsalwz-OE,4594
 llg3d/solvers/__init__.py,sha256=aNn3LjP1nDZj7PqJ_KGxY3hj-BDa-RrOcE00DnjLgDk,3436
 llg3d/solvers/base.py,sha256=cucNTqBSbl9MgArGbmlYORKPWrsJFuZRQCZYgACuj8U,11879
 llg3d/solvers/math_utils.py,sha256=F1uwrfNCg0tCLlkXKoMFHcOaSFsIrrvzO768IpfvZx4,1014
@@ -27,10 +27,10 @@ llg3d/solvers/opencl.py,sha256=i7y50uQ8bV5EcV3PDcEvJoPo3Qt6pvAq_awy7mgHDGk,15190
 llg3d/solvers/profiling.py,sha256=B5PgxtE3xCcv7Qi51VVYAToBzR5HwjS4j9LPKg1ajyc,991
 llg3d/solvers/experimental/__init__.py,sha256=F4smHsF9_hR5KXIsh6Xd46sSzJE6N7yFuH0vmj0ygGA,147
 llg3d/solvers/experimental/jax.py,sha256=FrcdQYMVroPbYBbqvZMPIH9gv8n-PkT2vdUO5u5aYHg,11249
-llg3d-3.0.0.dist-info/licenses/AUTHORS,sha256=vhJ88HikYvOrGiB_l1xH2X6hyn9ZJafx6mpoMYNhh1I,297
-llg3d-3.0.0.dist-info/licenses/LICENSE,sha256=aFxTGAyyve8nM9T2jWTarJzQhdSSC3MbbN1heNAev9c,1062
-llg3d-3.0.0.dist-info/METADATA,sha256=dD3kJMCX07AFNIHAud5mEILEzBzdNZLfvaK065sH9FM,2030
-llg3d-3.0.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-llg3d-3.0.0.dist-info/entry_points.txt,sha256=28japzG2aS2e_J42LXw7SAK4ufbG22LGHcI2D6zVz9Y,374
-llg3d-3.0.0.dist-info/top_level.txt,sha256=cBZ0roaXt3CAXqYojuO84lGPCtWuLlXxLGLYRKmHZy0,6
-llg3d-3.0.0.dist-info/RECORD,,
+llg3d-3.1.0.dist-info/licenses/AUTHORS,sha256=vhJ88HikYvOrGiB_l1xH2X6hyn9ZJafx6mpoMYNhh1I,297
+llg3d-3.1.0.dist-info/licenses/LICENSE,sha256=aFxTGAyyve8nM9T2jWTarJzQhdSSC3MbbN1heNAev9c,1062
+llg3d-3.1.0.dist-info/METADATA,sha256=s7tmZU9PdngZQW7gDRP-AgokwiI-oAhjc33U9UC1oiY,2030
+llg3d-3.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+llg3d-3.1.0.dist-info/entry_points.txt,sha256=28japzG2aS2e_J42LXw7SAK4ufbG22LGHcI2D6zVz9Y,374
+llg3d-3.1.0.dist-info/top_level.txt,sha256=cBZ0roaXt3CAXqYojuO84lGPCtWuLlXxLGLYRKmHZy0,6
+llg3d-3.1.0.dist-info/RECORD,,