Skip to content
Snippets Groups Projects
README.md 1.33 KiB
Newer Older
pnjun's avatar
pnjun committed
# Welcome to FAB (Flash Analyisis for Beamtimes)
Fabiano Lever's avatar
Fabiano Lever committed

The purpose of this library is to give users convenient access to the data generated at the Free Electron Laser FLASH.

It abstracs the details of loading the data, that would otherwise require accessing mutliple hdf5 files.
It also provides easy access to the Maxwell cluster resoruces, so that parallel computation can be performed efforlessly.

pnjun's avatar
pnjun committed
See the examples folder for a simple tutorial, or read the documentation at: https://hasfcpkg.desy.de/fab/fab.html
pnjun's avatar
pnjun committed
## Installation:
If you use fab on the Maxwell cluster, or through the jupyterhub, you can find fab
already installed in the 'flash' kernel (for jhub), or in the flash environment on maxwell.
To activate the envoronment, simply run: `module load flash flashenv` in your terminal.

NOTE: If you use vscode to ssh into maxwell, you can select the flash python interpreter 
by its path: `/software/ps/flash/envs/flash/bin/python`

### Manual Installation:
To install your own copy:

    git clone https://gitlab.desy.de/fabiano.lever/flashanalysis.git
pnjun's avatar
pnjun committed
    pip3 install -e flashanalysis

The `-e` flags installs it in editable mode, meaning that every time you update your repo by running `git pull` you will
pnjun's avatar
pnjun committed
update the installed library. If you do not want this, remove the `-e` flag.

## Contacts:
Fabiano Lever (FS-FLASH)

fabiano.lever@desy.de