diff --git a/README.md b/README.md index 47e8f6c9a401185de12269ecd061757d2a9c6b7a..446d869c54d3d967b9210104f6099f332270f26a 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.