Metadata-Version: 2.1
Name: xibs
Version: 0.4.0
Summary: Prototype Intra-Beam Scattering implementation for Xsuite.
Project-URL: homepage, https://github.com/fsoubelet/xibs
Project-URL: repository, https://github.com/fsoubelet/xibs
Project-URL: documentation, https://fsoubelet.github.io/xibs
Author-email: Felix Soubelet <felix.soubelet@cern.ch>, Elias Waagaard <elias.walter.waagaard@cern.ch>, Michalis Zampetakis <Michalis.zampetakis@cern.ch>
License: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
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 :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.8
Requires-Dist: numpy>=1.21
Requires-Dist: scipy>=1.8
Provides-Extra: dev
Requires-Dist: black>=23.9; extra == 'dev'
Requires-Dist: isort>=5.10; extra == 'dev'
Requires-Dist: ruff>=0.0.290; extra == 'dev'
Provides-Extra: docs
Requires-Dist: cpymad>=1.14; extra == 'docs'
Requires-Dist: matplotlib>3.0; extra == 'docs'
Requires-Dist: sphinx-codeautolink<1.0; extra == 'docs'
Requires-Dist: sphinx-copybutton<1.0; extra == 'docs'
Requires-Dist: sphinx-gallery<1.0; extra == 'docs'
Requires-Dist: sphinx-issues>=3.0; extra == 'docs'
Requires-Dist: sphinx-panels<1.0; extra == 'docs'
Requires-Dist: sphinx-prompt>=1.5; extra == 'docs'
Requires-Dist: sphinx-rtd-theme>=1.0; extra == 'docs'
Requires-Dist: sphinx>=7.0; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex>=2.4; extra == 'docs'
Requires-Dist: xsuite; extra == 'docs'
Provides-Extra: test
Requires-Dist: coverage[toml]>=7.0; extra == 'test'
Requires-Dist: cpymad>=1.14; extra == 'test'
Requires-Dist: pytest-cov>=4.0; extra == 'test'
Requires-Dist: pytest-xdist>=3.0; extra == 'test'
Requires-Dist: pytest>=7.0; extra == 'test'
Requires-Dist: pyyaml>=6.0; extra == 'test'
Requires-Dist: xfields>=0.12; extra == 'test'
Requires-Dist: xtrack>=0.41; extra == 'test'
Description-Content-Type: text/markdown

# XIBS

<p>
  <!-- Github Release -->
  <a href="https://github.com/fsoubelet/xibs/releases">
    <img alt="Github Release" src="https://img.shields.io/github/v/release/fsoubelet/xibs?color=orange&label=Release&logo=Github">
  </a>

  <!-- PyPi Version -->
  <a href="https://pypi.org/project/xibs">
    <img alt="PyPI Version" src="https://img.shields.io/pypi/v/xibs?label=PyPI&logo=PyPI">
  </a>

  <!-- Github Actions Build -->
  <a href="https://github.com/fsoubelet/xibs/actions?query=workflow%3A%22Cron+Testing%22">
    <img alt="Github Actions" src="https://github.com/fsoubelet/xibs/workflows/Tests/badge.svg">
  </a>

  <!-- General DOI -->
  <a href="https://zenodo.org/badge/latestdoi/10044627.">
    <img alt="DOI" src="https://zenodo.org/records/10044627..svg">
  </a>
</p>

This repository contains the source for `xibs`, a prototype for Intra-Beam Scattering (IBS) modelling and computing to be later integrated into [Xsuite](https://github.com/xsuite).

> [!NOTE]
> This started as a fork of M. Zampetakis' work on a simple but physics-accurate
> [IBS implementation](https://github.com/MichZampetakis/IBS_for_Xsuite). The new
> package's code is quite different from the original but is benchmarked against
> it as well as other tools to ensure the validity of results.

See the [documentation](https://fsoubelet.github.io/xibs/) for details.

## Installing

Installation is easily done in your environment via `pip`:

```bash
python -m pip install xibs
```

## License

This project is licensed under the `Apache-2.0 License` - see the [LICENSE](LICENSE) file for details.
