Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 37 additions & 21 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,54 @@
# pylhc Changelog

## Version 0.8.3

Explicitely require the `pytz` package as a dependency since it is no longer a hard dependency of `pandas 3.x`, which we relied on.g

## Version 0.8.2

Dropped support for `Python 3.9`.

## Version 0.8.1

Fixed:
- add FILL and JSON_FILE to output table of kickgroup summary
- catch empty kickgroups gracefully
- adapt for moving the `.sdds` and `.json` files to backup folders on `nfs`
- addtional checks/warning/dict-keys for old versions of the `.json` files

- add FILL and JSON_FILE to output table of kickgroup summary
- catch empty kickgroups gracefully
- adapt for moving the `.sdds` and `.json` files to backup folders on `nfs`
- addtional checks/warning/dict-keys for old versions of the `.json` files

## Version 0.8.0

Fixed:
- replaced `get_loc` with `get_indexer` to be compatible with `pandas` > 2.0

- replaced `get_loc` with `get_indexer` to be compatible with `pandas` > 2.0

Added:
- `beamprocess` option to Machine Settings Info, to allow manual override.

- `beamprocess` option to Machine Settings Info, to allow manual override.

Removed:
- `hdf5` reader/writer for `tfs` as this is already in `tfs-pandas`

- `hdf5` reader/writer for `tfs` as this is already in `tfs-pandas`

## Version 0.7.4

Changes in Machine Settings Info
- Default behaviour for no knobs given: extract None.
- Old behaviour of extracting all restored by giving `knobs = ["all"]`
- Option `["default"]` available for default knobs.
- Additional debug logging

- Default behaviour for no knobs given: extract None.
- Old behaviour of extracting all restored by giving `knobs = ["all"]`
- Option `["default"]` available for default knobs.
- Additional debug logging

## Version 0.7.3

Fixes:
- LSA to MADX sign convention
- Better trim naming
- check madx names for allowed characters
- option to init all variables
- machine settings info takes ISO time

- LSA to MADX sign convention
- Better trim naming
- check madx names for allowed characters
- option to init all variables
- machine settings info takes ISO time

## Version 0.7.2

Expand All @@ -59,9 +69,10 @@ Added a flag to the `info` functionality of `pylhc.kickgroups` to display a copy
## Version 0.6.1

Bugfixes in KickGroups:
- Better error message when there are no kicks in group.
- Find correct planes in lists of data.
- Renamed functions to `list` and `info`.

- Better error message when there are no kicks in group.
- Find correct planes in lists of data.
- Renamed functions to `list` and `info`.

## Version 0.6.0

Expand All @@ -76,10 +87,10 @@ Removed `irnl_rdt_correction`. Is now in https://github.com/pylhc/irnl_rdt_corre
Minor bugfixes in `machine_settings_info`.

- Added:
- `time` and `start_time` can now be given as `AccDatetime`-objects.
- `time` and `start_time` can now be given as `AccDatetime`-objects.

- Fixed:
- `trims` variable is initialized as `None`. Was not initialized if no
- `trims` variable is initialized as `None`. Was not initialized if no
trims were found, but used later on.


Expand All @@ -102,9 +113,11 @@ The return values are now organized into a dictionary.
Release `0.3.0` brings the following:

Added:

- Non-linear correction script for the (HL)LHC Insertion Regions Resonance Driving Terms, including feed-down effects.

Changed:

- The package's license has been moved from `GPLv3` to `MIT`.

Note: if one wishes to extend the `IRNL` correction script to a different accelerator,
Expand All @@ -117,16 +130,19 @@ there are valuable pointers in the following
This is the first release of `pylhc` since its `omc3` dependency is available on `PyPI`.

Added:

- BPM calibration script to get calibration factors from different BPMs
- Proper mocking of CERN TN packages (functionality imported from `omc3`)

Changed:

- Minimum required `tfs-pandas` version is now `3.0.2`
- Minimum required `generic-parser` version is now `1.0.8`
- Minimum required `omc3` version is now `0.2.0`
- Extras related to the CERN TN are now installed with `python -m pip install pylhc[cern]`

Removed:

- The `HTCondor` and `AutoSix` functionality have been removed and extracted to another package at https://github.com/pylhc/submitter


Expand Down
24 changes: 18 additions & 6 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,16 @@ def about_package(init_posixpath: pathlib.Path) -> dict:
napoleon_preprocess_types = True
napoleon_attr_annotations = True

# This is to keep the class-based autodoc implementation from sphinx < 9.0
# It allows us to build on members which needs other runtimes (such as some
# members requiring the JVM to be running for inspection due to jpype)
autodoc_use_legacy_class_based = True

# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ".rst"
source_suffix = {".rst": "restructuredtext"}

# The master toctree document.
master_doc = "index"
Expand Down Expand Up @@ -140,8 +142,8 @@ def about_package(init_posixpath: pathlib.Path) -> dict:

html_theme_options = {
"collapse_navigation": False,
"display_version": True,
"logo_only": False,
#'display_version': True, # show version in the sidebar (currently not working: https://github.com/readthedocs/sphinx_rtd_theme/issues/1624)
'logo_only': True, # if True, display only logo image, no project name
"navigation_depth": 2,
"style_external_links": True,
}
Expand Down Expand Up @@ -248,10 +250,20 @@ def about_package(init_posixpath: pathlib.Path) -> dict:
"PyQt5.QtCore",
"PyQt5.QtWidgets",
"matplotlib.backends.backend_qt5agg",
"jpype"
"pjlsa",
"pytimber",
]

autodoc_default_options = {
"members": True, # include members
"undoc-members": True, # add all members, even if they have no docstring
"show-inheritance": True, # e.g. ``class LHC(Accelerator)`` shows ``BaseClass: Accelerator``
# "no-index-entry": True, # don't add an index entry (toc_object_entries below works better for our use case)
}

toc_object_entries = False # do not create entries for domain objects (e.g. functions, classes, attributes, etc.).

# -- Instersphinx Configuration ----------------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
Expand Down
7 changes: 1 addition & 6 deletions doc/entrypoints/analysis.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
Analysis Tools
**************************
**************

.. automodule:: pylhc.bsrt_analysis
:members:
:noindex:


.. automodule:: pylhc.forced_da_analysis
:members:
:noindex:
4 changes: 1 addition & 3 deletions doc/entrypoints/bpm_calibration.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
BPM Calibration
**************************
***************

.. automodule:: pylhc.bpm_calibration
:members:
:noindex:
2 changes: 0 additions & 2 deletions doc/entrypoints/kickgroups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,3 @@ KickGroup Informations
**********************

.. automodule:: pylhc.kickgroups
:members:
:noindex:
2 changes: 0 additions & 2 deletions doc/entrypoints/lsa_to_madx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,3 @@ LSA Knobs to MAD-X Expressions Converter
****************************************

.. automodule:: pylhc.lsa_to_madx
:members:
:noindex:
6 changes: 0 additions & 6 deletions doc/entrypoints/machine_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,5 @@ Machine Information Tools
*************************

.. automodule:: pylhc.machine_settings_info
:members:
:noindex:


.. automodule:: pylhc.bsrt_logger
:members:
:noindex:

6 changes: 0 additions & 6 deletions doc/modules/calibration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,5 @@ BPM Calibration Utilities
**************************

.. automodule:: pylhc.calibration.beta
:members:
:noindex:


.. automodule:: pylhc.calibration.dispersion
:members:
:noindex:

16 changes: 1 addition & 15 deletions doc/modules/constants.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,13 @@
Constants Definitions
**************************
*********************


.. automodule:: pylhc.constants.general
:members:
:noindex:


.. automodule:: pylhc.constants.forced_da_analysis
:members:
:noindex:


.. automodule:: pylhc.constants.kickgroups
:members:
:noindex:


.. automodule:: pylhc.constants.machine_settings_info
:members:
:noindex:


.. automodule:: pylhc.constants.calibration
:members:
:noindex:
8 changes: 1 addition & 7 deletions doc/modules/data_extract.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
Data Extraction
**************************
***************

.. automodule:: pylhc.data_extract.lsa
:members:
:noindex:


.. automodule:: pylhc.data_extract.timber
:members:
:noindex:

2 changes: 1 addition & 1 deletion pylhc/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
__title__ = "pylhc"
__description__ = "An accelerator physics script collection for the OMC team at CERN."
__url__ = "https://github.com/pylhc/pylhc"
__version__ = "0.8.2"
__version__ = "0.8.3"
__author__ = "pylhc"
__author_email__ = "pylhc@github.com"
__license__ = "MIT"
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ classifiers = [
dependencies = [
"numpy >= 1.24",
"scipy >= 1.10",
"pandas >= 2.1",
"pandas[timezone] >= 2.1",
"matplotlib >= 3.8",
"tfs-pandas >= 3.8",
"generic-parser >= 1.1",
Expand Down
Loading