diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..0543c4a668a8a195c236cc9d6fe7a828fdecd5bd --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +mbtrack2 +======== + +mbtrack2 is a coherent object-oriented framework written in python to work on collective effects in synchrotrons. + +mbtrack2 is composed of different modules allowing to easily write scripts for single bunch or multi-bunch tracking using MPI parallelization in a transparent way. The base of the tracking model of mbtrack2 is inspired by mbtrack, a C multi-bunch tracking code initially developed at SOLEIL. + +Installation +------------ +TODO + +References +---------- +A. Gamelin, W. Foosang, and R. Nagaoka, “mbtrack2, a Collective Effect Library in Pythonâ€, presented at the 12th Int. Particle Accelerator Conf. (IPAC'21), Campinas, Brazil, May 2021, paper MOPAB070.