This repository will be updated soon.
To contribute please contact Tom Farley (Tom.Farley@ukaea.uk) and consider attending Coding Discussion Group meetings.
| MODULE | DESCRIPTION |
|---|---|
| data | Collections of general purpose functions for data analysis |
These packages are all available through pip/conda.
- Python 3.6+
- numpy
- scipy
- pandas
- xarray
- matplotlib
- cv2
- future
- natsort (optional, but recommended - may be buggy without)
- PyQt5 (optional, needed for GUI)
- plotly (optional, needed for some plots)
These packages are availble internally from https://git.ccfe.ac.uk.
- pyEquilibrium
- cyFieldlineTracer / pyFieldlineTracer
- pyIpx
- inference_tools (optional, needed for plotting error envelopes on fits)
Make sure you have your ssh key setup on ccfe gitlab (guide). Then to recursively download the repository and its CCFE dependencies:
git clone --recursive -j8 git@git.ccfe.ac.uk:tfarley/elzar.git
To install as a developer (so that the importable module tracks your local changes), from the top level elzar folder containing setup.py run:
pip install -e .
To install as a user (fixed version), from the top level elzar folder containing setup.py run:
pip install .