About bmad-feedstock

Feedstock license: BSD-3-Clause

Home: https://www.classe.cornell.edu/bmad

Package license: GPL-3.0-or-later

Summary: Bmad is an object oriented, open source, subroutine library for relativistic charged-particle dynamics simulations in accelerators and storage rings.

Documentation: https://www.classe.cornell.edu/bmad/manual.html

Bmad has been developed at Cornell University's Laboratory for Elementary Particle Physics and has been in use since the mid 1990s. Bmad has a wide range of routines to do many things. Bmad can be used to study both single and multi-particle beam dynamics. It has routines to track both particles and macroparticles. Bmad has various tracking algorithms including Runge-Kutta and symplectic (Lie algebraic) integration. Wakefields, and radiation excitation and damping can be simulated. Bmad has routines for calculating transfer matrices, emittances, Twiss parameters, dispersion, coupling, etc.

Current build status

Azure

Variant Status linux_64_build_typedebugmpinompi linux_64_build_typedebugmpiopenmpi linux_64_build_typeproductionmpinompi linux_64_build_typeproductionmpiopenmpi osx_64_build_typedebugmpinompi osx_64_build_typedebugmpiopenmpi osx_64_build_typeproductionmpinompi osx_64_build_typeproductionmpiopenmpi osx_arm64_build_typedebugmpinompi osx_arm64_build_typedebugmpiopenmpi osx_arm64_build_typeproductionmpinompi osx_arm64_build_typeproductionmpiopenmpi

Current release info

Name	Downloads	Version	Platforms

Installing bmad

Installing bmad from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge
conda config --set channel_priority strict

Once the conda-forge channel has been enabled, bmad can be installed with conda:

conda install bmad

or with mamba:

mamba install bmad

It is possible to list all of the versions of bmad available on your platform with conda:

conda search bmad --channel conda-forge

or with mamba:

mamba search bmad --channel conda-forge

Alternatively, mamba repoquery may provide more information:

# Search all versions available on your platform:
mamba repoquery search bmad --channel conda-forge

# List packages depending on `bmad`:
mamba repoquery whoneeds bmad --channel conda-forge

# List dependencies of `bmad`:
mamba repoquery depends bmad --channel conda-forge

About conda-forge

conda-forge is a community-led conda channel of installable packages. In order to provide high-quality builds, the process has been automated into the conda-forge GitHub organization. The conda-forge organization contains one repository for each of the installable packages. Such a repository is known as a feedstock.

A feedstock is made up of a conda recipe (the instructions on what and how to build the package) and the necessary configurations for automatic building using freely available continuous integration services. Thanks to the awesome service provided by Azure, GitHub, CircleCI, AppVeyor, Drone, and TravisCI it is possible to build and upload installable packages to the conda-forge anaconda.org channel for Linux, Windows and OSX respectively.

To manage the continuous integration and simplify feedstock maintenance conda-smithy has been developed. Using the conda-forge.yml within this repository, it is possible to re-render all of this feedstock's supporting files (e.g. the CI configuration files) with conda smithy rerender.

For more information please check the conda-forge documentation.

Terminology

feedstock - the conda recipe (raw material), supporting scripts and CI configuration.

conda-smithy - the tool which helps orchestrate the feedstock. Its primary use is in the construction of the CI .yml files and simplify the management of many feedstocks.

conda-forge - the place where the feedstock and smithy live and work to produce the finished article (built conda distributions)

Updating bmad-feedstock

If you would like to improve the bmad recipe or build a new package version, please fork this repository and submit a PR. Upon submission, your changes will be run on the appropriate platforms to give the reviewer an opportunity to confirm that the changes result in a successful build. Once merged, the recipe will be re-built and uploaded automatically to the conda-forge channel, whereupon the built conda packages will be available for everybody to install and use from the conda-forge channel. Note that all branches in the conda-forge/bmad-feedstock are immediately built and any created packages are uploaded, so PRs should be based on branches in forks and branches in the main repository should only be used to build distinct package versions.

In order to produce a uniquely identifiable distribution:

• If the version of a package is not being increased, please add or increase the build/number.
• If the version of a package is being increased, please remember to return the build/number back to 0.

Feedstock Maintainers

• @ChristopherMayes
• @hhslepicka