Skip to content

Commit 060996a

Browse files
committed
Update README
1 parent 237410d commit 060996a

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
1-
# EPRpy 0.9.0
1+
# EPRpy
22

33
<img src="https://davistdaniel.github.io/EPRpy/_images/eprpy_logo.png" alt="eprpy_logo" width="300">
44

55
[![Static Badge](https://img.shields.io/badge/Version-0.9.0-blue?label=Version)](https://github.com/davistdaniel/EPRpy) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fdavistdaniel.github.io%2FEPRpy%2F&up_message=online&down_message=offline&label=Docs)](https://davistdaniel.github.io/EPRpy/) [![GitHub last commit](https://img.shields.io/github/last-commit/davistdaniel/EPRpy)](https://github.com/davistdaniel/EPRpy/commits/main/)
66

77
## About
88

9-
EPRpy is a python library to streamline handling, inspection and processing of Electron Paramagnetic resonance spectroscopic data.
10-
The library is born out of a collection of scripts I wrote for routine analysis of EPR data and simple presentation of results. EPRpy might be of use to you if you need to read, plot and export EPR data acquired on Bruker EPR spectrometers for quick analysis. EPRpy focusses on ease of use, generating quick plots for data inspection and features automated processing workflows for specific EPR experiments.
9+
EPRpy is a Python library designed to streamline the handling, inspection, and processing of Electron Paramagnetic Resonance (EPR) spectroscopic data. The library originated as a collection of scripts I wrote for routine analysis of EPR data acquired on Bruker EPR spectrometers during my academic work. EPRpy focusses on ease of use, enabling quick data visualization, data comparisons, and having transperent as well as highly customisable control over data analysis.
1110

1211
## Installation
1312

14-
### From source
13+
To install and use EPRpy, Python must be installed on your operating system. Python can be downloaded from the [official website](https://www.python.org/downloads/). EPRpy is compatible with Python 3.9 to 3.12 and can be installed with Python's package manager `pip`.
14+
15+
### Installing EPRpy from source
16+
1517
Clone the [EPRpy repository](https://davistdaniel.github.io/EPRpy/) and then navigate to the folder where setup.py file is present.
1618
Then, run in a terminal :
1719

@@ -23,13 +25,16 @@ For EPRpy documentation, see [here](https://davistdaniel.github.io/EPRpy/). Sour
2325

2426
## Features
2527

26-
* Read and export EPR data.
28+
* Read and export EPR data acquired on Bruker EPR spectrometers.
2729
* Basic processing capabilities such as interactive baseline correction, integration etc.
2830
* Generate quick plots of 1D and 2D datasets, compare different datasets.
2931

3032
## Upcoming
31-
* Automated workflows for specific EPR experiments
33+
* Automated workflow templates for specific EPR experiments
34+
* Documentation for visualization features.
3235

3336
## Limitations
3437
* Supports reading of files only in Bruker BES3T format v.1.2 and upto 2D datasets.
3538

39+
## License
40+
[MIT License](https://github.com/davistdaniel/EPRpy/blob/main/LICENSE)

0 commit comments

Comments
 (0)