diff --git a/README.md b/README.md index 91f5396d435e676eb63f009de105703a1c07b589..283a333c47cd304089ffab416d8c6713a5b1f960 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ mbtrack2 ======== +[](https://mbtrack2.readthedocs.io/en/latest/?badge=latest) + 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. Documentation for mbtrack2 can be found [here](https://mbtrack2.readthedocs.io/en/latest/index.html) +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. Examples --------