Welcome to Cpymadtools’s Documentation!

This package is a lightweigth pythonic wrapper around cpymad, which was extracted from the pyhdtoolkit package. It enables convenient control of MAD-X simulations through the cpymad package.

Installation

cpymadtools is available to install from PyPI or from VCS. Install the package from PyPI:

python -m pip install cpymadtools

To install the latest development version of cpymadtools, you can use pip with the latest GitHub master:

python -m pip install git+https://github.com/beamopticsanalysis/cpymadtools.git

To set up a development environment, see the contributing instructions.

Contents

Citing

If you have a use of these codes, please consider citing them. The repository has a DOI provided by Zenodo, and all versions can be cited with the following BibTeX entry:

@software{cpymadtools,
  author       = {Felix Soubelet},
  title        = {beamopticsanalysis/cpymadtools},
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.7339939},
  url          = {https://github.com/beamopticsanalysis/cpymadtools}
}

Acknowledgments

This package is exctacted from PyhDToolkit, which was written by Felix Soubelet.

Others who have helped its development by contributing code, documentation, comments and/or ideas:

License

The package is licensed under the MIT license.