pylhc 0.0.1

Useful tools in particular for accelerator physicists at CERN

PyLHC Tools

This is the python-tool package of the optics measurements and corrections group (OMC).

If you are not part of that group, you will most likely have no use for the codes provided here, unless you have a 9km wide accelerator at home. Feel free to use them anyway, if you wish!

Documentation

• Autogenerated docs via sphinx can be found on https://pylhc.github.io/PyLHC/.
• General documentation of the OMC-Teams software on https://twiki.cern.ch/twiki/bin/view/BEABP/OMC

Getting Started

Prerequisites

The codes use a multitude of packages as can be found in the requirements.txt.

Important ones are: numpy, pandas and scipy.

Installing

This package is not deployed, hence you need to use the standard git-commands to get a local copy.

Description

This package provides tools which can be useful for working with accelerators, but are not neccessary for optics measurements analysis.

The latter tools can be found in OMC3 (Python 3.6) or Beta-Beat.src (Python 2.7)

Functionality

• Machine Settings Info - Prints an overview over the machine settings at a given time. (machine_settings_info.py)

Tests

• Pytest unit tests are run automatically after each commit via Travis-CI.

Maintainability

• Additional checks for code-complexity, design-rules, test-coverage, duplication on CodeClimate

• Direct commits to master are forbidden.

Authors

• pyLHC/OMC-Team - Working Group - pyLHC