Skip to content
Snippets Groups Projects
Commit 71de9837 authored by Alexis GAMELIN's avatar Alexis GAMELIN
Browse files

Update README.md

Update mbtrack2.yml
Remove requirements.txt
parent e33336e2
No related branches found
No related tags found
No related merge requests found
......@@ -7,14 +7,27 @@ mbtrack2 is composed of different modules allowing to easily write scripts for s
Installation
------------
### Using pip
Run:
```
pip install mbtrack2
```
To test your installation run:
```
from mbtrack2 import *
```
### Using conda
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:
```
......@@ -33,18 +46,6 @@ To test your installation run:
from mbtrack2 import *
```
### Using pip
Run:
```
pip install -r requirements.txt
```
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:
......@@ -52,6 +53,7 @@ Jupyter notebooks demonstrating mbtrack2 features are available in the example f
+ dealing with RF cavities and longitudinal beam dynamics [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/GamelinAl/mbtrack2_examples/blob/main/mbtrack2_cavity_resonator.ipynb)
+ collective effects [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/GamelinAl/mbtrack2_examples/blob/main/mbtrack2_collective_effects.ipynb)
+ bunch by bunch feedback [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/GamelinAl/mbtrack2_examples/blob/main/mbtrack2_BxB_FB.ipynb)
+ RF loops and feedbacks [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/GamelinAl/mbtrack2_examples/blob/main/mbtrack2_RF_feedback.ipynb)
References
----------
......
name: mbtrack2
dependencies:
- python>=3.6
- python>=3.9
- numpy
- pandas
- scipy
......@@ -9,7 +9,6 @@ dependencies:
- matplotlib
- seaborn
- mpmath
- ipykernel
- pip
- pip:
- accelerator-toolbox
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment