pyDFCSR

Fast 2D/3D CSR simulation with Python

Installation

Requirements

• distgen
• h5py
• matplotlib
• mpi4py
• numba
• numpy 1.x
• pytorch
• pyyaml
• scipy
• Bmad-X

For the examples:

• jupyterlab
• ipympl

Using conda

To install pyDFCSR using conda, perform the following:

git clone https://github.com/jy-tang/pyDFCSR
cd pyDFCSR
conda env create -n pydfcsr -f environment.yml
conda activate pydfcsr

The new environment pydfcsr contains JupyterLab. You can then try the examples in the directory pyDFCSR_2D/example/.

cd pyDFCSR_2D/example
jupyter lab

Developing pyDFCSR

To develop pyDFCSR, perform the following after setting up the environment as in the previous section:

cd /path/to/pyDFCSR  # replace this with the top-level directory of your clone
python -m pip install -e .

The pip install line will make a "development" install of this library so that you don't have to reinstall the library after each modification to its code.