Lint and tweak beams (#110)

* first autolint set

* new round for dict, list, tuple

* some more for optional, union

* fix implicit optionals

* refix many imports rules

* fix use of literal dicts

* propagate error change here

* fix trailing whitespaces

* miscellaneous

* fix error messages not declared before raising

* fix magic values use in comparisons

* miscellaneous

* place *args correctly

* miscellaneous

* use dict literal

* miscellaneous

* no implicit namespace

* correctly propagate kwargs

* clean up logic

* message outside raise

* message outside raise

* trade map for list comprehension

* cleaner checks

* format and last lints

* no mypy

* no interrogate

* rename to nemitt_[xy], accept old and let user override npart and sigma_e

* formatting

* remove trailing whitespaces

* pytest parametrize expects tuples

* dict membership test does not need .keys()

* mpl

* names

* unecessary list comprehensions

* fixtures want lists of tuples

* provide 'match' argument to every pytest.raises, normalize error messages

* minimal linting here

* remove old helper functions

* bump version for minor release

* release 1.6.0 file

* added to this list

Author: fsoubelet

Makefile

@@ -84,8 +84,8 @@ format:
 	@python -m isort examples && black -l 95 examples
 
 install: format clean
-	@echo "Installing with $(D)pip$(E) in the current environment."
-	@python -m pip install . -v
+	@echo "Installing (editable) with $(D)pip$(E) in the current environment."
+	@python -m pip install --editable . -v
 
 lines: format
 	@tokei .
@@ -113,5 +113,7 @@ alltests:
 
 # Catch-all unknow targets without returning an error. This is a POSIX-compliant syntax.
 .DEFAULT:
-	@echo "Make caught an invalid target! See help output below for available targets."
+	@echo "Make caught an invalid target."
+	@echo "See help output below for available targets."
+	@echo ""
 	@make help

docs/conf.py

@@ -125,7 +125,7 @@
     "sphinx.ext.coverage",  # Collect doc coverage stats
     "sphinx.ext.doctest",  # Test snippets in the documentation
     "sphinx.ext.githubpages",  # Publish HTML docs in GitHub Pages
-    "sphinx.ext.intersphinx",  # Link to other projects’ documentation
+    "sphinx.ext.intersphinx",  # Link to other projects' documentation
     "sphinx.ext.mathjax",  # Render math via JavaScript
     "sphinx.ext.napoleon",  # Support for NumPy and Google style docstrings
     "sphinx.ext.todo",  # Support for todo items
@@ -214,7 +214,7 @@
 #
 html_static_path = ["_static"]
 
-# A dictionary of values to pass into the template engine’s context for all
+# A dictionary of values to pass into the template engine's context for all
 # pages. Single values can also be put in this dictionary using the
 # -A command-line option of sphinx-build.
 html_context = {

docs/release.rst

@@ -3,6 +3,14 @@ Release Notes
 
 The full list of releases can be found in the GitHub repository's `releases page <https://github.com/fsoubelet/PyhDToolkit/releases>`_.
 
+Version 1.6.0
+-------------
+
+.. toctree::
+    :maxdepth: 2
+
+    releases/v1.6.0
+
 Version 1.5.0
 -------------
 

docs/releases/v1.6.0.rst

@@ -0,0 +1,26 @@
+.. _release_1.6.0:
+
+1.6.0
+-----
+
+Release `1.6.0` brings a few changes, and a great amount of maintenance fixes to the package.
+
+Enhancements
+~~~~~~~~~~~~
+
+* The `pyhdtoolkit.cpymadtools.lhc.make_lhc_beams` function now accepts the user providing values for `npart` and `sige`. The previously hard-coded values are now used as defaults.
+
+Changes
+~~~~~~~
+
+* The `pyhdtoolkit.cpymadtools.lhc.make_lhc_beams` function now expects `nemitt_[xy]` arguments instead of the previous `emittance_[xy]`. Providing the previous name is still accepted but will raise a warning.
+
+Maintenance
+~~~~~~~~~~~
+
+* A great amount of linting has been done to ensure best practices in every line of code.
+* Switched all relevant type hints to use the latest practices.
+* Fixed the `__all__` exports in the `__init__.py` files.
+* Moved type-hint relevant imports in a `TYPE_CHECKING` block to lighten import times.
+
+See `v1.6.0 release notes on GitHub <https://github.com/fsoubelet/PyhDToolkit/releases/tag/1.6.0>`_ and the `full changes since v1.5.0 <https://github.com/fsoubelet/PyhDToolkit/compare/1.5.0...1.6.0>`_.

examples/demo_acd_tracking_spectra.py

@@ -6,17 +6,17 @@
 AC Dipole Driven Tracking Spectrum
 ==================================
 
-This example shows how to use the `~.lhc.install_ac_dipole_as_kicker` and 
-`~.track.track_single_particle` function to track a  particle with the 
+This example shows how to use the `~.lhc.install_ac_dipole_as_kicker` and
+`~.track.track_single_particle` function to track a  particle with the
 ``TRACK`` command of ``MAD-X``, and visualise its coordinates and spectrum.
 
-In this example we will use the LHC lattice to illustrate the ACD tracking 
+In this example we will use the LHC lattice to illustrate the ACD tracking
 workflow when using `~pyhdtoolkit.cpymadtools`.
 
 .. note::
-    This is very similar to the :ref:`free tracking example <demo-free-tracking>` 
-    with the difference that there is special care to take to install the AC Dipole 
-    element. It is recommended to read that tutorial first as this one will focus 
+    This is very similar to the :ref:`free tracking example <demo-free-tracking>`
+    with the difference that there is special care to take to install the AC Dipole
+    element. It is recommended to read that tutorial first as this one will focus
     on the specificities of the AC Dipole setup.
 
 .. important::
@@ -33,7 +33,6 @@
 import matplotlib.pyplot as plt
 import numpy as np
 import pandas as pd
-
 from cpymad.madx import Madx
 
 from pyhdtoolkit.cpymadtools import lhc, matching, track
@@ -45,7 +44,7 @@
 
 ###############################################################################
 # Let's start by setting up the LHC in ``MAD-X``, in this case at top energy.
-# To understand the function below have a look at the :ref:`lhc setup example 
+# To understand the function below have a look at the :ref:`lhc setup example
 # <demo-lhc-setup>`.
 
 madx: Madx = lhc.prepare_lhc_run3(

examples/demo_aperture.py

@@ -6,7 +6,7 @@
 Accelerator Aperture
 ====================
 
-This example shows how to use the `~.plotting.aperture.plot_aperture` and 
+This example shows how to use the `~.plotting.aperture.plot_aperture` and
 `~.plotting.aperture.plot_physical_apertures` functions to visualise the
 available aperture in your machine, with the LHC used for this example.
 
@@ -23,7 +23,6 @@
 """
 
 import matplotlib.pyplot as plt
-
 from cpymad.madx import Madx
 
 from pyhdtoolkit.cpymadtools import lhc
@@ -35,7 +34,7 @@
 plt.rcParams.update(_SPHINX_GALLERY_PARAMS)  # for readability of this tutorial
 
 ###############################################################################
-# Let's start by setting up the LHC in ``MAD-X``, in this case at injection 
+# Let's start by setting up the LHC in ``MAD-X``, in this case at injection
 # optics and energy. To understand the function below have a look at the
 # :ref:`lhc setup example <demo-lhc-setup>`.
 
@@ -86,7 +85,7 @@
 
 
 ###############################################################################
-# We can also go for a different type of aperture plot, which tries to give 
+# We can also go for a different type of aperture plot, which tries to give
 # the elements' real physical apertures, with the `~.plotting.aperture.plot_physical_apertures`
 # function:
 

examples/demo_beam_enveloppe.py

@@ -14,7 +14,6 @@
 # sphinx_gallery_thumbnail_number = 1
 import matplotlib.pyplot as plt
 import numpy as np
-
 from cpymad.madx import Madx
 
 from pyhdtoolkit.plotting.envelope import plot_beam_envelope
@@ -59,7 +58,7 @@
 madx.input(
     f"""
 circum = {circumference};
-n_cells = {n_cells}; ! Number of cells 
+n_cells = {n_cells}; ! Number of cells
 lcell = {l_cell};
 lq = {l_quad}; ! Length of a quadrupole
 ldip = {l_bend};
@@ -71,14 +70,14 @@
 mb: sbend, l=ldip, angle=2.0*pi/(4*n_cells), apertype=ellipse, aperture={{{h_gap_dipole}, {v_gap_dipole}}};
 f = {f_m};
 
-! Define quadrupoles as multipoles 
-qf: multipole, knl:={{0,1/f+qtrim_f}}; 
+! Define quadrupoles as multipoles
+qf: multipole, knl:={{0,1/f+qtrim_f}};
 qd: multipole, knl:={{0,-1/f+qtrim_d}};
-qf: quadrupole, l=lq, K1:=1/f/lq  + qtrim_f/lq, apertype=ellipse, aperture={{{r_quadrupole}, {r_quadrupole}}}; 
+qf: quadrupole, l=lq, K1:=1/f/lq  + qtrim_f/lq, apertype=ellipse, aperture={{{r_quadrupole}, {r_quadrupole}}};
 qd: quadrupole, l=lq, K1:=-1/f/lq + qtrim_d/lq, apertype=ellipse, aperture={{{r_quadrupole}, {r_quadrupole}}};
 
 ! Define the sextupoles as multipole
-! ATTENTION: must use knl:= and NOT knl= to match later! 
+! ATTENTION: must use knl:= and NOT knl= to match later!
 lsex = 0.00001; ! dummy length, only used in the sequence
 msf: multipole, knl:={{0,0,ksf}};
 msd: multipole, knl:={{0,0,ksd}};

examples/demo_ir_errors.py

@@ -10,7 +10,7 @@
 to assign magnet errors in the Insertion Region magnets of the LHC.
 
 .. warning::
-    The implementation of this function makes it valid only for LHC IP IRs, which are 
+    The implementation of this function makes it valid only for LHC IP IRs, which are
     1, 2, 5 and 8. Other IRs have different layouts that are incompatible.
 
 .. important::
@@ -27,7 +27,6 @@
 # sphinx_gallery_thumbnail_number = 1
 import matplotlib.pyplot as plt
 import numpy as np
-
 from cpymad.madx import Madx
 
 from pyhdtoolkit.cpymadtools import lhc, matching
@@ -38,7 +37,7 @@
 plt.rcParams.update(_SPHINX_GALLERY_PARAMS)  # for readability of this tutorial
 
 ###############################################################################
-# Let's start by setting up the LHC in ``MAD-X``, in this case at injection 
+# Let's start by setting up the LHC in ``MAD-X``, in this case at injection
 # optics and energy. To understand the function below have a look at the
 # :ref:`lhc setup example <demo-lhc-setup>`.
 

examples/demo_lattice.py

@@ -13,7 +13,6 @@
 of several parameters to control the plot on the example case of the LHC.
 """
 import matplotlib.pyplot as plt
-
 from cpymad.madx import Madx
 
 from pyhdtoolkit.cpymadtools import lhc, matching

examples/demo_lhc_crossing_schemes.py

@@ -13,7 +13,6 @@
     This is very LHC-specific and will not work with other machines.
 """
 import matplotlib.pyplot as plt
-
 from cpymad.madx import Madx
 
 from pyhdtoolkit.cpymadtools import lhc
@@ -35,7 +34,7 @@
 
 ###############################################################################
 # Let's explicitely re-cycle both sequences to avoid having IR1 split at beginning
-# and end of lattice. Note that it is important to re-cycle both sequences from 
+# and end of lattice. Note that it is important to re-cycle both sequences from
 # the same points for the plots later on.
 
 lhc.re_cycle_sequence(madx, sequence="lhcb1", start="IP3")