Skip to main content

BIHC

Ruff ty Documentation Status PyPI - Version nightly_tests_CPU_py3.14

Beam Induced Heating Computation (BIHC) tool is a package that allows the estimation of the dissipated power due to the passage of a particle beam inside an accelerator component.

The dissipated power value depends on the characteristics of the particle beam (beam spectrum and intensity) and on the characteristics of the consdiered accelerator component (beam-coupling impedance).

Check :file_folder: examples/ on how to use it!

Documentation is avaiable in bihc.readthedocs.io. More practical information and code snippets in the Users guide section.

For specific needs, please contact the maintainers :woman_technologist: :man_technologist: :wave:

:bookmark: Citing bihc

There is a paper about bihc, presented at 8th ICFA Advanced Beam Dynamics Workshop on High-Intensity and High-Brightness Hadron Beam (0ct. 2023). If you are using bihc in your scientific research, please help our scientific visibility by citing our work:

[1] E. de la Fuente, L. Sito, F. Giordano, G. Rumolo, B. Salvant, and C. Zannini, “A Python Package to Compute Beam-Induced Heating in Particle Accelerators and Applications,” JACoW, vol. HB2023, pp. 611–614, 2024, doi: https://doi.10.18429/JACoW-HB2023-THBP52.

Bibtex:

@article{Sito:2024ywv,
    author = "Sito, Leonardo and de la Fuente, Elena and Giordano, Francesco and Rumolo, Giovanni and Salvant, Benoit and Zannini, Carlo ",
    title = "{A Python Package to Compute Beam-Induced Heating in Particle Accelerators and Applications}",
    doi = "10.18429/JACoW-HB2023-THBP52",
    journal = "JACoW",
    volume = "HB2023",
    pages = "611--614",
    year = "2024"
}

:mag_right: About bihc python package

bihc is a computational package that integrates over a decade of experience in beam-induced heating calculations from the Impedance and Coherent Effects Section (see 1, 2, 3, 4, 5, 6) into a comprehensive and flexible Python-based tool.

The package has been presented at the 68th ICFA Advanced Beam Dynamics Workshop on High-Intensity and High-Brightness Hadron Beam (0ct. 2023)7, and is under continuous development to face the beam-induce heating challenges that become more relevant as the beam total intensity and bunch length is pushed.

bihc has been succesfully employed to assess the mitigation strategy for the CERN-SPS Beam Wire Scanners after the wire failure in 2023, and was extensively used to study the CERN-LHC Warm Vacuum modules limitations in intensity and bunch length for the 2024 run.

:zap: Installation

This section explains how to set up the environment to start using BIHC package for power loss computations. If you are using PyVista in your scientific research, please help our scientific visibility by citing our work:

Developers: Download BIHC repository from Github

# SSH:
git clone git@github.com:ImpedanCEI/BIHC.git

# or HTTPS:
git clone https://github.com/ImpedanCEI/BIHC.git

Users: pip install

pip install bihc

If already installed but want to have the newest version: pip install bihc --upgrade

Installation with pytimber in CERN lxplus

Connect to CERN lxplus via ssh. Avoid connecting to lxplus8, the code will induce in Kerberos issues. Kerberos logging will expire 4h after each connection and needs to be renewed.

ssh -X user@lxplus.cern.ch

In your /user or /work directory, do:

# If miniconda is not installed
# Get, install and activate miniconda
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
bash Miniconda3-latest-Linux-x86_64.sh
source miniconda3/bin/activate

# Get standard packages
# (to have all spark functionalities pandas needs to be installed before pytimber)
pip install numpy scipy matplotlib ipython pandas

# Change python package index to CERN index
pip install git+https://gitlab.cern.ch/acc-co/devops/python/acc-py-pip-config.git

# Install pytimber
pip install pytimber

# Change python package index back to default
pip uninstall acc-py-pip-config

Test the installation with

$ ipython
import pytimber
ldb = pytimber.LoggingDB(source="nxcals")
ldb.search('LHC%BEAM_ENERGY%')
ldb.get(ldb.search('LHC%BEAM_ENERGY%')[0], t1='2022-06-15 15:10:30.0000')

Nightly test badges

nightly_tests_CPU_py3.11 nightly_tests_CPU_py3.12 nightly_tests_CPU_py3.13 nightly_tests_CPU_py3.14

  1. B. Salvant et al., “Beam induced heating”, 2012, [Online]. Available: https://cds.cern.ch/record/1975499

  2. C. Zannini, et al. "Power Loss Calculation in Separated and Common Beam Chambers of the LHC". Proceedings of the 5th Int. Particle Accelerator Conf., vol. IPAC2014, 2014, p. 3 pages, 1.928 MB. DOI.org (Datacite), https://doi.org/10.18429/JACOW-IPAC2014-TUPRI061.

  3. C. Zannini, "Electromagnetic Simulation of CERN accelerator Components and Experimental Applications", 2013. [Online]. Available: https://cds.cern.ch/record/1561199

  4. C. Zannini, “Multiphysics Simulations of Impedance Effects in Accelerators,” CERN Yellow Rep. Conf. Proc., vol. 1, pp. 141–144, 2018, doi: 10.23732/CYRCP-2018-001.141.

  5. G. Rumolo, “Beam Instabilities”, 21 pages contribution to the CAS - CERN Accelerator School: Advanced Accelerator Physics Course, Trondheim, Norway, 2014, doi: 10.5170/CERN-2014-009.199. Available; https://cds.cern.ch/record/1982422

  6. F. Giordano, ‘Simulation Analysis and Machine Learning Based Detection of Beam-Induced Heating in Particle Accelerator at CERN’, University of Naples Federico II, 2020.

  7. L. Sito, E. de la Fuente, F. Giordano, G. Rumolo, B. Salvant, and C. Zannini, “A Python Package to Compute Beam-Induced Heating in Particle Accelerators and Applications,” in Proc. 68th Adv. Beam Dyn. Workshop High-Intensity High-Brightness Hadron Beams (HB’23), Geneva, Switzerland, Apr. 2024, no. 68, pp. 611–614. doi: 10.18429/JACoW-HB2023-THBP52.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bihc-0.1.3.tar.gz (32.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bihc-0.1.3-py3-none-any.whl (26.5 kB view details)

Uploaded Python 3

File details

Details for the file bihc-0.1.3.tar.gz.

File metadata

  • Download URL: bihc-0.1.3.tar.gz
  • Upload date:
  • Size: 32.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bihc-0.1.3.tar.gz
Algorithm Hash digest
SHA256 5bf9faae8339ce117fceec9177c570180ff3945bcb239951a233aab449654197
MD5 334f3103a5c5234571f75332530ef643
BLAKE2b-256 b6709a30d8d8143abfb638f0306998bdcd9ea53bd8e68daca148c0e248021e87

See more details on using hashes here.

Provenance

The following attestation bundles were made for bihc-0.1.3.tar.gz:

Publisher: publish.yml on ImpedanCEI/BIHC

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bihc-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: bihc-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 26.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bihc-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1f4883f169c6dcae293e5192ed07737f706f056dd43b593b85716b80fb360a90
MD5 77954bbcadbebf411f188c00d1c61a23
BLAKE2b-256 d1a4dba27719bac18692bc372f0af34b88ab5e923e593870d4bb80366f9fb2d4

See more details on using hashes here.

Provenance

The following attestation bundles were made for bihc-0.1.3-py3-none-any.whl:

Publisher: publish.yml on ImpedanCEI/BIHC

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page