LightWin 0.9.1__tar.gz → 0.9.2__tar.gz

{lightwin-0.9.1 → lightwin-0.9.2}/.pre-commit-config.yaml

@@ -3,6 +3,7 @@ repos:
     rev: "v5.0.0"
     hooks:
       - id: check-added-large-files
+        exclude: "docs/manual/notebooks/example.ipynb"
       - id: check-case-conflict
       - id: check-docstring-first
       - id: check-executables-have-shebangs

{lightwin-0.9.1 → lightwin-0.9.2}/CHANGELOG.md

@@ -10,6 +10,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 Adhere to development best practices.
 In particular, follow advices listed in the great [Scientific Python library development guide](https://learn.scientific-python.org/development/).
 
+
+## [0.9.2] -- 2025-04-07
+
+### Added
+
+- Type hints for the `.get` methods.
+- Notebook example to showcase how LightWin can be used.
+- You can give `matplotlib.axes.Axes.plot` kwargs in the `plots` TOML section.
+
 ## [0.9.1] -- 2025-01-30
 
 ### Added

{lightwin-0.9.1 → lightwin-0.9.2}/CITATION.cff

@@ -2,8 +2,8 @@ cff-version: 1.2.0
 message: "If you use this software, please cite it as below."
 title: "LightWin"
 abstract: A tool dedicated to finding cavity failure compensation settings in linacs.
-version: 0.9.0
-date-released: "2025-01-21"
+version: 0.9.1
+date-released: '2025-01-30'
 authors:
   - family-names: Plaçais
     given-names: Adrien

{lightwin-0.9.1/src/LightWin.egg-info → lightwin-0.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: LightWin
-Version: 0.9.1
+Version: 0.9.2
 Summary: Automatically compensate cavity failures in linacs
 Author-email: Adrien Plaçais <placais@lpsc.in2p3.fr>, Bruce Yee-Rendon <byee@post.j-parc.jp>, Didier Uriot <didier.uriot@cea.fr>, Frédéric Bouly <bouly@lpsc.in2p3.fr>, Jean-Michel Lagniel <jean-michel.lagniel@ganil.fr>
 Project-URL: changelog, https://github.com/AdrienPlacais/LightWin/blob/main/CHANGELOG.md
@@ -27,17 +27,20 @@ Requires-Dist: pre-commit<5,>=4
 Requires-Dist: pymoo<1,>=0.6.1.3
 Requires-Dist: scipy<2,>=1.14
 Provides-Extra: docs
-Requires-Dist: sphinx-rtd-theme<4,>=3; extra == "docs"
-Requires-Dist: sphinxcontrib-bibtex<3,>=2.6; extra == "docs"
 Requires-Dist: myst-parser<5,>=4; extra == "docs"
 Requires-Dist: nbsphinx<1,>=0.9.6; extra == "docs"
 Requires-Dist: sphinx-autodoc-typehints<4,>=3.0.1; extra == "docs"
+Requires-Dist: sphinx-rtd-theme<4,>=3; extra == "docs"
+Requires-Dist: sphinx-tabs<4,>=3.4; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex<3,>=2.6; extra == "docs"
 Provides-Extra: test
 Requires-Dist: pytest<9,>=8.3.2; extra == "test"
+Dynamic: license-file
 
 [![Py versions](https://img.shields.io/badge/python-3.12-blue)](https://img.shields.io/badge/python-3.12-blue)
-[![build status](https://github.com/AdrienPlacais/LightWin/actions/workflows/main.yml/badge.svg)](https://github.com/AdrienPlacais/LightWin/actions/workflows/main.yml)
-[![Documentation Status](https://readthedocs.org/projects/lightwin/badge/?version=latest)](https://lightwin.readthedocs.io/en/latest/?badge=latest)
+[![PyPi](https://img.shields.io/pypi/v/lightwin)](https://pypi.org/project/LightWin/)
+[![Pytest](https://img.shields.io/badge/py-test-blue?logo=pytest)](https://github.com/AdrienPlacais/LightWin/actions/workflows/test.yml)
+[![Documentation status](https://readthedocs.org/projects/lightwin/badge/?version=latest)](https://lightwin.readthedocs.io/en/latest/?badge=latest)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/AdrienPlacais/LightWin/main.svg)](https://results.pre-commit.ci/latest/github/AdrienPlacais/LightWin/main)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

{lightwin-0.9.1 → lightwin-0.9.2}/README.md

@@ -1,6 +1,7 @@
 [![Py versions](https://img.shields.io/badge/python-3.12-blue)](https://img.shields.io/badge/python-3.12-blue)
-[![build status](https://github.com/AdrienPlacais/LightWin/actions/workflows/main.yml/badge.svg)](https://github.com/AdrienPlacais/LightWin/actions/workflows/main.yml)
-[![Documentation Status](https://readthedocs.org/projects/lightwin/badge/?version=latest)](https://lightwin.readthedocs.io/en/latest/?badge=latest)
+[![PyPi](https://img.shields.io/pypi/v/lightwin)](https://pypi.org/project/LightWin/)
+[![Pytest](https://img.shields.io/badge/py-test-blue?logo=pytest)](https://github.com/AdrienPlacais/LightWin/actions/workflows/test.yml)
+[![Documentation status](https://readthedocs.org/projects/lightwin/badge/?version=latest)](https://lightwin.readthedocs.io/en/latest/?badge=latest)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/AdrienPlacais/LightWin/main.svg)](https://results.pre-commit.ci/latest/github/AdrienPlacais/LightWin/main)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

{lightwin-0.9.1 → lightwin-0.9.2}/data/example/lightwin.toml

@@ -4,7 +4,7 @@ project_folder = "results_tests/"
 
 [generic_envelope1d]
 export_phase = "phi_0_abs"
-flag_cython = false
+flag_cython = true
 flag_phi_abs = true
 method = "RK4"
 n_steps_per_cell = 40
@@ -41,7 +41,7 @@ sigma = [
 [generic_wtf]
 failed = [["FM11"]]
 id_nature = "name"
-k = 3
+k = 5
 objective_preset = "simple_ADS"
 optimisation_algorithm = "downhill_simplex"
 optimisation_algorithm_kwargs = { options = { disp = false, adaptive = true } }

{lightwin-0.9.1 → lightwin-0.9.2}/data/example/run_lightwin.py

@@ -66,9 +66,9 @@ if __name__ == "__main__":
         "files": "files",
         "plots": "plots_minimal",
         "beam_calculator": "generic_envelope1d",
-        "beam_calculator_post": "generic_tracewin",
+        # "beam_calculator_post": "generic_tracewin",
         "beam": "beam",
-        "wtf": "save_wtf",
+        "wtf": "generic_wtf",
         "design_space": "fit_phi_s_design_space",
         # "design_space": "tiny_design_space",
     }
@@ -76,8 +76,8 @@ if __name__ == "__main__":
     BEAUTY_PASS = False
     config = process_config(toml_filepath, toml_keys)
     # my_objective_factory = MyObjectiveFactory
-    my_objective_factory = EnergyPhaseMismatchMoreElements
+    # my_objective_factory = EnergyPhaseMismatchMoreElements
     fault_scenarios = run_simulation(
         config,
-        objective_factory_class=my_objective_factory,
+        # objective_factory_class=my_objective_factory,
     )

{lightwin-0.9.1 → lightwin-0.9.2}/docs/conf.py

@@ -31,10 +31,8 @@ import lightwin
 sys.path.append(os.path.abspath("./_ext"))
 
 project = "LightWin"
-copyright = (
-    "2025, A. Plaçais, F. Bouly, J.-M. Lagniel, D. Uriot, B. Yee-Rendon"
-)
 author = "A. Plaçais, F. Bouly, J.-M. Lagniel, D. Uriot, B. Yee-Rendon"
+copyright = "2025, " + author
 
 # See https://protips.readthedocs.io/git-tag-version.html
 # The full version, including alpha/beta/rc tags.
@@ -47,16 +45,18 @@ version = lightwin.__version__
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
-    "sphinxcontrib.bibtex",  # Integrate citations
-    "sphinx.ext.napoleon",  # handle numpy style
-    "sphinx.ext.autodoc",
-    "sphinx_rtd_theme",  # ReadTheDocs theme
+    "lightwin_sphinx_extensions",
     "myst_parser",
-    "sphinx.ext.intersphinx",  # interlink with other docs, such as numpy
-    "sphinx.ext.todo",  # allow use of TODO
     "nbsphinx",
-    "lightwin_sphinx_extensions",
-    "sphinx_autodoc_typehints",  # Printing types in docstrings not necessary anymore
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinx_autodoc_typehints",
+    "sphinx_rtd_theme",
+    "sphinx_tabs.tabs",
+    "sphinxcontrib.bibtex",
 ]
 
 autodoc_default_options = {
@@ -88,6 +88,11 @@ nitpick_ignore = [
     # Not recognized by Sphinx, don't know if this is normal
     ("py:class", "optional"),
     ("py:class", "T"),
+    ("py:class", "numpy.float64"),
+    ("py:class", "numpy.typing.NDArray"),
+    ("py:class", "NDArray[np.float64]"),
+    ("py:class", "NDArray"),
+    ("py:class", "np.float64"),
     # pymoo fixes should be temporary
     ("py:class", "ElementwiseProblem"),
     ("py:class", "pymoo.core.algorithm.Algorithm"),
@@ -109,8 +114,6 @@ nitpick_ignore = [
     ("py:class", "ref_value_t"),
     ("py:class", "tester_t"),
     ("py:class", "value_t"),
-    ("py:class", "REFERENCE_T"),
-    ("py:class", "STATUS_T"),
 ]
 
 # Link to other libraries
@@ -122,11 +125,14 @@ intersphinx_mapping = {
     "scipy": ("https://docs.scipy.org/doc/scipy/", None),
 }
 
-
+autodoc_type_aliases = {
+    "np.float64": "numpy.float64",
+    "NDArray": "numpy.typing.NDArray",
+}
 # Parameters for sphinx-autodoc-typehints
 always_document_param_types = True
-always_use_bar_union = True
-# typehints_defaults = "braces-after"
+always_use_bars_union = True
+typehints_defaults = "comma"
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
@@ -151,3 +157,8 @@ def object_description(obj: object) -> str:
 
 
 inspect.object_description = object_description
+
+# -- Shortcuts ---------------------------------------------------
+rst_prolog = """
+.. |axplot| replace:: :meth:`matplotlib.axes.Axes.plot`
+"""

lightwin-0.9.2/docs/lightwin/lightwin.data.ads.rst

@@ -0,0 +1,7 @@
+ads package
+=========================
+
+.. automodule:: lightwin.data.ads
+   :members:
+   :undoc-members:
+   :show-inheritance:

lightwin-0.9.2/docs/lightwin/lightwin.data.instructions_test.rst

@@ -0,0 +1,7 @@
+instructions\_test package
+========================================
+
+.. automodule:: lightwin.data.instructions_test
+   :members:
+   :undoc-members:
+   :show-inheritance:

lightwin-0.9.2/docs/lightwin/lightwin.data.rst

@@ -0,0 +1,16 @@
+data package
+=====================
+
+.. automodule:: lightwin.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 5
+
+   lightwin.data.ads
+   lightwin.data.instructions_test

{lightwin-0.9.1 → lightwin-0.9.2}/docs/lightwin/lightwin.optimisation.algorithms.rst

@@ -21,4 +21,3 @@ Submodules
    lightwin.optimisation.algorithms.least_squares
    lightwin.optimisation.algorithms.least_squares_penalty
    lightwin.optimisation.algorithms.nsga
-   lightwin.optimisation.algorithms.pso

{lightwin-0.9.1 → lightwin-0.9.2}/docs/lightwin/lightwin.rst

@@ -15,6 +15,7 @@ Subpackages
    lightwin.beam_calculation
    lightwin.config
    lightwin.core
+   lightwin.data
    lightwin.evaluator
    lightwin.failures
    lightwin.optimisation

{lightwin-0.9.1 → lightwin-0.9.2}/docs/lightwin/lightwin.util.rst

@@ -22,3 +22,4 @@ Submodules
    lightwin.util.phases
    lightwin.util.pickling
    lightwin.util.synchronous_phases
+   lightwin.util.typing

lightwin-0.9.2/docs/lightwin/lightwin.util.typing.rst

@@ -0,0 +1,7 @@
+typing module
+===========================
+
+.. automodule:: lightwin.util.typing
+   :members:
+   :undoc-members:
+   :show-inheritance:

lightwin-0.9.1/docs/manual/configuration.optimisation.design_space.rst → lightwin-0.9.2/docs/manual/configuration.design_space.rst

@@ -1,4 +1,4 @@
-``optimisation.design_space`` section
+``design_space`` section
 *************************************
 .. toctree::
    :maxdepth: 5
@@ -14,10 +14,10 @@ This approach is easier to use for the first runs.
    :widths: 30, 5, 50, 10, 5
    :header-rows: 1
 
-When ``from_file`` is ``True``, you must provide a path to a ``.csv`` file containing, for every element, every variable, its initial value and limits.
-If the problem is constrained, you must also provide a ``.csv`` with, for every element, the limits of every constraint.
-This approach is more useful when you want to fine-tune the optimisation, as you can manually edit the ``.csv``, for example to take into account the specific multipacting barriers of a rogue cavity. 
-To generate the ``.csv`` files with the proper format, look at ``examples/generate_design_space_files.py``.
+When ``from_file`` is ``True``, you must provide a path to a `CSV` file containing, for every element, every variable, its initial value and limits.
+If the problem is constrained, you must also provide a `CSV` with, for every element, the limits of every constraint.
+This approach is more useful when you want to fine-tune the optimisation, as you can manually edit the `CSV`, for example to take into account the specific multipacting barriers of a rogue cavity. 
+To generate the `CSV` files with the proper format, look at ``examples/generate_design_space_files.py``.
 
 .. csv-table::
    :file: configuration_entries/design_space_from_file.csv

{lightwin-0.9.1 → lightwin-0.9.2}/docs/manual/configuration.rst

@@ -9,10 +9,10 @@ Configuration
    configuration.beam_calculator
    configuration.plots
    configuration.wtf
-   configuration.optimisation.design_space
+   configuration.design_space
    configuration.evaluators
 
-Most of the configuration of LightWin is performed through a ``.toml`` configuration file, which should be given as argument to several objects initialisation.
+Most of the configuration of LightWin is performed through a `TOML` configuration file, which should be given as argument to several objects initialisation.
 The configuration file is treated with the help of the `tomllib <https://docs.python.org/3/library/tomllib.html>`_ module.
 It is processed by the :func:`.config.config_manager.process_config` function, which checks its validity and converts it to a dictionary.
 

{lightwin-0.9.1 → lightwin-0.9.2}/docs/manual/configuration_entries/beam_calculator_envelope_1d.csv

@@ -1,5 +1,5 @@
 Entry,Type,Description,Allowed values,Mandatory?
-export_phase,``str``,"The type of phases that should be exported in the final DAT file. Note that ``'as_in_original_dat'`` is not implemented yet, but ``'as_in_settings'`` should behave the same way, provided that you alter no FieldMap.CavitySettings.reference attribute.","('phi_0_abs', 'phi_0_rel', 'phi_s', 'as_in_settings', 'as_in_original_dat')",❌
+export_phase,``str``,"The type of phases that should be exported in the final DAT file. Note that ``'as_in_original_dat'`` is not implemented yet, but ``'as_in_settings'`` should behave the same way, provided that you alter no FieldMap.CavitySettings.reference attribute.","('as_in_original_dat', 'as_in_settings', 'phi_0_abs', 'phi_0_rel', 'phi_s')",❌
 flag_cython,``bool``,If we should use the Cython implementation (faster).,,❌
 flag_phi_abs,``bool``,If the field maps phases should be absolute (no implicit rephasing after a failure).,,❌
 method,``str``,Integration method.,"('RK4', 'leapfrog')",❌

{lightwin-0.9.1 → lightwin-0.9.2}/docs/manual/configuration_entries/beam_calculator_envelope_3d.csv

@@ -1,5 +1,5 @@
 Entry,Type,Description,Allowed values,Mandatory?
-export_phase,``str``,"The type of phases that should be exported in the final DAT file. Note that ``'as_in_original_dat'`` is not implemented yet, but ``'as_in_settings'`` should behave the same way, provided that you alter no FieldMap.CavitySettings.reference attribute.","('phi_0_abs', 'phi_0_rel', 'phi_s', 'as_in_settings', 'as_in_original_dat')",❌
+export_phase,``str``,"The type of phases that should be exported in the final DAT file. Note that ``'as_in_original_dat'`` is not implemented yet, but ``'as_in_settings'`` should behave the same way, provided that you alter no FieldMap.CavitySettings.reference attribute.","('as_in_original_dat', 'as_in_settings', 'phi_0_abs', 'phi_0_rel', 'phi_s')",❌
 flag_cython,``bool``,Not implemented yet. If we should use the Cython implementation (faster).,"(False,)",❌
 flag_phi_abs,``bool``,If the field maps phases should be absolute (no implicit rephasing after a failure).,,❌
 method,``str``,Integration method.,"('RK4',)",❌

{lightwin-0.9.1 → lightwin-0.9.2}/docs/manual/configuration_entries/beam_calculator_tracewin.csv

@@ -34,7 +34,7 @@ etnx1,``float``,Input XX’ emittance (mm.mrad) of main beam,,❌
 etnx2,``float``,Input XX’ emittance (mm.mrad) of second beam,,❌
 etny1,``float``,Input YY’ emittance (mm.mrad) of main beam,,❌
 etny2,``float``,Input YY’ emittance (mm.mrad) of second beam,,❌
-export_phase,``str``,"The type of phases that should be exported in the final DAT file. Note that ``'as_in_original_dat'`` is not implemented yet, but ``'as_in_settings'`` should behave the same way, provided that you alter no FieldMap.CavitySettings.reference attribute.","('phi_0_abs', 'phi_0_rel', 'phi_s', 'as_in_settings', 'as_in_original_dat')",❌
+export_phase,``str``,"The type of phases that should be exported in the final DAT file. Note that ``'as_in_original_dat'`` is not implemented yet, but ``'as_in_settings'`` should behave the same way, provided that you alter no FieldMap.CavitySettings.reference attribute.","('as_in_original_dat', 'as_in_settings', 'phi_0_abs', 'phi_0_rel', 'phi_s')",❌
 freq1,``float``,Input beam frequency (MHz) of main beam,,❌
 freq2,``float``,Input beam frequency (MHz) of second beam,,❌
 hide,``bool``,"Hide the GUI, or cancel console output (no parameter).",,✅

{lightwin-0.9.1 → lightwin-0.9.2}/docs/manual/examples.rst

@@ -6,4 +6,5 @@ Examples
 .. toctree::
    :maxdepth: 4
 
+   notebooks/example.ipynb
    notebooks/absolute_vs_relative_phases.ipynb

lightwin-0.9.2/docs/manual/installation.building.rst

@@ -0,0 +1,44 @@
+Building from source (for developers)
+-------------------------------------
+
+Pre-requisites:
+
+* Python 3.12 or higher.
+* A C++ compiler. On Unix systems, install `gcc`. On Windows, check :ref:`here<windows_c_compiler>`.
+
+Cloning the repository
+^^^^^^^^^^^^^^^^^^^^^^
+
+Download the source from GitHub.
+
+.. code-block:: bash
+
+   git clone git@github.com:AdrienPlacais/LightWin.git
+
+Alternatively, you can download the code as a `.zip` file from the repository's page.
+However, please note that using this method requires manually downloading updates whenever changes are made to the repository.
+
+Installation
+^^^^^^^^^^^^
+
+Navigate to the `LightWin` folder.
+Create and activate a Python environment (see :ref:`instructions<simple-installation>`).
+Install and test with:
+
+.. code-block:: bash
+
+   pip install -e .[test]
+   pytest -m "not tracewin"
+
+Setting up TraceWin requires :ref:`additional steps<installation-tracewin>`.
+
+.. hint::
+   If you encounter issues with the `[test]` extra dependency, try escaping the brackets:
+   
+   .. code-block:: bash
+   
+      pip install -e .\[test\]
+
+If you want to install LightWin with `conda`, you will have to `manually`_ install all the dependencies listed in the `pyproject.toml` file.
+
+.. _manually: https://github.com/conda/conda/issues/12462

{lightwin-0.9.1 → lightwin-0.9.2}/docs/manual/installation.cython.rst

@@ -1,56 +1,56 @@
+.. _Cython-setup:
+
+
 Cython setup (should be automatic)
 ----------------------------------
 
 .. note::
-   If you installed LightWin with `pip install -e .` and there was no error, you do not need to read this section.
-   You can check that everything works as expected by running `pytest -m cython`.
+   If you installed LightWin with `pip` and there was no error, you do not need to read this section.
+   If you built the code from source, you can check that everything works as expected with `pytest -m cython`.
 
 Cython is an optional but highly recommended tool to speed up beam dynamics calculations.
 Here's how to properly install and use Cython with the project:
 
-1. Installing Cython
-^^^^^^^^^^^^^^^^^^^^
+1. Pre-requisites
+^^^^^^^^^^^^^^^^^
 Ensure Cython is installed before installing other packages like `pymoo` to take full advantage of its capabilities:
 
- * Using `pip`:
- 
-    .. code-block:: bash
-       
-       pip install cython
- 
- * Using `conda`:
- 
-    .. code-block:: bash
-       
-       conda install cython -c conda-forge
-     
+ .. code-block:: bash
+    
+    pip install cython
+
+You should have Python installed in your `PATH`, and a `C` compiler.
+While the compiler should be available on Unix systems, you will have to install `Microsoft Build Tools for Visual Studio` (`C++ build tools` component) on Windows.
+Check :ref:`this link<windows_c_compiler>` for instructions.
 
 2. Compiling Cython modules
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Some parts of LightWin, in particular the :class:`.Envelope1D` beam calculator, have Cython-optimized code that need to be optimized.
-Follow this steps to compile the modules:
+Some parts of LightWin, in particular the :class:`.CyEnvelope1D` beam calculator, have Cython-optimized code that need to be compiled.
+Navigate to the LightWin directory and run:
 
- 1. Navigate to the `LightWin` base directory:
- 
- .. code-block:: bash
- 
-    cd /path/to/LightWin/
- 
- 2. Run the `setup` script:
- 
- .. code-block:: bash
+.. tabs::
+
+   .. tab:: Unix systems
+
+      .. code-block:: bash
+
+         make compile
+
+   .. tab:: Windows
+
+      .. code-block:: bash
+
+         python setup.py build_ext --inplace
  
-    python setup.py build_ext --inplace
-   
 This command compiles the Cython files and places the compiled modules (`.pyd` or `.so` extensions) in the appropriate directories.
 
 
 3. Handling compiled files
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
-After compilation, the compiled files should be automatically places in the correct locations.
+After compilation, the compiled files should be automatically placed in the correct locations.
 If not, manually move the created files:
 
-   * Unix (Linux/macOS): `build/lib.linux-XXX-cpython=3XX/beam_calculation/cy_envelope_1d/transfer_matrices.cpython-3XX-XXXX-linux-gnu.so`
+   * Unix (Linux/macOS): `build/lib.linux-XXX-cpython-3XX/beam_calculation/cy_envelope_1d/transfer_matrices.cpython-3XX-XXXX-linux-gnu.so`
    * Windows: `build/lib.win-XXXX-cpython-3XX/beam_calculation/cy_envelope_1d/transfer_matrices.cp3XX-win_XXXX.pyd`
 
 To:

lightwin-0.9.2/docs/manual/installation.pypi.rst

@@ -0,0 +1,70 @@
+.. _simple-installation:
+
+Simple installation (recommended)
+---------------------------------
+
+You will need Python 3.12 or higher.
+If you run a 32-bits Windows system, you will also need a :ref:`C compiler<windows_c_compiler>`.
+Set up a virtual environment; instructions will vary according to you installation.
+
+.. tabs::
+
+   .. tab:: venv (Recommended)
+
+      Python's built-in `venv` module is the recommended way to create a virtual environment.
+
+      .. code-block:: bash
+
+         python -m venv venv
+
+      Activate the environment:
+
+      - On macOS/Linux:
+
+        .. code-block:: bash
+
+           source venv/bin/activate
+
+      - On Windows:
+
+        .. code-block:: bash
+
+           venv\Scripts\activate
+
+   .. tab:: virtualenv
+
+      If you prefer `virtualenv`, install it first:
+
+      .. code-block:: bash
+
+         pip install virtualenv
+         virtualenv venv
+
+      Activate the environment:
+
+      - On macOS/Linux:
+
+        .. code-block:: bash
+
+           source venv/bin/activate
+
+      - On Windows:
+
+        .. code-block:: bash
+
+           venv\Scripts\activate
+
+   .. tab:: Conda
+
+      If you manage environments with Conda:
+
+      .. code-block:: bash
+
+         conda create --name lightwin python=3.x
+         conda activate lightwin
+
+Once it is activated, run the following command:
+
+.. code-block:: bash
+
+   pip install lightwin

{lightwin-0.9.1 → lightwin-0.9.2}/docs/manual/installation.rst

@@ -4,9 +4,9 @@ Installation
 .. toctree::
    :maxdepth: 5
 
-   installation.download
-   installation.python
-   installation.cython
+   installation.pypi
+   installation.building
    installation.tracewin
+   installation.cython
    installation.testing
    installation.troubleshooting

{lightwin-0.9.1 → lightwin-0.9.2}/docs/manual/installation.testing.rst

@@ -1,5 +1,7 @@
-Testing
--------
+Testing (for developers)
+------------------------
+
+Read this section if you built LightWin from source and expect to modify the code.
 
 Pytest
 ^^^^^^

{lightwin-0.9.1 → lightwin-0.9.2}/docs/manual/installation.tracewin.rst

@@ -1,3 +1,5 @@
+.. _installation-tracewin:
+
 TraceWin (facultative)
 ----------------------