Git Product home page Git Product logo

turn_by_turn's Introduction

PyLHC Tools

Cron Testing Code Climate coverage Code Climate maintainability (percentage) GitHub last commit GitHub release DOI

This package provides tools for particle accelerator physics complementing the optics measurement analysis tools of the omc3 package. It is a collection of useful scripts for the Optics Measurements and Corrections team (OMC) at CERN, with functionality for data analysis, corrections calculation, simulations management and machine information extraction.

Documentation

Installing

This package is Python 3.7+ compatible, and can be installed through pip:

python -m pip install pylhc

After installing, scripts can be run with either python -m pylhc.SCRIPT --FLAG ARGUMENT or by calling the Python files directly.

For development purposes, we recommend creating a new virtual environment and installing from VCS in editable mode with all extra dependencies:

git clone https://github.com/pylhc/pylhc
python -m pip install --editable "pylhc[all]"

Note: Some scripts access functionality only available on the CERN Technical Network. To use those, you should make sure to install the relevant extra dependencies with python -m pip install "pylhc[cern]".

Functionality

  • Forced DA Analysis - Script to analyze forced DA. (forced_da_analysis.py)
  • Machine Settings Info - Prints an overview over the machine settings at a given time. (machine_settings_info.py)
  • KickGroup Information - Get information about KickGroups. (kickgroups.py)
  • BSRT Logger and BSRT Analysis - Saves data coming straight from LHC BSRT FESA class and allows subsequent analysis. (bsrt_logger.py & bsrt_analysis.py )
  • BPM Calibration Factors - Compute the BPM calibration factors using ballistic optics. Two methods are available: using the beta function and using the dispersion. (bpm_calibration.py)

License

This project is licensed under the MIT License - see the LICENSE file for details.

turn_by_turn's People

Contributors

awegsche avatar fscarlier avatar fsoubelet avatar joschd avatar

Stargazers

avatar

Watchers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

turn_by_turn's Issues

[Bug]: Do not add '.sdds' if the file already ends with `.sdds`

Documentation

  • Yes

Operating System

Any

Python Version

Any

Package Version

0.3.0

Bug Description

.sdds is automatically added to any filename. I don't think any other writer does this.

Steps to Reproduce

No response

Relevant output

No response

Possible Fix Implementation

Change

turn_by_turn/turn_by_turn/io.py

Line 97 in 45f728b

sdds.write(sdds.SddsFile("SDDS1", None, definitions, values), f"{output_path}.sdds")

to either

str(output_path.with_suffix('.sdds'))
which removes other suffixes if present

or

if output_path.suffix != ".sdds":
    output_path = output_path.with_name(f"{output_path.name}.sdds")

(which keeps backwards compatibility)

or

remove completely and let the user do whatever he wants with the output (my preferred choice)

[Bug]: TbtData Creation Fail for empty bunch_ids and other remarks

Documentation

  • Yes

Operating System

Any

Python Version

Any

Package Version

0.3.0

Bug Description

TbtData initialization is not working when giving empty bunch ids

turn_by_turn/turn_by_turn/structures.py

Lines 33 to 51 in 45f728b

@dataclass
class TbtData:
"""
Object holding a representation of a Turn-by-Turn data measurement. The date of the measurement,
the transverse data, number of turns and bunches as well as the bunch IDs are encapsulated in this object.
"""
matrices: Sequence[TransverseData] # each entry corresponds to a bunch
date: datetime = None # will default in post_init
bunch_ids: List[int] = None # will default in post_init
nturns: int = 0
nbunches: int = field(init=False)
def __post_init__(self):
self.nbunches = len(self.bunch_ids)
if self.date is None:
self.date = datetime.today().replace(tzinfo=tz.tzutc()) # to today, UTC if nothing is given
if self.bunch_ids is None:
self.bunch_ids = []

len(self.bunch_ids) will fail with a TypeError as None has no length.

Writing is not working when nturns is not given, i.e. 0 but there is actually data,

Steps to Reproduce

import pandas as pd
from turn_by_turn import TbtData, TransverseData, write
import numpy as np

 # fails initializing
TbtData(matrices=[TransverseData(X=pd.DataFrame(np.random.random([4,5]),Y=pd.DataFrame([4,5]),),])

# fails writing
tbt = TbtData(matrices=[TransverseData(X=pd.DataFrame(np.random.random([4,5]),Y=pd.DataFrame([4,5]),),], bunch_ids=[])
write("test", tbt)

Relevant output

No response

Possible Fix Implementation

self.nbunches = len(self.matrices)
nturns should have no default, or default to len(self.matrices[0].X.columns)

but more remarks:
because of pylhc/sdds#49 empty arrays can't be written anyway,
so maybe it should be

self.bunch_ids = list(range(self.nbunches))
?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.