-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
18,014 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
__version__ = "0.5_dev" | ||
__version__ = "0.7" |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,48 @@ | ||
|
||
Welcome to autoEPR & autoDEER! | ||
Welcome to autoDEER! | ||
==================================== | ||
|
||
.. caution:: | ||
This documentation is a work in progress and not yet complete. | ||
Please be patient and if anything is unclear, please contact the developers. | ||
Please be patient and if anything is unclear and please feel free to contact the developers. | ||
|
||
**autoEPR** is a free software package for the running of automated pulsed EPR | ||
experiments. It is designed to work with any arbitrary EPR sequence, including | ||
shaped pulses, on any modern spectrometer. | ||
autoDEER is a spectrometer independent Python package developed to enable push-button | ||
fully automated DEER. The program is built around a well established and tested optimised algorithum. | ||
It can be either interfaced using the user friendly GUI or via Python code. Additionally, the backend "autoEPR" can | ||
be used to build new projects. | ||
|
||
AutoEPR can be applied to many experiments in pulse EPR, currently, we are only | ||
working on an implementation for DEER, autoDEER. | ||
.. image:: _static/AbstractFigure.svg | ||
:align: center | ||
|
||
**autoDEER** is a specific implementation of autoEPR for the purpose of push-button | ||
automatic Double Electron Electron Resonance (DEER) spectroscopy. | ||
autoDEER's Key Features | ||
----------------------- | ||
|
||
.. image:: source/images/autoDEER&autoEPR.svg | ||
- Fully Automated Push Button DEER | ||
- Integrated Fitting | ||
- Spectrometer Independence | ||
- Intuitive Graphical User Interface | ||
- High Quality PDF Report Generator | ||
- and much more... | ||
|
||
.. warning:: | ||
autoEPR and autoDEER are actively developed software package, that is still very much a work in process. At this moment in time, we only recommend it is used by people who understand how | ||
the python code work and can debug when it goes wrong. Please consider this to be an alpha release, it is hoped that a more stable beta version can be released soon. | ||
autoDEER is an actively developed software package, that is still very much a work in process. Please consider this to be a beta release. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:hidden: | ||
:caption: User Guide | ||
|
||
./source/Install.rst | ||
./source/tutorial.rst | ||
./source/API_docs.rst | ||
./source/autoEPR/index.rst | ||
|
||
.. toctree:: | ||
:hidden: | ||
:caption: About | ||
|
||
./source/releasenotes.rst | ||
./source/contributing.rst | ||
Github <https://github.com/JeschkeLab/autoDEER> | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
The Automated Algorithum | ||
======================== | ||
|
||
When using the Graphical User Interface it is possible to use the full power of | ||
autoDEER by using the optimised automated algorithum. This has been developed | ||
to require minimal user input, and with a press of a button can measure the distance | ||
distribution of unknown sample. | ||
|
||
|
||
.. image:: ../_static/FlowDiagram.svg | ||
:alt: The Algorithum | ||
:align: center | ||
|
||
|
||
Steps Explained | ||
--------------- | ||
|
||
|
||
1. User Inputs | ||
************** | ||
Before the algorithum can start the user must provide some details. The most important of these being the approximate resonator frequency. Additionally, the user should specify how much time they have and give a sample name. The user can also specify the labelling efficency if they know it is not 100%. | ||
|
||
2. Fieldsweep | ||
************* | ||
The first experiment caried out is an Echo Detected Field Sweep (EDFS). This EDFS spectrum is then fitted and the fitter function will be used later in the optimisation of DEER pulses. | ||
|
||
3. SRT Scan | ||
*********** | ||
Now that an echo has been established, the next step is to optimise the shot repetition time (SRT). The SRT if optimised by running a Hahn Echo with increasing SRT, and a SRT is chose which allows for a 90% signal recovery. | ||
|
||
4. Resonator Profile | ||
******************** | ||
It is important to charecterise the frequency response of the resonator. This is need to clarify that the spectrum is located optimally. For rectangular pulsed experiments this can be used to identify the shortest possible pulse length, and for shaped and chirped pulses it can be used for resonator compensation. | ||
The profile is generated from a series of refocused echo nutation experiments, where the initial hard pulse is varied in length. The nutation profiles are carried out across a frequency range, the magnetic field is adjusted such that the system is always on resonance. | ||
|
||
5. Relaxation Studies | ||
********************** | ||
Relaxation studies are carried out by autoDEER primarily to identify the maximum inter-pulse delays for DEER experiments, but also to predict run times. | ||
All samples measure both a Hahn Echo decay and a Carr-Purcell 2 pulse echo decay. For 4pDEER only measurments a 2D refoucsed echo decay sequence needs to be measured to optimise the inter pulse delays. | ||
|
||
6. Optimising DEER Sequence Parameters | ||
************************************** | ||
Now all the sample characterisation and setup experiments have been completed, we can now generate the optimised parameters for running an initial DEER measurement | ||
|
||
Parameter | ||
+++++++++ | ||
- Pulse Sequence: Unless the maximum :math:`\tau_{evo}` is less than 1.5 :math:`\mu`s, the algorithum will use a 5pDEER sequence. This is because 5pDEER nearly always gives a higher sensitivity than 4pDEER. | ||
- :math:`\tau_1` and :math:`\tau_2`: These are calculated from the CP-decay or 2D refocused echo decay for the initial DEER or including the region of interest (ROI) for the final DEER. | ||
- dt: The step size for the time domain data is set to be either 16 ns or based from the region of interest (ROI) for the final DEER. | ||
- Pulse Shapes: If an AWG is avaliable, a Hyperbolic Secant (HS) pump pulse is used otherwise fully rectangular pulses are used. | ||
|
||
|
||
7. Initial DEER Experiment | ||
************************** | ||
An Initial 2-4 hour DEER measurement is carried out to determine the approximate distance distribution. This experiment is run until a SNR of 20 is reached. | ||
The distance distribution is then calculated using a model free appraoch and DeerLab. | ||
The distance distribution is then used to calculate the optimal :math:`\tau_{evo}` for the final DEER experiment. | ||
|
||
8. Final DEER Experiment | ||
************************ | ||
Finally, the final DEER experiment is carried out. The :math:`\tau_{evo}` comes from the ROI of the initial distance distribution unless it exceeds what can be achieved in the maximum time. | ||
Again the distance distribution is calculated using a model free appraoch and DeerLab. | ||
|
||
Limitations | ||
----------- | ||
|
||
At the moment the algorithum has only been designed to work on most common DEER experiments, so the following limitations apply: | ||
|
||
- Nitroxide Labeled Samples | ||
- Q Band |
2 changes: 1 addition & 1 deletion
2
docsrc/source/autoDEER/Jupyter_interface.rst → docsrc/source/Jupyter_interface.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters