ToDoList_EPRSuite.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# To-Do-List Suite for analyzing data from an EPR experiment\n",
    "\n",
    "#### 1) Advertisement and doumentation\n",
    "  \n",
    "&#10004; &emsp; Creation of an EPR Gihub webpage (https://github.com/TChauvire/EPR_ESR_Suite) <br />\n",
    "&#10006; &emsp; Documentation of the suite program <br />\n",
    "\n",
    "#### 2) Base functions: \n",
    "**The Idea here is to test existing program to optimize the future software.\n",
    "In a first option, a GUI software will be avoided as it can be time-consming to design...**\n",
    "\n",
    "&#10004; &emsp; import files python 2D/3D, stacked plot <br />\n",
    "&#10006; &emsp; Class definition: Data, data.smooth, data.fft for 2D/3D type of data and data.param <br />\n",
    "&#10006; &emsp; Fonction plot ??? (Axes, and styles) <br />\n",
    "&#10006; &emsp; Peak detection + FWHM measurement <br />\n",
    "&#10004; &emsp; Function export for preformatting for origin, text ascii type or other format <br />\n",
    "&#10006; &emsp; Function to export figure --> check vectoriel type of export <br />\n",
    "&#10004; &emsp; Function smooth, normalize, denoising --> contact Madhur for this last part <br />\n",
    "&#10006; &emsp; Interface to interact with MATLAB and especially easyspin <br />\n",
    "&#10006; &emsp; Background correction algorythm in 1D, 2D and N-D. <br />\n",
    "&#10006; &emsp; Fourier transform Suite (Windowing, zerofilling, fftshift) and application to 3P-ESEEM <br />\n",
    "&#10004; &emsp; Phase transformation to a first order <br />\n",
    "&#10006; &emsp; Fitting method: Gaussian peak, Lorenzian peak, TM, T1, ... ? <br />\n",
    "&#10006; &emsp; RMSE calculations --> check for some existing statistic tools and library <br />\n",
    "&#10006; &emsp; Export fitting parameters method <br />\n",
    "&#10006; &emsp; Error functions <br />\n",
    "&#10006; &emsp; Test function to evaluate bug in the Suite <br />\n",
    "\n",
    "**If everything is ready, implementation of some GUI type of software will be achieved.\n",
    "--> Check for already implemeted tools...**\n",
    "\n",
    "#### 3) Existing software or tools in Github\n",
    "\n",
    "  * [PySpec Suite from John Franck Lab (Syracuse University)](https://jmfrancklab.github.io/)\n",
    "    [GitHub Link here](https://github.com/jmfrancklab/pyspecdata)\n",
    "    [Documentation here](https://jmfrancklab.github.io/pyspecdata/index.html)\n",
    "       1) Pros : seems to be a very elaborated library of function adapted to EPR and ODNP (Overhauser Dynamic Nuclear Polarization NMR) experiments, but also for preformatting scientific report. \n",
    "       2) Cons : some scripts seems to be written in Python 2.7 b) the software is still in development.\n",
    "  * [madbitloman/lineshape-epr-esr](https://github.com/madbitloman/lineshape-epr-esr)\n",
    "  * Morten Albring repository: \n",
    "       1) Converter of DSC files in .csv) [mortenalbring/BES3Tconvert](https://github.com/mortenalbring/BES3Tconvert) \n",
    "       2) [mortenalbring/EPRSimDiff](https://github.com/mortenalbring/EPRsimDiff)\n",
    "\n",
    "#### 4) List of required library tools: \n",
    "\n",
    "  * Interaction with Matlab and Easyspin \n",
    "       1) [Full easyspin code on Github](https://github.com/StollLab/EasySpin/) \n",
    "       2) [Matlabwrapper tool for windows](https://github.com/Answeror/mlabwrap) and [sourceforge link](http://mlabwrap.sourceforge.net/)\n",
    "       3) [matlab-connection](https://pypi.org/project/matlab-connection/)\n",
    "       4) [python-matlab-bridge](https://arokem.github.io/python-matlab-bridge/) and [github link](https://github.com/arokem/python-matlab-bridge)\n",
    "       5) [pymatlab](https://pypi.python.org/pypi/pymatlab)\n",
    "\n",
    "  * Interaction with Matlab and DeerAnalysis \n",
    "       1) [spintoolbox](https://www.spintoolbox.com/en/offline-tools/deer-plot/)\n",
    "       2) [DEERplot](https://github.com/haditim/DEERplot)\n",
    "  \n",
    "#### 5) Extended project with interaction with X-EPR_API tools:\n",
    "\n",
    "  * [ExEPR](https://github.com/monadnoc/ExEPR)\n",
    "  * [Bruker_Xepr_DTA_to_ASCII_Batch_Converter](https://github.com/kippvs/Bruker_Xepr_DTA_to_ASCII_Batch_Converter)\n",
    "  * [rpbarnes/ElexsysComp](https://github.com/rpbarnes/ElexsysComp) (written with Python 2.7)\n",
    "\n",
    "#### 6) Instrumentation hardware tools: \n",
    "  \n",
    "  * [OE-FET/customxepr](https://github.com/OE-FET/customxepr)\n",
    "\n",
    "\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.7.7"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}