LightWin 0.9.2__tar.gz → 0.9.4__tar.gz

{lightwin-0.9.2 → lightwin-0.9.4}/.gitignore

@@ -86,7 +86,7 @@ ipython_config.py
 # pyenv
 #   For a library or package, you might want to ignore these files since the code is
 #   intended to run in multiple environments; otherwise, check them in:
-# .python-version
+.python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -176,7 +176,6 @@ data/test_instructions/results_tests/*
 src/lightwin/data/ads/*
 
 docs/source/manual/notebooks/*.py
-images/
 source/build/
 source/untitled*.py
 *.c

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

@@ -30,7 +30,7 @@ repos:
     hooks:
     -   id: pyupgrade
   - repo: https://github.com/pycqa/isort  # args set in pyproject.toml
-    rev: 5.13.2
+    rev: 6.0.1
     hooks:
       - id: isort
         name: isort (python)
@@ -38,6 +38,6 @@ repos:
         name: isort (cython)
         types: [cython]
   - repo: https://github.com/psf/black  # args set in pyproject.toml
-    rev: 24.10.0
+    rev: 25.1.0
     hooks:
       - id: black

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

@@ -10,6 +10,23 @@ 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.4] -- 2025-05-06
+
+### Added
+
+- Wrote the [documentation](https://lightwin.readthedocs.io/en/latest/manual/get_method.html) for the magic `get` methods.
+- Added `get` examples in the example notebook.
+
+## [0.9.3] -- 2025-04-09
+
+### Fixed
+
+- The `lightwin.config_manager` symlink pointing to `lightwin.config.config_manager` did not resolve on Windows.
+  It was deleted and all `import lightwin.config_manager` were replaced by `import lightwin.config.config_manager`.
+
+### Changed
+
+- `import lightwin.config_manager` no longer works! Replace all occurrences by `import lightwin.config.config_manager`.
 
 ## [0.9.2] -- 2025-04-07
 

{lightwin-0.9.2 → lightwin-0.9.4}/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.1
-date-released: '2025-01-30'
+version: 0.9.2
+date-released: '2025-04-07'
 authors:
   - family-names: Plaçais
     given-names: Adrien

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: LightWin
-Version: 0.9.2
+Version: 0.9.4
 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
@@ -53,7 +53,7 @@ LightWin is a tool to automatically find compensation settings for cavity failur
 The full installation instructions are detailed [here](https://lightwin.readthedocs.io/en/latest/manual/installation.html).
 The steps are straightforward and can be summarized as follows:
 1. Clone the repository: `git clone git@github.com:AdrienPlacais/LightWin.git`
-2. Navigate to the `LightWin` directory, and switch to the last tagged version: `git checkout v0.9.0`
+2. Navigate to the `LightWin` directory, and switch to the last tagged version. For example: `git switch v0.9.3`
 3. Install LightWin with all its dependencies: `pip install -e .[test]`
 4. Test that everything is working with `pytest -m "not tracewin and not implementation"`.
 

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

@@ -14,7 +14,7 @@ LightWin is a tool to automatically find compensation settings for cavity failur
 The full installation instructions are detailed [here](https://lightwin.readthedocs.io/en/latest/manual/installation.html).
 The steps are straightforward and can be summarized as follows:
 1. Clone the repository: `git clone git@github.com:AdrienPlacais/LightWin.git`
-2. Navigate to the `LightWin` directory, and switch to the last tagged version: `git checkout v0.9.0`
+2. Navigate to the `LightWin` directory, and switch to the last tagged version. For example: `git switch v0.9.3`
 3. Install LightWin with all its dependencies: `pip install -e .[test]`
 4. Test that everything is working with `pytest -m "not tracewin and not implementation"`.
 

{lightwin-0.9.2 → lightwin-0.9.4}/data/example/generate_design_space_files.py

@@ -9,7 +9,7 @@ import os.path
 from pathlib import Path
 
 from lightwin.beam_calculation.factory import BeamCalculatorsFactory
-from lightwin.config_manager import process_config
+from lightwin.config.config_manager import process_config
 from lightwin.core.accelerator.factory import (
     StudyWithoutFaultsAcceleratorFactory,
 )

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

@@ -11,7 +11,7 @@ from my_own_objectives import (
 )
 
 from lightwin.beam_calculation.beam_calculator import BeamCalculator
-from lightwin.config_manager import process_config
+from lightwin.config.config_manager import process_config
 from lightwin.core.accelerator.accelerator import Accelerator
 from lightwin.experimental.new_evaluator.simulation_output.factory import (
     SimulationOutputEvaluatorsFactory,

{lightwin-0.9.2 → lightwin-0.9.4}/data/test_instructions/debug.py

@@ -14,7 +14,7 @@ from lightwin.core.accelerator.factory import NoFault
 
 
 def _set_up_solvers(
-    config: dict[str, Any]
+    config: dict[str, Any],
 ) -> tuple[BeamCalculator, list[str]]:
     """Create the beam calculators."""
     factory = BeamCalculatorsFactory(**config)

{lightwin-0.9.2 → lightwin-0.9.4}/docs/Makefile

@@ -6,7 +6,7 @@ SPHINXBUILD   ?= sphinx-build
 SPHINXAPIDOC  ?= sphinx-apidoc
 # Dirs
 SOURCEDIR     = .
-BUILDDIR      = ../../_tmp_LightWin-docs
+BUILDDIR      = _build/
 SRC_DIR       = ../src
 EXCLUDE_DIR   = ../src/lightwin/experimental/*
 APIDOC_DIR    = lightwin

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

@@ -31,5 +31,4 @@ Submodules
 .. toctree::
    :maxdepth: 5
 
-   lightwin.config_manager
    lightwin.constants

lightwin-0.9.4/docs/manual/get_method.rst

@@ -0,0 +1,75 @@
+The `get` method
+================
+
+Most objects in LightWin implement a versatile `get` method.  
+This method provides a convenient way to access the data you're interested in without needing to write long or complex paths.
+
+If your development environment is properly configured for type completion, it should automatically suggest the list of valid keys you can use with this method.
+
+.. image:: images/get_example.png
+   :width: 400
+   :alt: Auto-completion example in an editor
+
+.. tip::
+   The first argument of the `get` method uses the standard Python `*args` syntax.  
+   This means you can request multiple keys at once:
+   
+   .. code-block:: python
+
+      energy, phase = simulation_output.get("w_kin", "phi_abs")
+
+   which is equivalent to:
+
+   .. code-block:: python
+
+      energy = simulation_output.get("w_kin")
+      phase = simulation_output.get("phi_abs")
+
+You can also refer to the documentation of each specific `get` method:
+
+* :meth:`.Accelerator.get`
+* :meth:`.BeamParameters.get`
+* :meth:`.Element.get`
+* :meth:`.FieldMap.get`
+* :meth:`.ListOfElements.get`
+* :meth:`.ParticleFullTrajectory.get`
+* :meth:`.RfField.get`
+* :meth:`.SimulationOutput.get`
+* :meth:`.TransferMatrix.get`
+
+Additional utility keyword arguments (`**kwargs`) are supported by some `get` methods.  
+Here are a few commonly used ones:
+
+.. list-table:: Common `**kwargs` for `get` methods
+   :widths: 25 25 50
+   :header-rows: 1
+
+   * - Keyword
+     - Purpose
+     - Notes
+   * - `elt`
+     - Access data for a specific :class:`.Element`
+     - See :meth:`.SimulationOutput.get`
+   * - `phase_space_name`
+     - Select data from a particular phase space
+     - See :meth:`.BeamParameters.get`
+   * - `pos`
+     - Retrieve data only at element entry or exit
+     - Requires `elt`; see :meth:`.SimulationOutput.get`
+   * - `to_deg`
+     - Convert phase values (keys containing `"phi"`) to degrees
+     - Defaults to `False`
+   * - `to_numpy`
+     - Convert the result to a NumPy array
+     - Defaults to `True`
+
+.. warning::
+   Use caution with the `to_deg` keyword.  
+   It may incorrectly convert keys such as `beta_phiw`, where `phiw` refers to a phase space name, not an angular quantity.  
+   To avoid this, use the `phase_space_name` keyword instead.
+
+If the requested key is not found, the method does **not** raise an error -- it simply returns an empty array.
+
+Some examples are provided at the end of the `example notebook`_.
+
+.. _example notebook: notebooks/example.ipynb#Accessing-data