Skip to content

Commit

Permalink
Update user-facing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@EZoni
EZoni committed Jul 19, 2024
1 parent f81c2b0 commit 392773b
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 30 deletions.
26 changes: 13 additions & 13 deletions docs/source/usage/parameters.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -290,14 +290,14 @@ Lattice Elements

* ``<element_name>.ds`` (``float``, in meters) the segment length
* ``<element_name>.k`` (``float``, in inverse meters squared OR in T/m) the quadrupole strength
= (magnetic field gradient in T/m) / (magnetic rigidity in T-m) - if units = 0
= (magnetic field gradient in T/m) / (magnetic rigidity in T-m) - if unit = 0

OR = magnetic field gradient in T/m - if units = 1
OR = magnetic field gradient in T/m - if unit = 1

* k > 0 horizontal focusing
* k < 0 horizontal defocusing

* ``<element_name>.units`` (``integer``) specification of units (default: ``0``)
* ``<element_name>.unit`` (``integer``) specification of units (default: ``0``)
* ``<element_name>.dx`` (``float``, in meters) horizontal translation error
* ``<element_name>.dy`` (``float``, in meters) vertical translation error
* ``<element_name>.rotation`` (``float``, in degrees) rotation error in the transverse plane
Expand All @@ -324,11 +324,11 @@ Lattice Elements

* ``<element_name>.ds`` (``float``, in meters) the segment length
* ``<element_name>.k`` (``float``, in inverse meters squared OR in T/m) the plasma lens focusing strength
= (azimuthal magnetic field gradient in T/m) / (magnetic rigidity in T-m) - if units = 0
= (azimuthal magnetic field gradient in T/m) / (magnetic rigidity in T-m) - if unit = 0

OR = azimuthal magnetic field gradient in T/m - if units = 1
OR = azimuthal magnetic field gradient in T/m - if unit = 1

* ``<element_name>.units`` (``integer``) specification of units (default: ``0``)
* ``<element_name>.unit`` (``integer``) specification of units (default: ``0``)
* ``<element_name>.dx`` (``float``, in meters) horizontal translation error
* ``<element_name>.dy`` (``float``, in meters) vertical translation error
* ``<element_name>.rotation`` (``float``, in degrees) rotation error in the transverse plane
Expand Down Expand Up @@ -370,15 +370,15 @@ Lattice Elements

* ``<element_name>.ds`` (``float``, in meters) the segment length
* ``<element_name>.bscale`` (``float``, in inverse meters) Scaling factor for on-axis longitudinal magnetic field
= (magnetic field Bz in T) / (magnetic rigidity in T-m) - if units = 0
= (magnetic field Bz in T) / (magnetic rigidity in T-m) - if unit = 0

OR = magnetic field Bz in T - if units = 1
OR = magnetic field Bz in T - if unit = 1

* ``<element_name>.cos_coefficients`` (array of ``float``) cos coefficients in Fourier expansion of the on-axis magnetic field Bz
(optional); default is a thin-shell model from `DOI:10.1016/J.NIMA.2022.166706 <https://doi.org/10.1016/j.nima.2022.166706>`__
* ``<element_name>.sin_coefficients`` (array of ``float``) sin coefficients in Fourier expansion of the on-axis magnetic field Bz
(optional); default is a thin-shell model from `DOI:10.1016/J.NIMA.2022.166706 <https://doi.org/10.1016/j.nima.2022.166706>`__
* ``<element_name>.units`` (``integer``) specification of units (default: ``0``)
* ``<element_name>.unit`` (``integer``) specification of units (default: ``0``)
* ``<element_name>.dx`` (``float``, in meters) horizontal translation error
* ``<element_name>.dy`` (``float``, in meters) vertical translation error
* ``<element_name>.rotation`` (``float``, in degrees) rotation error in the transverse plane
Expand Down Expand Up @@ -497,7 +497,7 @@ Lattice Elements

* ``<element_name>.xkick`` (``float``, dimensionless OR in T-m) the horizontal kick strength
* ``<element_name>.ykick`` (``float``, dimensionless OR in T-m) the vertical kick strength
* ``<element_name>.units`` (``string``) specification of units: ``dimensionless`` (default, in units of the magnetic rigidity of the reference particle) or ``T-m``
* ``<element_name>.unit`` (``string``) specification of units: ``dimensionless`` (default, in units of the magnetic rigidity of the reference particle) or ``T-m``
* ``<element_name>.dx`` (``float``, in meters) horizontal translation error
* ``<element_name>.dy`` (``float``, in meters) vertical translation error
* ``<element_name>.rotation`` (``float``, in degrees) rotation error in the transverse plane
Expand Down Expand Up @@ -532,11 +532,11 @@ Lattice Elements
This requires these additional parameters:

* ``<element_name>.k`` (``float``, in inverse meters OR in T) the integrated plasma lens focusing strength
= (length in m) * (magnetic field gradient :math:`g` in T/m) / (magnetic rigidity in T-m) - if units = 0
= (length in m) * (magnetic field gradient :math:`g` in T/m) / (magnetic rigidity in T-m) - if unit = 0

OR = (length in m) * (magnetic field gradient :math:`g` in T/m) - if units = 1
OR = (length in m) * (magnetic field gradient :math:`g` in T/m) - if unit = 1

* ``<element_name>.units`` (``integer``) specification of units (default: ``0``)
* ``<element_name>.unit`` (``integer``) specification of units (default: ``0``)
* ``<element_name>.taper`` (``float``, in 1/meters) horizontal taper parameter
= 1 / (target horizontal dispersion :math:`D_x` in m)

Expand Down
34 changes: 17 additions & 17 deletions docs/source/usage/python.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -539,13 +539,13 @@ This module provides elements for the accelerator lattice.
:param rotation: rotation error in the transverse plane [degrees]
:param nslice: number of slices used for the application of space charge

.. py:class:: impactx.elements.Kicker(xkick, ykick, units="dimensionless", dx=0, dy=0, rotation=0)
.. py:class:: impactx.elements.Kicker(xkick, ykick, unit="dimensionless", dx=0, dy=0, rotation=0)
A thin transverse kicker.

:param xkick: horizontal kick strength (dimensionless OR T-m)
:param ykick: vertical kick strength (dimensionless OR T-m)
:param units: specification of units (``"dimensionless"`` in units of the magnetic rigidity of the reference particle or ``"T-m"``)
:param unit: specification of units (``"dimensionless"`` in units of the magnetic rigidity of the reference particle or ``"T-m"``)

.. py:class:: impactx.elements.Multipole(multipole, K_normal, K_skew, dx=0, dy=0, rotation=0)
Expand Down Expand Up @@ -675,19 +675,19 @@ This module provides elements for the accelerator lattice.
:param rotation: rotation error in the transverse plane [degrees]
:param nslice: number of slices used for the application of space charge

.. py:class:: impactx.elements.ChrQuad(ds, k, units=0, dx=0, dy=0, rotation=0, nslice=1)
.. py:class:: impactx.elements.ChrQuad(ds, k, unit=0, dx=0, dy=0, rotation=0, nslice=1)
A Quadrupole magnet, with chromatic effects included. The Hamiltonian is expanded
through second order in the transverse variables (x,px,y,py), with the exact pt
dependence retained.

:param ds: Segment length in m.
:param k: Quadrupole strength in m^(-2) (MADX convention, if units = 0)
:param k: Quadrupole strength in m^(-2) (MADX convention, if unit = 0)
= (gradient in T/m) / (rigidity in T-m)
OR Quadrupole strength in T/m (MaryLie convention, if units = 1)
OR Quadrupole strength in T/m (MaryLie convention, if unit = 1)
k > 0 horizontal focusing
k < 0 horizontal defocusing
:param units: specification of units for quadrupole field strength
:param unit: specification of units for quadrupole field strength
:param dx: horizontal translation error in m
:param dy: vertical translation error in m
:param rotation: rotation error in the transverse plane [degrees]
Expand All @@ -697,21 +697,21 @@ This module provides elements for the accelerator lattice.
quadrupole strength in 1/m^2 (or T/m)

.. py:property:: units
.. py:property:: unit
unit specification for quad strength

.. py:class:: impactx.elements.ChrPlasmaLens(ds, k, units=0, dx=0, dy=0, rotation=0, nslice=1)
.. py:class:: impactx.elements.ChrPlasmaLens(ds, k, unit=0, dx=0, dy=0, rotation=0, nslice=1)
An active cylindrically symmetric plasma lens, with chromatic effects included.
The Hamiltonian is expanded through second order in the transverse variables
(x,px,y,py), with the exact pt dependence retained.

:param ds: Segment length in m.
:param k: focusing strength in m^(-2) (if units = 0)
:param k: focusing strength in m^(-2) (if unit = 0)
= (azimuthal magnetic field gradient in T/m) / (rigidity in T-m)
OR azimuthal magnetic field gradient in T/m (if units = 1)
:param units: specification of units for plasma lens focusing strength
OR azimuthal magnetic field gradient in T/m (if unit = 1)
:param unit: specification of units for plasma lens focusing strength
:param dx: horizontal translation error in m
:param dy: vertical translation error in m
:param rotation: rotation error in the transverse plane [degrees]
Expand All @@ -721,7 +721,7 @@ This module provides elements for the accelerator lattice.
plasma lens focusing strength in 1/m^2 (or T/m)

.. py:property:: units
.. py:property:: unit
unit specification for plasma lens focusing strength

Expand Down Expand Up @@ -908,7 +908,7 @@ This module provides elements for the accelerator lattice.

* G. Ripken and F. Schmidt, Thin-Lens Formalism for Tracking, CERN/SL/95-12 (AP), 1995.

.. py:class:: impactx.elements.TaperedPL(k, taper, units=0, dx=0, dy=0, rotation=0)
.. py:class:: impactx.elements.TaperedPL(k, taper, unit=0, dx=0, dy=0, rotation=0)
A thin nonlinear plasma lens with transverse (horizontal) taper

Expand All @@ -918,13 +918,13 @@ This module provides elements for the accelerator lattice.
where :math:`g` is the (linear) field gradient in T/m and :math:`D_x` is the targeted horizontal dispersion in m.

:param k: integrated focusing strength in m^(-1) (if units = 0)
:param k: integrated focusing strength in m^(-1) (if unit = 0)
= (length in m) * (magnetic field gradient :math:`g` in T/m) / (magnetic rigidity in T-m)
OR integrated focusing strength in T (if units = 1)
OR integrated focusing strength in T (if unit = 1)
= (length in m) * (magnetic field gradient :math:`g` in T/m)
:param taper: horizontal taper parameter in m^(-1)
= 1 / (target horizontal dispersion :math:`D_x` in m)
:param units: specification of units for plasma lens focusing strength
:param unit: specification of units for plasma lens focusing strength
:param dx: horizontal translation error in m
:param dy: vertical translation error in m
:param rotation: rotation error in the transverse plane [degrees]
Expand All @@ -937,7 +937,7 @@ This module provides elements for the accelerator lattice.
horizontal taper parameter in 1/m

.. py:property:: units
.. py:property:: unit
unit specification for plasma lens focusing strength

Expand Down

0 comments on commit 392773b

Please sign in to comment.