.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "api/gallery/chaos/advanced/plot_serialization.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_api_gallery_chaos_advanced_plot_serialization.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_api_gallery_chaos_advanced_plot_serialization.py:


Saving and Loading Results
================================

Long simulations (a fine basin-of-attraction grid, a long Lyapunov-spectrum
integration, a large parameter sweep) are worth keeping around instead of
recomputing. :mod:`physicskit.chaos.utils.io` provides two small, generic building
blocks for this: :func:`~physicskit.chaos.utils.io.save_system_config` /
:func:`~physicskit.chaos.utils.io.load_system_config` round-trip a system's class and
constructor parameters through JSON (using the same ``__init__``
introspection that already powers every system's ``repr()``), and
:func:`~physicskit.chaos.utils.io.save_arrays` / :func:`~physicskit.chaos.utils.io.load_arrays`
save any named arrays (a trajectory, a basin grid, a Poincare section) to a
plain ``.npz`` archive. The system used to demonstrate this is the Lorenz
attractor,

.. math::

    \dot{x} = \sigma (y - x), \qquad \dot{y} = x (\rho - z) - y, \qquad
    \dot{z} = x y - \beta z,

with the classic parameters :math:`\sigma=10`, :math:`\rho=28`,
:math:`\beta=8/3` -- but the save/load round-trip below works identically
for any :class:`~physicskit.chaos.core.base_system.DynamicalSystem`.

.. GENERATED FROM PYTHON SOURCE LINES 26-37

.. code-block:: Python


    from __future__ import annotations

    import tempfile
    from pathlib import Path

    import matplotlib.pyplot as plt

    from physicskit.chaos.systems.continuous import Lorenz
    from physicskit.chaos.utils.io import load_arrays, load_system_config, save_arrays, save_system_config








.. GENERATED FROM PYTHON SOURCE LINES 38-43

Saving a system's configuration
-----------------------------------
Only the class and its constructor parameters are saved -- not the
trajectory itself -- so the file is tiny and the system can be
re-integrated identically (or with different `n_steps`/`dt`) later.

.. GENERATED FROM PYTHON SOURCE LINES 43-53

.. code-block:: Python

    tmp_dir = Path(tempfile.mkdtemp())
    system = Lorenz(sigma=10.0, rho=28.0, beta=8.0 / 3.0)
    config_path = tmp_dir / "lorenz_config.json"
    save_system_config(system, config_path)
    print(config_path.read_text())

    restored = load_system_config(config_path)
    print(f"restored: {restored!r}")
    assert restored.sigma == system.sigma and restored.rho == system.rho





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    {
      "module": "physicskit.chaos.systems.continuous",
      "class": "Lorenz",
      "params": {
        "sigma": 10.0,
        "rho": 28.0,
        "beta": 2.6666666666666665
      }
    }
    restored: Lorenz(sigma=10.0, rho=28.0, beta=2.6666666666666665)




.. GENERATED FROM PYTHON SOURCE LINES 54-58

Saving trajectory data
---------------------------
`save_arrays` accepts any set of named arrays and stores them together in
one ``.npz`` file; `load_arrays` hands them back as a plain dict.

.. GENERATED FROM PYTHON SOURCE LINES 58-72

.. code-block:: Python

    t, states = restored.trajectory(n_steps=5000, dt=0.01)
    data_path = tmp_dir / "lorenz_run.npz"
    save_arrays(data_path, t=t, states=states)

    loaded = load_arrays(data_path)
    print(f"loaded arrays: {list(loaded.keys())}, states shape = {loaded['states'].shape}")

    fig, ax = plt.subplots(figsize=(6, 5))
    ax.plot(loaded["states"][:, 0], loaded["states"][:, 2], lw=0.4)
    ax.set_xlabel("x")
    ax.set_ylabel("z")
    ax.set_title("Trajectory reloaded from disk, unchanged")

    plt.show()



.. image-sg:: /api/gallery/chaos/advanced/images/sphx_glr_plot_serialization_001.png
   :alt: Trajectory reloaded from disk, unchanged
   :srcset: /api/gallery/chaos/advanced/images/sphx_glr_plot_serialization_001.png
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    loaded arrays: ['t', 'states'], states shape = (5001, 3)





.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.241 seconds)


.. _sphx_glr_download_api_gallery_chaos_advanced_plot_serialization.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_serialization.ipynb <plot_serialization.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_serialization.py <plot_serialization.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_serialization.zip <plot_serialization.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_