From 101e4bd852ff371e3cdcd79399743bb4638b43e8 Mon Sep 17 00:00:00 2001 From: Alexis GAMELIN <alexis.gamelin@synchrotron-soleil.fr> Date: Thu, 31 Mar 2022 16:52:42 +0200 Subject: [PATCH] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 47e8f6c..446d869 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,8 @@ from mbtrack2 import * ### Using pip +Run: + ``` pip install -r requirements.txt ``` @@ -43,6 +45,11 @@ To test your installation run: from mbtrack2 import * ``` +Examples +-------- +Jupyter notebooks demonstrating mbtrack2 features are available in the example folder and can be opened online using google colab: ++ mbtrack2 base features [](https://colab.research.google.com/github/GamelinAl/mbtrack2_examples/blob/main/mbtrack2_demo.ipynb) + 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. -- GitLab