Fix sign issue for horizontal kick angle

.github/ISSUE_TEMPLATE/feature_request.md

@@ -17,7 +17,7 @@ A clear and concise description of what you want to happen.
 A clear and concise description of any alternative solutions or features you've considered. An argument for why this solution is not the preferred one.
 
 **Example**
-Give a concise example of the envisioned featured. 
+Give a concise example of the envisioned featured.
 
 **Additional context**
 Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -22,11 +22,11 @@ Describe the changes that had to be made to an existing functionality (if they w
 - [ ] ...
 
 ## Testing
- The following tests (compatible with pytest) were added: 
+ The following tests (compatible with pytest) were added:
  - [ ] first test
  - [ ] second test
  - ...
-   
+
 ## Verify that your checklist complies with the project
 - [ ] New and existing unit tests pass locally
 - [ ] Tests were added to prove that all features/changes are effective

.github/workflows/deploy-pypi.yaml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   deploy:
-  
+
     runs-on: ubuntu-latest
 
     #environment: release
@@ -25,7 +25,7 @@ jobs:
         cache-dependency-path: '**/pyproject.toml'
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip 
+        python -m pip install --upgrade pip
         pip install hatch
     - name: Build package
       run: hatch build

.github/workflows/documentation.yml

@@ -13,14 +13,14 @@ permissions: write-all
 jobs:
   documentation:
     name: ${{ matrix.os }} / ${{ matrix.python-version }}
-    
+
     runs-on: ${{ matrix.os }}
-    
+
     strategy:
       matrix:  # only lowest supported Python on latest ubuntu
         os: [ubuntu-latest]
         python-version: [3.14]
-    
+
     permissions:
       issues: write
       pull-requests: write
@@ -49,7 +49,7 @@ jobs:
 
       - name: Install dependencies
         run: pip install -r ./docs/requirements.txt
-        
+
       - name: Build documentation
         run: python -m sphinx -b html docs ./docs/_build -d ./docs/_build
 
@@ -81,6 +81,3 @@ jobs:
       #   with:
       #     github_token: ${{ secrets.GITHUB_TOKEN }}
       #     publish_dir: docs/_build/html
-
-
-

.gitignore

@@ -59,7 +59,7 @@ coverage.xml
 .pytest_cache/
 cover/
 
-# DS 
+# DS
 **/.DS_Store
 
 # Translations

.readthedocs.yaml

@@ -30,4 +30,3 @@ sphinx:
 python:
    install:
    - requirements: docs/requirements.txt
-

README.md

@@ -1,4 +1,4 @@
-[![Documentation Status](https://readthedocs.org/projects/pyaml/badge/?version=latest)](https://pyaml.readthedocs.io/en/latest/?badge=latest) 
+[![Documentation Status](https://readthedocs.org/projects/pyaml/badge/?version=latest)](https://pyaml.readthedocs.io/en/latest/?badge=latest)
 ![Current release](https://img.shields.io/github/v/tag/python-accelerator-middle-layer/pyaml)
 
 # pyAML: Python Accelerator Middle Layer
@@ -10,7 +10,7 @@ Disclaimer: the pyAML software is still under development.
 1. Clone the repository
 2. Create a virtual environment and activate it
 3. Install the package. For editable installation:
-   
+
    ```
    cd pyaml
    pip install -e .

docs/Makefile

@@ -156,4 +156,4 @@ linkcheck:
 doctest:
 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."
+	      "results in $(BUILDDIR)/doctest/output.txt."

docs/api.rst

@@ -5,4 +5,4 @@ API
    :toctree: generated
    :recursive:
 
-   pyaml
+   pyaml

docs/index.rst

@@ -1,6 +1,6 @@
 pyAML documentation
 ===================
-    
+
 Introduction
 ------------
 
@@ -14,12 +14,12 @@ With pyAML, it WILL be possible to (the software is at conceptualization stage):
 - **compute statistical properties for several lattice instances with errors**
 - **flexible complex unit conversions**
 - **easy and friendly configuration**
-- many more features 
+- many more features
 
 Installation
 ------------
-pip support will be provided later. 
-for the time being: 
+pip support will be provided later.
+for the time being:
 
 git clone https://github.com/python-accelerator-middle-layer/pyaml.git
 
@@ -57,7 +57,7 @@ Discussion
 Shared documents
 ~~~~~~~~~~~~~~~~
 
-to access the shared documents please ask S.Liuzzo for access rigths. 
+to access the shared documents please ask S.Liuzzo for access rigths.
 
 The pyAML "software requirement specification" document is visible here:
 https://www.overleaf.com/read/hnrqzhfpbvpp#ef8935
@@ -76,4 +76,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

docs/modules/bpm.rst

@@ -11,4 +11,4 @@ BPMS
     :members:
 
 .. automodule:: pyaml.bpm.bpm_simple_model
-    :members:
+    :members:

docs/modules/configuration.rst

@@ -6,7 +6,7 @@ Configuration
 
 .. automodule:: pyaml.configuration.factory
     :members:
-    
+
 .. automodule:: pyaml.configuration.matrix
     :members:
 
@@ -18,7 +18,7 @@ Configuration
 
 .. automodule:: pyaml.configuration.matrix
     :members:
-    
+
 .. automodule:: pyaml.configuration.csvmatrix
     :members:
 

docs/modules/lattice.rst

@@ -6,7 +6,7 @@ lattice
 
 .. automodule:: pyaml.lattice.attribute_linker
     :members:
-    
+
 .. automodule:: pyaml.lattice.element_holder
     :members:
 
@@ -21,5 +21,3 @@ lattice
 
 .. automodule:: pyaml.lattice.simulator
     :members:
-
-

docs/modules/pyaml.rst

@@ -21,4 +21,3 @@ pyaml
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
-

docs/modules/rf.rst

@@ -6,4 +6,3 @@ RF
 
 .. automodule:: pyaml.rf.rf_transmitter
     :members:
-

docs/requirements.txt

@@ -12,4 +12,4 @@ accelerator-toolbox==0.7.1
 matplotlib==3.10.7
 ipykernel==7.1.0
 myst-nb==1.3.0
-pydata-sphinx-theme==0.16.1
+pydata-sphinx-theme==0.16.1

pyaml/common/constants.py

@@ -0,0 +1,5 @@
+"""
+PyAML global constants
+"""
+
+HORIZONTAL_KICK_SIGN: float = -1.0

pyaml/lattice/abstract_impl.py

@@ -28,15 +28,16 @@ def __init__(
         self.__model = model
         self.__elements = elements
         self.__poly = elements[0].__getattribute__(poly.attName)
+        self.__sign = poly.sign
         self.__polyIdx = poly.index
 
     def get(self) -> float:
-        s = self.__poly[self.__polyIdx] * self.__elements[0].Length
+        s = self.__poly[self.__polyIdx] * self.__sign * self.__elements[0].Length
         return self.__model.compute_hardware_values([s])[0]
 
     def set(self, value: float):
         s = self.__model.compute_strengths([value])[0]
-        self.__poly[self.__polyIdx] = s / self.__elements[0].Length
+        self.__poly[self.__polyIdx] = s / (self.__elements[0].Length * self.__sign)
 
     def set_and_wait(self, value: float):
         raise NotImplementedError("Not implemented yet.")
@@ -59,15 +60,16 @@ def __init__(
         self.__model = model
         self.__elements = elements
         self.__poly = elements[0].__getattribute__(poly.attName)
+        self.__sign = poly.sign
         self.__polyIdx = poly.index
 
     # Gets the value
     def get(self) -> float:
-        return self.__poly[self.__polyIdx] * self.__elements[0].Length
+        return self.__poly[self.__polyIdx] * self.__sign * self.__elements[0].Length
 
     # Sets the value
     def set(self, value: float):
-        self.__poly[self.__polyIdx] = value / self.__elements[0].Length
+        self.__poly[self.__polyIdx] = value / (self.__elements[0].Length * self.__sign)
 
     # Sets the value and wait that the read value reach the setpoint
     def set_and_wait(self, value: float):
@@ -93,25 +95,33 @@ def __init__(
         self.__elements = elements
         self.__poly = []
         self.__polyIdx = []
+        self.__sign = []
         self.__model = model
         for p in poly:
             self.__poly.append(elements[0].__getattribute__(p.attName))
             self.__polyIdx.append(p.index)
+            self.__sign.append(p.sign)
 
     # Gets the value
     def get(self) -> np.array:
         nbStrength = len(self.__poly)
         s = np.zeros(nbStrength)
         for i in range(nbStrength):
-            s[i] = self.__poly[i][self.__polyIdx[i]] * self.__elements[0].Length
+            s[i] = (
+                self.__poly[i][self.__polyIdx[i]]
+                * self.__sign[i]
+                * self.__elements[0].Length
+            )
         return self.__model.compute_hardware_values(s)
 
     # Sets the value
     def set(self, value: np.array):
         nbStrength = len(self.__poly)
         s = self.__model.compute_strengths(value)
         for i in range(nbStrength):
-            self.__poly[i][self.__polyIdx[i]] = s[i] / self.__elements[0].Length
+            self.__poly[i][self.__polyIdx[i]] = s[i] / (
+                self.__elements[0].Length * self.__sign[i]
+            )
 
     # Sets the value and wait that the read value reach the setpoint
     def set_and_wait(self, value: np.array):
@@ -136,25 +146,33 @@ def __init__(
         self.__elements = elements
         self.__poly = []
         self.__polyIdx = []
+        self.__sign = []
         self.__model = model
         for p in poly:
             self.__poly.append(elements[0].__getattribute__(p.attName))
             self.__polyIdx.append(p.index)
+            self.__sign.append(p.sign)
 
     # Gets the value
     def get(self) -> np.array:
         nbStrength = len(self.__poly)
         s = np.zeros(nbStrength)
         for i in range(nbStrength):
-            s[i] = self.__poly[i][self.__polyIdx[i]] * self.__elements[0].Length
+            s[i] = (
+                self.__poly[i][self.__polyIdx[i]]
+                * self.__sign[i]
+                * self.__elements[0].Length
+            )
         return s
 
     # Sets the value
     def set(self, value: np.array):
         nbStrength = len(self.__poly)
         s = np.zeros(nbStrength)
         for i in range(nbStrength):
-            self.__poly[i][self.__polyIdx[i]] = value[i] / self.__elements[0].Length
+            self.__poly[i][self.__polyIdx[i]] = value[i] / (
+                self.__elements[0].Length * self.__sign[i]
+            )
 
     # Sets the value and wait that the read value reach the setpoint
     def set_and_wait(self, value: np.array):
@@ -173,11 +191,11 @@ class BPMScalarAggregator(ScalarAggregator):
     BPM simulator aggregator
     """
 
-    def __init__(self, ring:at.Lattice):
+    def __init__(self, ring: at.Lattice):
         self.lattice = ring
         self.refpts = []
 
-    def add_elem(self,elem:at.Element):
+    def add_elem(self, elem: at.Element):
         self.refpts.append(self.lattice.index(elem))
 
     def set(self, value: NDArray[np.float64]):

pyaml/lattice/polynom_info.py

@@ -8,7 +8,7 @@ class PolynomInfo:
     Polynom information
     """
 
-    def __init__(self, attName: str, index: int):
+    def __init__(self, attName: str, index: int, sign: float = 1.0):
         """
         Construct a polynom information object
 
@@ -21,3 +21,4 @@ def __init__(self, attName: str, index: int):
         """
         self.attName = attName
         self.index = index
+        self.sign = sign

pyaml/magnet/corrector.py

@@ -0,0 +1,30 @@
+import numpy as np
+
+from ..common import abstract
+from .magnet import Magnet
+
+
+class RWCorrectorAngle(abstract.ReadWriteFloatScalar):
+    """
+    Set the angle of a horizontal or vertical corrector.
+    KickAngle sign convention is defined the a global PyAML constant
+    (see pyaml.common.constant.HORIZONATL_KICK_SIGN).
+    To change the convention, you have execute the code below prior to everything:
+    import pyaml.common.constants
+    pyaml.common.constants.HORIZONTAL_KICK_SIGN = -1.0
+    """
+
+    def __init__(self, corr: Magnet):
+        self._mag = corr
+
+    def get(self) -> float:
+        return np.arctan(self._mag.strength.get())
+
+    def set(self, value: float):
+        self._mag.strength.set(np.tan(value))
+
+    def set_and_wait(self, value: float):
+        raise NotImplementedError("Not implemented yet.")
+
+    def unit(self) -> str:
+        return "rad"