diff --git a/README.md b/README.md index 0543c4a668a8a195c236cc9d6fe7a828fdecd5bd..47e8f6c9a401185de12269ecd061757d2a9c6b7a 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,41 @@ mbtrack2 is composed of different modules allowing to easily write scripts for s Installation ------------ -TODO +Clone the mbtrack2 repo and enter the repo: +``` +git clone https://gitlab.synchrotron-soleil.fr/PA/collective-effects/mbtrack2.git +cd mbtrack2 +``` + +### Using conda + +To create a new conda environment for mbtrack2 run: + +``` +conda env create -f mbtrack2.yml +conda activate mbtrack2 +``` + +Or to update your current conda environment to be able to run mbtrack2: + +``` +conda env update --file mbtrack2.yml +``` + +To test your installation run: +``` +from mbtrack2 import * +``` + +### Using pip + +``` +pip install -r requirements.txt +``` +To test your installation run: +``` +from mbtrack2 import * +``` References ----------