turn_by_turn 0.9.0__tar.gz

turn_by_turn-0.9.0/.gitignore

@@ -0,0 +1,252 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+doc/_build/
+doc_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints/
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/*
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### macOS template
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### JupyterNotebooks template
+# gitignore template for Jupyter Notebooks
+# website: http://jupyter.org/
+
+.ipynb_checkpoints
+*/.ipynb_checkpoints/*
+
+# Remove previous ipynb_checkpoints
+#   git rm -r .ipynb_checkpoints/
+#
+
+# VSCode
+.vscode
+.vscode/
+
+# Neovim
+.nvimlog
+
+/.idea/codeStyles/codeStyleConfig.xml
+/.idea/misc.xml
+/.idea/modules.xml
+/.idea/inspectionProfiles/profiles_settings.xml
+/.idea/vcs.xml
+/.idea/PyhDToolkit.iml

turn_by_turn-0.9.0/.zenodo.json

@@ -0,0 +1,49 @@
+{
+    "creators": [
+        {
+            "name": "OMC-Team",
+            "affiliation": "CERN"
+        },
+        {
+            "name": "Michael Hofer",
+            "affiliation": "CERN",
+            "orcid": "0000-0001-6173-0232"
+        },
+        {
+            "name": "Joschua Dilly",
+            "affiliation": "CERN",
+            "orcid": "0000-0001-7864-5448"
+        },
+        {
+            "name": "Felix Soubelet",
+            "affiliation": "University of Liverpool & CERN",
+            "orcid": "0000-0001-8012-1440"
+        },
+        {
+            "name": "Lukáš Malina",
+            "affiliation": "CERN",
+            "orcid": "0000-0002-4673-6035"
+        },
+        {
+            "name": "Maël Le Garrec",
+            "affiliation": "CERN",
+            "orcid": "0000-0002-8146-2340"
+        },
+        {
+            "name": "Jaime Maria Coello De Portugal - Martinez Vazquez",
+            "affiliation": "CERN",
+            "orcid": "0000-0002-6899-3809"
+        },
+        {
+            "name": "Rogelio Tomas Garcia",
+            "affiliation": "CERN",
+            "orcid": "0000-0002-9857-1703"
+        },
+        {
+            "name": "Tobias Persson",
+            "affiliation": "CERN"
+        }
+    ],
+    "title": "Turn-by-Turn",
+    "description": "Python 3 package I/O of turn-by-turn BPM measurements data from different particle accelerators."
+}

turn_by_turn-0.9.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 pylhc/OMC-Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

turn_by_turn-0.9.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: turn_by_turn
+Version: 0.9.0
+Summary: Read and write turn-by-turn measurement files from different particle accelerator formats.
+Project-URL: homepage, https://github.com/pylhc/turn_by_turn
+Project-URL: repository, https://github.com/pylhc/turn_by_turn
+Project-URL: documentation, https://pylhc.github.io/turn_by_turn/
+Author-email: OMC Team <pylhc@github.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: h5py>=2.9
+Requires-Dist: numpy>=1.24
+Requires-Dist: pandas>=2.1
+Requires-Dist: scipy>=1.5
+Requires-Dist: sdds>=0.4
+Provides-Extra: all
+Requires-Dist: pytest-cov>=2.9; extra == 'all'
+Requires-Dist: pytest>=7.0; extra == 'all'
+Requires-Dist: setuptools>=65; extra == 'all'
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'all'
+Requires-Dist: sphinx>=7.0; extra == 'all'
+Requires-Dist: tfs-pandas>=4.0.0; extra == 'all'
+Requires-Dist: xpart>=0.23.0; extra == 'all'
+Requires-Dist: xtrack>=0.84.7; extra == 'all'
+Provides-Extra: doc
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'doc'
+Requires-Dist: sphinx>=7.0; extra == 'doc'
+Provides-Extra: madng
+Requires-Dist: tfs-pandas>=4.0.0; extra == 'madng'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=2.9; extra == 'test'
+Requires-Dist: pytest>=7.0; extra == 'test'
+Requires-Dist: setuptools>=65; extra == 'test'
+Requires-Dist: tfs-pandas>=4.0.0; extra == 'test'
+Requires-Dist: xpart>=0.23.0; extra == 'test'
+Requires-Dist: xtrack>=0.84.7; extra == 'test'
+Provides-Extra: xtrack
+Requires-Dist: setuptools>=65; extra == 'xtrack'
+Requires-Dist: xpart>=0.23.0; extra == 'xtrack'
+Requires-Dist: xtrack>=0.84.7; extra == 'xtrack'
+Description-Content-Type: text/markdown
+
+# Turn-By-Turn
+
+[![Cron Testing](https://github.com/pylhc/turn_by_turn/workflows/Cron%20Testing/badge.svg)](https://github.com/pylhc/turn_by_turn/actions?query=workflow%3A%22Cron+Testing%22)
+[![Code Climate coverage](https://img.shields.io/codeclimate/coverage/pylhc/turn_by_turn.svg?style=popout)](https://codeclimate.com/github/pylhc/turn_by_turn)
+[![Code Climate maintainability (percentage)](https://img.shields.io/codeclimate/maintainability-percentage/pylhc/turn_by_turn.svg?style=popout)](https://codeclimate.com/github/pylhc/turn_by_turn)
+<!-- [![GitHub last commit](https://img.shields.io/github/last-commit/pylhc/turn_by_turn.svg?style=popout)](https://github.com/pylhc/turn_by_turn/) -->
+[![PyPI Version](https://img.shields.io/pypi/v/turn_by_turn?label=PyPI&logo=pypi)](https://pypi.org/project/turn_by_turn/)
+[![GitHub release](https://img.shields.io/github/v/release/pylhc/turn_by_turn?logo=github)](https://github.com/pylhc/turn_by_turn/)
+[![Conda-forge Version](https://img.shields.io/conda/vn/conda-forge/turn_by_turn?color=orange&logo=anaconda)](https://anaconda.org/conda-forge/turn_by_turn)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5554916.svg)](https://doi.org/10.5281/zenodo.5554916)
+
+This package provides reading functionality for turn-by-turn BPM measurements data from different particle accelerators.
+It also provides writing functionality in the `LHC`'s own SDDS format, through our `sdds` package.
+Files are read into a custom-made `TbtData` dataclass encompassing the relevant information.
+
+See the [API documentation](https://pylhc.github.io/turn_by_turn/) for details.
+
+## Installing
+
+Installation is easily done via `pip`:
+```bash
+python -m pip install turn_by_turn
+```
+
+One can also install in a `conda` environment via the `conda-forge` channel with:
+```bash
+conda install -c conda-forge turn_by_turn
+```
+
+## Example Usage
+
+ The package is imported as `turn_by_turn`, and exports top-level functions for reading and writing:
+```python
+import turn_by_turn as tbt
+
+# Loading a file is simple and returns a custom dataclass named TbtData
+data: tbt.TbtData = tbt.read("Beam2@BunchTurn@2018_12_02@20_08_49_739.sdds", datatype="lhc")
+
+# Easily access relevant information from the loaded data: transverse data, measurement date, 
+# number of turns, bunches and IDs of the recorded bunches
+first_bunch_transverse_positions: tbt.TransverseData = data.matrices[0]
+measurement_date = data.date  # a datetime.datetime object
+
+# Transverse positions are recorded as pandas DataFrames
+first_bunch_x = first_bunch_transverse_positions.X.copy()
+first_bunch_y = first_bunch_transverse_positions.Y.copy()
+
+# Do any operations with these as you usually do with pandas
+first_bunch_mean_x = first_bunch_x.mean()
+
+# Average over all bunches/particles at all used BPMs from the measurement
+averaged_tbt: tbt.TbtData = tbt.utils.generate_average_tbtdata(data)
+
+# Writing out to disk (in the LHC's SDDS format) is simple too, potentially with added noise
+tbt.write("path_to_output.sdds", averaged_tbt, noise=1e-5)
+```
+
+## License
+
+This project is licensed under the `MIT License` - see the [LICENSE](LICENSE) file for details.

turn_by_turn-0.9.0/README.md

@@ -0,0 +1,60 @@
+# Turn-By-Turn
+
+[![Cron Testing](https://github.com/pylhc/turn_by_turn/workflows/Cron%20Testing/badge.svg)](https://github.com/pylhc/turn_by_turn/actions?query=workflow%3A%22Cron+Testing%22)
+[![Code Climate coverage](https://img.shields.io/codeclimate/coverage/pylhc/turn_by_turn.svg?style=popout)](https://codeclimate.com/github/pylhc/turn_by_turn)
+[![Code Climate maintainability (percentage)](https://img.shields.io/codeclimate/maintainability-percentage/pylhc/turn_by_turn.svg?style=popout)](https://codeclimate.com/github/pylhc/turn_by_turn)
+<!-- [![GitHub last commit](https://img.shields.io/github/last-commit/pylhc/turn_by_turn.svg?style=popout)](https://github.com/pylhc/turn_by_turn/) -->
+[![PyPI Version](https://img.shields.io/pypi/v/turn_by_turn?label=PyPI&logo=pypi)](https://pypi.org/project/turn_by_turn/)
+[![GitHub release](https://img.shields.io/github/v/release/pylhc/turn_by_turn?logo=github)](https://github.com/pylhc/turn_by_turn/)
+[![Conda-forge Version](https://img.shields.io/conda/vn/conda-forge/turn_by_turn?color=orange&logo=anaconda)](https://anaconda.org/conda-forge/turn_by_turn)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5554916.svg)](https://doi.org/10.5281/zenodo.5554916)
+
+This package provides reading functionality for turn-by-turn BPM measurements data from different particle accelerators.
+It also provides writing functionality in the `LHC`'s own SDDS format, through our `sdds` package.
+Files are read into a custom-made `TbtData` dataclass encompassing the relevant information.
+
+See the [API documentation](https://pylhc.github.io/turn_by_turn/) for details.
+
+## Installing
+
+Installation is easily done via `pip`:
+```bash
+python -m pip install turn_by_turn
+```
+
+One can also install in a `conda` environment via the `conda-forge` channel with:
+```bash
+conda install -c conda-forge turn_by_turn
+```
+
+## Example Usage
+
+ The package is imported as `turn_by_turn`, and exports top-level functions for reading and writing:
+```python
+import turn_by_turn as tbt
+
+# Loading a file is simple and returns a custom dataclass named TbtData
+data: tbt.TbtData = tbt.read("Beam2@BunchTurn@2018_12_02@20_08_49_739.sdds", datatype="lhc")
+
+# Easily access relevant information from the loaded data: transverse data, measurement date, 
+# number of turns, bunches and IDs of the recorded bunches
+first_bunch_transverse_positions: tbt.TransverseData = data.matrices[0]
+measurement_date = data.date  # a datetime.datetime object
+
+# Transverse positions are recorded as pandas DataFrames
+first_bunch_x = first_bunch_transverse_positions.X.copy()
+first_bunch_y = first_bunch_transverse_positions.Y.copy()
+
+# Do any operations with these as you usually do with pandas
+first_bunch_mean_x = first_bunch_x.mean()
+
+# Average over all bunches/particles at all used BPMs from the measurement
+averaged_tbt: tbt.TbtData = tbt.utils.generate_average_tbtdata(data)
+
+# Writing out to disk (in the LHC's SDDS format) is simple too, potentially with added noise
+tbt.write("path_to_output.sdds", averaged_tbt, noise=1e-5)
+```
+
+## License
+
+This project is licensed under the `MIT License` - see the [LICENSE](LICENSE) file for details.

turn_by_turn-0.9.0/pyproject.toml

@@ -0,0 +1,86 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "turn_by_turn/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+  "/.github",
+  "/doc",
+  "/tests",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["turn_by_turn"]
+
+[project]
+name = "turn_by_turn"
+readme = "README.md"
+description = "Read and write turn-by-turn measurement files from different particle accelerator formats."
+authors = [
+    {name = "OMC Team", email = "pylhc@github.com"},  # see zenodo file / commits for details
+]
+license = "MIT"
+dynamic = ["version"]
+requires-python = ">=3.10"
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Science/Research",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+
+dependencies = [
+    "numpy >= 1.24",
+    "scipy >= 1.5",
+    "pandas >= 2.1",
+    "sdds >= 0.4",
+    "h5py >= 2.9",
+]
+
+[project.optional-dependencies]
+madng = [
+    "tfs-pandas >= 4.0.0",   # for reading MAD-NG files (Could do everything in memory with just pandas)
+]
+
+xtrack = [
+    "xtrack >= 0.84.7",      # for xtrack
+    "setuptools >= 65",      # for xtrack
+    "xpart >= 0.23.0",       # for xtrack
+]
+
+test = [
+    "pytest>=7.0",
+    "pytest-cov>=2.9",
+    "turn_by_turn[madng]",
+    "turn_by_turn[xtrack]",
+]
+
+doc = [
+    "sphinx >= 7.0",
+    "sphinx_rtd_theme >= 2.0",
+]
+
+all = [
+    "turn_by_turn[test]",
+    "turn_by_turn[doc]",
+    "turn_by_turn[madng]",
+    "turn_by_turn[xtrack]",
+]
+
+[project.urls]
+homepage = "https://github.com/pylhc/turn_by_turn"
+repository = "https://github.com/pylhc/turn_by_turn"
+documentation = "https://pylhc.github.io/turn_by_turn/"
+# changelog = "https://github.com/pylhc/turn_by_turn/blob/master/CHANGELOG.md"

turn_by_turn-0.9.0/turn_by_turn/__init__.py

@@ -0,0 +1,20 @@
+"""Exposes TbtData, read_tbt and write_tbt directly in the package's namespace."""
+
+from .io import convert_to_tbt, read_tbt, write_tbt
+from .structures import TbtData, TransverseData  # noqa: F401
+
+__title__ = "turn_by_turn"
+__description__ = "Read and write turn-by-turn measurement files from different particle accelerator formats."
+__url__ = "https://github.com/pylhc/turn_by_turn"
+__version__ = "0.9.0"
+__author__ = "pylhc"
+__author_email__ = "pylhc@github.com"
+__license__ = "MIT"
+
+# aliases
+write = write_tbt
+read = read_tbt
+convert = convert_to_tbt
+
+# Importing * is a bad practice and you should be punished for using it
+__all__ = []