Skip to content

JeschkeLab/PyEPR

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PyEPR

Features

Installation

It is recommend to install PyEPR in a virtual enviroment.

Dependencies

  • numpy
  • scipy
  • matplotlib
  • DeerLab
  • pyyaml
  • xarray
  • h5netcdf
  • toml

Requirements

PyEPR is generally compataible with Windows, Mac and Linux and requires Python 3.11 or 3.12. Support for new Python versions will only be added once they become stable, and have been fully tested with PyEPR. This can take some time, so please be patient. The specific hardware implememntation may add additional limitations for example, when using XeprAPI a Linux OS is needed.

Citation

PyEPR was developed as part of an academic research project. An academic paper is currently in preparation, and will be linked here once published. It is kindly requested that this paper is cited when using PyEPR in your research.

Citing academic software is important as it helps to ensure the long-term sustainability of the software, and allows the developers to track the impact of their work and secure future funding. It also helps to provide credit to the developers for their hard work.

License

PyEPR is licensed under the GNU GPLv3 public license, and is released without warrenty or liability. Comercial use is allowed, however it is advised to contact the authors for support.

Copyright © 2021-2024: Hugo Karas, Stefan Stoll, and Gunnar Jeschke