From 033c530d71aad6c831a221211fdd0f61c10bd31e Mon Sep 17 00:00:00 2001 From: Alexis GAMELIN <alexis.gamelin@synchrotron-soleil.fr> Date: Fri, 7 Jun 2024 12:19:51 +0200 Subject: [PATCH] Update README.md with docs badge --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 91f5396..283a333 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 -------- -- GitLab