diff --git a/README.md b/README.md index 64ae3a4f452895e0a7fb013ae1ce5a4bf61a39f7..d02ff7967251772c14ccd1fc9ac7a5567176a8ca 100644 --- a/README.md +++ b/README.md @@ -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 [](https://colab.research.google.com/github/GamelinAl/mbtrack2_examples/blob/main/mbtrack2_cavity_resonator.ipynb) + collective effects [](https://colab.research.google.com/github/GamelinAl/mbtrack2_examples/blob/main/mbtrack2_collective_effects.ipynb) + bunch by bunch feedback [](https://colab.research.google.com/github/GamelinAl/mbtrack2_examples/blob/main/mbtrack2_BxB_FB.ipynb) ++ RF loops and feedbacks [](https://colab.research.google.com/github/GamelinAl/mbtrack2_examples/blob/main/mbtrack2_RF_feedback.ipynb) References ---------- diff --git a/mbtrack2.yml b/mbtrack2.yml index 91f5371c6603f18e55f011965817514ef3bb4373..bfe63d93c3088d77c20939fb480ce61f1b1d1d3d 100644 --- a/mbtrack2.yml +++ b/mbtrack2.yml @@ -1,6 +1,6 @@ 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 diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index edc0f2b66355d3d3eff31f740033fe3e9d44ae83..0000000000000000000000000000000000000000 --- a/requirements.txt +++ /dev/null @@ -1,10 +0,0 @@ -numpy -pandas -scipy -h5py -mpi4py -matplotlib -seaborn -mpmath -ipykernel -accelerator-toolbox \ No newline at end of file