pyEPR-ESR 1.0.2__tar.gz → 1.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pyepr_esr-1.2/.github/workflows/Build_Deploy_Docs.yml +41 -0
- pyepr_esr-1.2/.github/workflows/TestBuild_Docs.yml +36 -0
- pyepr_esr-1.2/.github/workflows/TestPyPI_Upload.yml +63 -0
- pyepr_esr-1.2/.github/workflows/python-publish.yml +98 -0
- pyepr_esr-1.2/.gitignore +138 -0
- pyepr_esr-1.2/.vscode/settings.json +14 -0
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/PKG-INFO +30 -20
- pyepr_esr-1.2/citation.rst +39 -0
- pyepr_esr-1.2/docsrc/API_docs.rst +149 -0
- pyepr_esr-1.2/docsrc/Makefile +20 -0
- pyepr_esr-1.2/docsrc/README.md +11 -0
- pyepr_esr-1.2/docsrc/_static/Hardware_Interface_Diagram.svg +583 -0
- pyepr_esr-1.2/docsrc/_static/autoapi.css +23 -0
- pyepr_esr-1.2/docsrc/_static/favicon.svg +135 -0
- pyepr_esr-1.2/docsrc/_static/favicon_16x16.png +0 -0
- pyepr_esr-1.2/docsrc/_static/favicon_32x32.png +0 -0
- pyepr_esr-1.2/docsrc/_static/gallery.css +6 -0
- pyepr_esr-1.2/docsrc/_static/pyepr_logo_dark.svg +135 -0
- pyepr_esr-1.2/docsrc/_static/pyepr_logo_light.svg +135 -0
- pyepr_esr-1.2/docsrc/_templates/autoapi/python/class.rst +150 -0
- pyepr_esr-1.2/docsrc/_templates/autoapi/python/function.rst +26 -0
- pyepr_esr-1.2/docsrc/citation.rst +1 -0
- pyepr_esr-1.2/docsrc/conf.py +108 -0
- pyepr_esr-1.2/docsrc/conf_old.py +103 -0
- pyepr_esr-1.2/docsrc/examples/GALLERY_HEADER.rst +4 -0
- pyepr_esr-1.2/docsrc/examples/advanced_sequences/GALLERY_HEADER.rst +4 -0
- pyepr_esr-1.2/docsrc/examples/advanced_sequences/advanced_sequence_axes.py +109 -0
- pyepr_esr-1.2/docsrc/examples/advanced_sequences/linking_sequence_parameter.py +46 -0
- pyepr_esr-1.2/docsrc/examples/advanced_sequences/uhrig_decoupling_sequence.py +95 -0
- pyepr_esr-1.2/docsrc/examples/automation/DEER_pump_frequency_sweep.py +37 -0
- pyepr_esr-1.2/docsrc/examples/automation/GALLERY_HEADER.rst +6 -0
- pyepr_esr-1.2/docsrc/examples/config_files/BrukerElexSys_config.yaml +22 -0
- pyepr_esr-1.2/docsrc/examples/config_files/Dummy_config.yaml +20 -0
- pyepr_esr-1.2/docsrc/examples/config_files/ETHmatlab_config.yaml +16 -0
- pyepr_esr-1.2/docsrc/examples/interfaces/ETH_AWG.py +4 -0
- pyepr_esr-1.2/docsrc/examples/interfaces/GALLERY_HEADER.rst +5 -0
- pyepr_esr-1.2/docsrc/examples/interfaces/PulseSpel_Compile.py +82 -0
- pyepr_esr-1.2/docsrc/examples/interfaces/PyEPR_Control_SuperConducting.py +4 -0
- pyepr_esr-1.2/docsrc/examples/interfaces/Xepr.py +19 -0
- pyepr_esr-1.2/docsrc/examples/tools/GALLERY_HEADER.rst +4 -0
- pyepr_esr-1.2/docsrc/examples/tools/loading_cw.py +19 -0
- pyepr_esr-1.2/docsrc/index.rst +50 -0
- pyepr_esr-1.2/docsrc/install.rst +212 -0
- pyepr_esr-1.2/docsrc/licence.rst +4 -0
- pyepr_esr-1.2/docsrc/make.bat +35 -0
- pyepr_esr-1.2/docsrc/releasenotes.rst +85 -0
- pyepr_esr-1.2/docsrc/tutorial.rst +56 -0
- pyepr_esr-1.2/docsrc/tutorial_hardware.md +97 -0
- pyepr_esr-1.2/docsrc/tutorial_loading.md +98 -0
- pyepr_esr-1.2/docsrc/tutorial_sequencer.md +121 -0
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/__init__.py +6 -3
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/classes.py +46 -221
- pyepr_esr-1.2/pyepr/colors.py +5 -0
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/criteria.py +2 -0
- pyepr_esr-1.2/pyepr/dataset.py +747 -0
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/fieldsweep_analysis.py +5 -0
- pyepr_esr-1.2/pyepr/hardware/BaseInterfaceClass.py +519 -0
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/hardware/Bruker_AWG.py +46 -14
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/hardware/Bruker_MPFU.py +4 -3
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/hardware/Bruker_tools.py +8 -18
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/hardware/ETH_awg.py +48 -22
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/hardware/ETH_awg_load.py +187 -7
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/hardware/PyEPR_control.py +256 -46
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/hardware/XeprAPI_link.py +17 -3
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/hardware/dummy.py +3 -2
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/hardware/dummy_xepr.py +1 -1
- pyepr_esr-1.2/pyepr/plotting.py +397 -0
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/pulses.py +392 -259
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/relaxation_analysis.py +14 -4
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/resonator_profile_analysis.py +183 -197
- pyepr_esr-1.2/pyepr/resonator_tune.py +67 -0
- pyepr_esr-1.2/pyepr/sequences/DEER.py +695 -0
- pyepr_esr-1.2/pyepr/sequences/ESEEM.py +211 -0
- pyepr_esr-1.2/pyepr/sequences/__init__.py +3 -0
- pyepr_esr-1.0.2/pyepr/sequences.py → pyepr_esr-1.2/pyepr/sequences/base_sequences.py +929 -223
- pyepr_esr-1.2/pyepr/sequences/calibration_sequences.py +0 -0
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/tools.py +36 -16
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/utils.py +14 -2
- pyepr_esr-1.2/pyproject.toml +50 -0
- pyepr_esr-1.2/setup.flake8 +2 -0
- pyepr_esr-1.2/tests/test_classes.py +120 -0
- pyepr_esr-1.2/tests/test_criteria.py +58 -0
- pyepr_esr-1.2/tests/test_dataset.py +148 -0
- pyepr_esr-1.2/tests/test_downconvert_dataset.py +138 -0
- pyepr_esr-1.2/tests/test_dummy.py +12 -0
- pyepr_esr-1.2/tests/test_fieldsweep.py +27 -0
- pyepr_esr-1.2/tests/test_pulses.py +10 -0
- pyepr_esr-1.2/tests/test_resonator_profile_analysis.py +14 -0
- pyepr_esr-1.2/tests/test_respro.py +135 -0
- pyepr_esr-1.2/tests/test_sequences.py +121 -0
- pyepr_esr-1.2/tests/test_utils.py +93 -0
- pyepr_esr-1.0.2/pyepr/colors.py +0 -3
- pyepr_esr-1.0.2/pyepr/dataset.py +0 -377
- pyepr_esr-1.0.2/pyepr/hardware/.DS_Store +0 -0
- pyepr_esr-1.0.2/pyproject.toml +0 -42
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/LICENSE +0 -0
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/README.md +0 -0
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/_version.py +0 -0
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/config.py +0 -0
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/hardware/__init__.py +0 -0
- {pyepr_esr-1.0.2 → pyepr_esr-1.2}/pyepr/hardware/xepr_experiments.py +0 -0
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
name: Build and Deploy Docs
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
|
|
6
|
+
jobs:
|
|
7
|
+
build:
|
|
8
|
+
runs-on: ubuntu-latest
|
|
9
|
+
|
|
10
|
+
permissions:
|
|
11
|
+
contents: write # needed to push to the gh-pages branch
|
|
12
|
+
|
|
13
|
+
steps:
|
|
14
|
+
- name: Checkout repository
|
|
15
|
+
uses: actions/checkout@v4
|
|
16
|
+
|
|
17
|
+
- name: Set up Python
|
|
18
|
+
uses: actions/setup-python@v5
|
|
19
|
+
with:
|
|
20
|
+
python-version: '3.12'
|
|
21
|
+
|
|
22
|
+
- name: Install uv
|
|
23
|
+
uses: astral-sh/setup-uv@v6
|
|
24
|
+
|
|
25
|
+
- name: Install dependencies
|
|
26
|
+
run: uv sync --extra doc
|
|
27
|
+
|
|
28
|
+
- name: Build documentation
|
|
29
|
+
run: uv run sphinx-build -b html docsrc/ docsrc/_build/html > sphinx_build.log 2>&1
|
|
30
|
+
- name: Upload build log
|
|
31
|
+
uses: actions/upload-artifact@v4.6.2
|
|
32
|
+
if: always()
|
|
33
|
+
with:
|
|
34
|
+
name: sphinx-build-log
|
|
35
|
+
path: sphinx_build.log
|
|
36
|
+
|
|
37
|
+
- name: Deploy to GitHub Pages
|
|
38
|
+
uses: peaceiris/actions-gh-pages@v4
|
|
39
|
+
with:
|
|
40
|
+
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
41
|
+
publish_dir: docsrc/_build/html
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
name: Test Build Docs
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- develop
|
|
7
|
+
- main
|
|
8
|
+
workflow_dispatch:
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
build:
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
|
|
14
|
+
steps:
|
|
15
|
+
- name: Checkout repository
|
|
16
|
+
uses: actions/checkout@v4
|
|
17
|
+
|
|
18
|
+
- name: Set up Python
|
|
19
|
+
uses: actions/setup-python@v5
|
|
20
|
+
with:
|
|
21
|
+
python-version: '3.12'
|
|
22
|
+
|
|
23
|
+
- name: Install uv
|
|
24
|
+
uses: astral-sh/setup-uv@v6
|
|
25
|
+
|
|
26
|
+
- name: Install dependencies
|
|
27
|
+
run: uv sync --extra doc
|
|
28
|
+
|
|
29
|
+
- name: Build documentation
|
|
30
|
+
run: uv run sphinx-build -b html docsrc/ docsrc/_build/html > sphinx_build.log 2>&1
|
|
31
|
+
- name: Upload build log
|
|
32
|
+
uses: actions/upload-artifact@v4.6.2
|
|
33
|
+
if: always()
|
|
34
|
+
with:
|
|
35
|
+
name: sphinx-build-log
|
|
36
|
+
path: sphinx_build.log
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
name: Publish Python 🐍 distribution 📦 to TestPyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
workflow_dispatch:
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
build:
|
|
12
|
+
name: Build distribution 📦
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
|
|
15
|
+
steps:
|
|
16
|
+
- uses: actions/checkout@v4
|
|
17
|
+
with:
|
|
18
|
+
persist-credentials: false
|
|
19
|
+
- name: Set up Python
|
|
20
|
+
uses: actions/setup-python@v5
|
|
21
|
+
with:
|
|
22
|
+
python-version: "3.x"
|
|
23
|
+
- name: Install pypa/build
|
|
24
|
+
run: >-
|
|
25
|
+
python3 -m
|
|
26
|
+
pip install
|
|
27
|
+
build
|
|
28
|
+
--user
|
|
29
|
+
- name: Build a binary wheel and a source tarball
|
|
30
|
+
run: python3 -m build
|
|
31
|
+
- name: Store the distribution packages
|
|
32
|
+
uses: actions/upload-artifact@v4
|
|
33
|
+
with:
|
|
34
|
+
name: python-package-distributions
|
|
35
|
+
path: dist/
|
|
36
|
+
|
|
37
|
+
publish-to-testpypi:
|
|
38
|
+
name: Publish Python 🐍 distribution 📦 to TestPyPI
|
|
39
|
+
needs:
|
|
40
|
+
- build
|
|
41
|
+
runs-on: ubuntu-latest
|
|
42
|
+
# PRs from forks cannot obtain an OIDC token for trusted publishing
|
|
43
|
+
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
|
|
44
|
+
|
|
45
|
+
environment:
|
|
46
|
+
name: testpypi
|
|
47
|
+
url: https://test.pypi.org/p/PyEPR-ESR
|
|
48
|
+
|
|
49
|
+
permissions:
|
|
50
|
+
id-token: write # IMPORTANT: mandatory for trusted publishing
|
|
51
|
+
|
|
52
|
+
steps:
|
|
53
|
+
- name: Download all the dists
|
|
54
|
+
uses: actions/download-artifact@v4
|
|
55
|
+
with:
|
|
56
|
+
name: python-package-distributions
|
|
57
|
+
path: dist/
|
|
58
|
+
- name: Publish distribution 📦 to TestPyPI
|
|
59
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
60
|
+
with:
|
|
61
|
+
verbose: true
|
|
62
|
+
repository-url: https://test.pypi.org/legacy/
|
|
63
|
+
skip-existing: true # re-runs on the same version would otherwise fail
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# This workflow will upload a Python Package to PyPI when a release is created
|
|
2
|
+
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
|
|
3
|
+
|
|
4
|
+
# This workflow uses actions that are not certified by GitHub.
|
|
5
|
+
# They are provided by a third-party and are governed by
|
|
6
|
+
# separate terms of service, privacy policy, and support
|
|
7
|
+
# documentation.
|
|
8
|
+
|
|
9
|
+
name: Upload Python Package
|
|
10
|
+
|
|
11
|
+
on:
|
|
12
|
+
release:
|
|
13
|
+
types: [published]
|
|
14
|
+
workflow_dispatch:
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
permissions:
|
|
18
|
+
contents: read
|
|
19
|
+
|
|
20
|
+
jobs:
|
|
21
|
+
release-build:
|
|
22
|
+
runs-on: ubuntu-latest
|
|
23
|
+
|
|
24
|
+
steps:
|
|
25
|
+
- uses: actions/checkout@v4
|
|
26
|
+
|
|
27
|
+
- uses: actions/setup-python@v5
|
|
28
|
+
with:
|
|
29
|
+
python-version: "3.x"
|
|
30
|
+
|
|
31
|
+
- name: Build release distributions
|
|
32
|
+
run: |
|
|
33
|
+
# NOTE: put your own distribution build steps here.
|
|
34
|
+
python -m pip install build
|
|
35
|
+
python -m build
|
|
36
|
+
|
|
37
|
+
- name: Upload distributions
|
|
38
|
+
uses: actions/upload-artifact@v4
|
|
39
|
+
with:
|
|
40
|
+
name: release-dists
|
|
41
|
+
path: dist/
|
|
42
|
+
|
|
43
|
+
pypi-publish:
|
|
44
|
+
runs-on: ubuntu-latest
|
|
45
|
+
needs:
|
|
46
|
+
- release-build
|
|
47
|
+
permissions:
|
|
48
|
+
# IMPORTANT: this permission is mandatory for trusted publishing
|
|
49
|
+
id-token: write
|
|
50
|
+
|
|
51
|
+
# Dedicated environments with protections for publishing are strongly recommended.
|
|
52
|
+
# For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
|
|
53
|
+
environment:
|
|
54
|
+
name: pypi
|
|
55
|
+
# OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
|
|
56
|
+
url: https://pypi.org/p/pyepr-esr
|
|
57
|
+
#
|
|
58
|
+
# ALTERNATIVE: if your GitHub Release name is the PyPI project version string
|
|
59
|
+
# ALTERNATIVE: exactly, uncomment the following line instead:
|
|
60
|
+
# url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
|
|
61
|
+
|
|
62
|
+
steps:
|
|
63
|
+
- name: Retrieve release distributions
|
|
64
|
+
uses: actions/download-artifact@v4
|
|
65
|
+
with:
|
|
66
|
+
name: release-dists
|
|
67
|
+
path: dist/
|
|
68
|
+
|
|
69
|
+
- name: Publish release distributions to PyPI
|
|
70
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
71
|
+
with:
|
|
72
|
+
packages-dir: dist/
|
|
73
|
+
|
|
74
|
+
publish-to-testpypi:
|
|
75
|
+
name: Publish Python 🐍 distribution 📦 to TestPyPI
|
|
76
|
+
needs:
|
|
77
|
+
- release-build
|
|
78
|
+
runs-on: ubuntu-latest
|
|
79
|
+
|
|
80
|
+
environment:
|
|
81
|
+
name: testpypi
|
|
82
|
+
url: https://test.pypi.org/p/pyepr-esr
|
|
83
|
+
|
|
84
|
+
permissions:
|
|
85
|
+
id-token: write # IMPORTANT: mandatory for trusted publishing
|
|
86
|
+
|
|
87
|
+
steps:
|
|
88
|
+
- name: Download all the dists
|
|
89
|
+
uses: actions/download-artifact@v4
|
|
90
|
+
with:
|
|
91
|
+
name: release-dists
|
|
92
|
+
path: dist/
|
|
93
|
+
- name: Publish distribution 📦 to TestPyPI
|
|
94
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
95
|
+
with:
|
|
96
|
+
repository-url: https://test.pypi.org/legacy/
|
|
97
|
+
skip-existing: true # version may already be on TestPyPI from the PR workflow
|
|
98
|
+
|
pyepr_esr-1.2/.gitignore
ADDED
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
pip-wheel-metadata/
|
|
24
|
+
share/python-wheels/
|
|
25
|
+
*.egg-info/
|
|
26
|
+
.installed.cfg
|
|
27
|
+
*.egg
|
|
28
|
+
MANIFEST
|
|
29
|
+
sg_execution_times.rst
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
# PyInstaller
|
|
33
|
+
# Usually these files are written by a python script from a template
|
|
34
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
35
|
+
*.manifest
|
|
36
|
+
*.spec
|
|
37
|
+
|
|
38
|
+
# Installer logs
|
|
39
|
+
pip-log.txt
|
|
40
|
+
pip-delete-this-directory.txt
|
|
41
|
+
|
|
42
|
+
# Unit test / coverage reports
|
|
43
|
+
htmlcov/
|
|
44
|
+
.tox/
|
|
45
|
+
.nox/
|
|
46
|
+
.coverage
|
|
47
|
+
.coverage.*
|
|
48
|
+
.cache
|
|
49
|
+
nosetests.xml
|
|
50
|
+
coverage.xml
|
|
51
|
+
*.cover
|
|
52
|
+
.hypothesis/
|
|
53
|
+
.pytest_cache/
|
|
54
|
+
|
|
55
|
+
# Translations
|
|
56
|
+
*.mo
|
|
57
|
+
*.pot
|
|
58
|
+
|
|
59
|
+
# Django stuff:
|
|
60
|
+
*.log
|
|
61
|
+
local_settings.py
|
|
62
|
+
db.sqlite3
|
|
63
|
+
db.sqlite3-journal
|
|
64
|
+
|
|
65
|
+
# Flask stuff:
|
|
66
|
+
instance/
|
|
67
|
+
.webassets-cache
|
|
68
|
+
|
|
69
|
+
# Scrapy stuff:
|
|
70
|
+
.scrapy
|
|
71
|
+
|
|
72
|
+
# Sphinx documentation
|
|
73
|
+
docsrc/_build/
|
|
74
|
+
docsrc/autoapi/
|
|
75
|
+
_build/
|
|
76
|
+
|
|
77
|
+
# PyBuilder
|
|
78
|
+
target/
|
|
79
|
+
|
|
80
|
+
# Jupyter Notebook
|
|
81
|
+
.ipynb_checkpoints
|
|
82
|
+
|
|
83
|
+
# IPython
|
|
84
|
+
profile_default/
|
|
85
|
+
ipython_config.py
|
|
86
|
+
|
|
87
|
+
# pyenv
|
|
88
|
+
.python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
#Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# celery beat schedule file
|
|
98
|
+
celerybeat-schedule
|
|
99
|
+
|
|
100
|
+
# SageMath parsed files
|
|
101
|
+
*.sage.py
|
|
102
|
+
|
|
103
|
+
# Environments
|
|
104
|
+
.env
|
|
105
|
+
.venv
|
|
106
|
+
env/
|
|
107
|
+
venv/
|
|
108
|
+
ENV/
|
|
109
|
+
env.bak/
|
|
110
|
+
venv.bak/
|
|
111
|
+
.venv*
|
|
112
|
+
|
|
113
|
+
# Spyder project settings
|
|
114
|
+
.spyderproject
|
|
115
|
+
.spyproject
|
|
116
|
+
|
|
117
|
+
# Rope project settings
|
|
118
|
+
.ropeproject
|
|
119
|
+
|
|
120
|
+
# mkdocs documentation
|
|
121
|
+
/site
|
|
122
|
+
|
|
123
|
+
# mypy
|
|
124
|
+
.mypy_cache/
|
|
125
|
+
.dmypy.json
|
|
126
|
+
dmypy.json
|
|
127
|
+
|
|
128
|
+
# Pyre type checker
|
|
129
|
+
.pyre/
|
|
130
|
+
|
|
131
|
+
.DS_Store
|
|
132
|
+
|
|
133
|
+
poetry.lock
|
|
134
|
+
*.lock
|
|
135
|
+
|
|
136
|
+
docsrc/auto_examples/
|
|
137
|
+
|
|
138
|
+
_pulsespel_output/
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{
|
|
2
|
+
"python.testing.pytestArgs": [
|
|
3
|
+
"tests"
|
|
4
|
+
],
|
|
5
|
+
"python.testing.unittestEnabled": false,
|
|
6
|
+
"python.testing.pytestEnabled": true,
|
|
7
|
+
"python-envs.pythonProjects": [
|
|
8
|
+
{
|
|
9
|
+
"path": ".",
|
|
10
|
+
"envManager": "ms-python.python:venv",
|
|
11
|
+
"packageManager": "ms-python.python:pip"
|
|
12
|
+
}
|
|
13
|
+
]
|
|
14
|
+
}
|
|
@@ -1,24 +1,35 @@
|
|
|
1
|
-
Metadata-Version: 2.
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
2
|
Name: pyEPR-ESR
|
|
3
|
-
Version: 1.
|
|
4
|
-
|
|
3
|
+
Version: 1.2
|
|
4
|
+
Author-email: Hugo Karas <hkaras@ethz.ch>, Gunnar Jeschke <gjeschke@eth.ch>, Stefan Stoll <stst@uw.edu>
|
|
5
5
|
License-File: LICENSE
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
Requires-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
Requires-Dist:
|
|
13
|
-
Requires-Dist:
|
|
14
|
-
Requires-Dist:
|
|
15
|
-
Requires-Dist:
|
|
16
|
-
Requires-Dist:
|
|
17
|
-
Requires-Dist:
|
|
18
|
-
|
|
19
|
-
Requires-Dist:
|
|
20
|
-
Requires-Dist:
|
|
21
|
-
|
|
6
|
+
Requires-Python: <4.0,>=3.11
|
|
7
|
+
Requires-Dist: deerlab<2.0,>=1.1.4
|
|
8
|
+
Requires-Dist: h5netcdf>1.4.0
|
|
9
|
+
Requires-Dist: h5py>3.15
|
|
10
|
+
Requires-Dist: matplotlib>=3.9.2
|
|
11
|
+
Requires-Dist: numpy<3.0,>=2.1
|
|
12
|
+
Requires-Dist: psutil>=7.1.3
|
|
13
|
+
Requires-Dist: pyyaml<7.0.0,>=6.0.2
|
|
14
|
+
Requires-Dist: requests>=2.32
|
|
15
|
+
Requires-Dist: scipy>=1.14.1
|
|
16
|
+
Requires-Dist: toml>=0.10.2
|
|
17
|
+
Requires-Dist: xarray>=2025
|
|
18
|
+
Provides-Extra: dev
|
|
19
|
+
Requires-Dist: gitpython<4.0.0,>=3.1.43; extra == 'dev'
|
|
20
|
+
Requires-Dist: pytest<9.0.0,>=8.3.3; extra == 'dev'
|
|
21
|
+
Provides-Extra: doc
|
|
22
|
+
Requires-Dist: furo>=2024.8.6; extra == 'doc'
|
|
23
|
+
Requires-Dist: myst-parser>=4.0.1; extra == 'doc'
|
|
24
|
+
Requires-Dist: numpydoc>=1.8.0; extra == 'doc'
|
|
25
|
+
Requires-Dist: sphinx-autoapi>=3.3.3; extra == 'doc'
|
|
26
|
+
Requires-Dist: sphinx-autobuild>=2025.8.25; extra == 'doc'
|
|
27
|
+
Requires-Dist: sphinx-copybutton>=0.5.2; extra == 'doc'
|
|
28
|
+
Requires-Dist: sphinx-design>=0.6.1; extra == 'doc'
|
|
29
|
+
Requires-Dist: sphinx-favicon>=1.0.1; extra == 'doc'
|
|
30
|
+
Requires-Dist: sphinx-gallery>=0.19.0; extra == 'doc'
|
|
31
|
+
Requires-Dist: sphinx-toolbox>=3.8.1; extra == 'doc'
|
|
32
|
+
Requires-Dist: sphinx>=8.1.3; extra == 'doc'
|
|
22
33
|
Description-Content-Type: text/markdown
|
|
23
34
|
|
|
24
35
|
# PyEPR
|
|
@@ -77,4 +88,3 @@ PyEPR is licensed under the GNU GPLv3 public license, and is released without
|
|
|
77
88
|
warranty or liability. Commercial use is allowed, however it is advised to contact the authors for support.
|
|
78
89
|
|
|
79
90
|
Copyright © 2021-2025: Hugo Karas, Stefan Stoll and Gunnar Jeschke
|
|
80
|
-
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
Citation
|
|
2
|
+
--------
|
|
3
|
+
|
|
4
|
+
Citation of scientific software is important to give credit to the developers and to help track the impact of the software in research.
|
|
5
|
+
|
|
6
|
+
To cite PyEPR in publications, please currently use the Zenodo general DOI:
|
|
7
|
+
|
|
8
|
+
.. image:: https://zenodo.org/badge/888368760.svg
|
|
9
|
+
:target: https://doi.org/10.5281/zenodo.17107010
|
|
10
|
+
:alt: DOI
|
|
11
|
+
|
|
12
|
+
Specific PyEPR versions will also have uniquie DOIs that can be found on the respective Zenodo release page.
|
|
13
|
+
The associated Zotero entry is available `here <https://doi.org/10.5281/zenodo.17107010>`_.
|
|
14
|
+
|
|
15
|
+
A paper describing PyEPR is currently in preparation and will be linked here once published.
|
|
16
|
+
|
|
17
|
+
Bibtex Entry
|
|
18
|
+
++++++++++++
|
|
19
|
+
|
|
20
|
+
.. code-block:: bibtex
|
|
21
|
+
|
|
22
|
+
@software{pyepr_2025,
|
|
23
|
+
author = {Hugo, Karas and
|
|
24
|
+
Jeschke, Gunnar and
|
|
25
|
+
Stoll, Stefan},
|
|
26
|
+
title = {JeschkeLab/PyEPR: Version 1.0},
|
|
27
|
+
month = sep,
|
|
28
|
+
year = 2025,
|
|
29
|
+
publisher = {Zenodo},
|
|
30
|
+
version = {v1.0},
|
|
31
|
+
doi = {10.5281/zenodo.17107011},
|
|
32
|
+
url = {https://doi.org/10.5281/zenodo.17107011},
|
|
33
|
+
swhid = {swh:1:dir:d3ae7fdd8041eb365003ea3e40db8bbb31a6c741
|
|
34
|
+
;origin=https://doi.org/10.5281/zenodo.17107010;vi
|
|
35
|
+
sit=swh:1:snp:5c1894da8cabcaf89397959130c3ff4badea
|
|
36
|
+
5b87;anchor=swh:1:rel:316cb6fc9c055bd7058460f5559a
|
|
37
|
+
8342d326ebd4;path=JeschkeLab-PyEPR-c194a75
|
|
38
|
+
},
|
|
39
|
+
}
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
.. rst-class:: api-docs
|
|
2
|
+
|
|
3
|
+
API doc
|
|
4
|
+
=================
|
|
5
|
+
Classes
|
|
6
|
+
----------------
|
|
7
|
+
|
|
8
|
+
Main Classes
|
|
9
|
+
~~~~~~~~~~~~
|
|
10
|
+
|
|
11
|
+
.. autoapisummary::
|
|
12
|
+
|
|
13
|
+
pyepr.pulses.Pulse
|
|
14
|
+
pyepr.criteria.Criteria
|
|
15
|
+
pyepr.classes.Parameter
|
|
16
|
+
pyepr.sequences.Sequence
|
|
17
|
+
|
|
18
|
+
Analysis Modules
|
|
19
|
+
~~~~~~~~~~~~~~~~
|
|
20
|
+
|
|
21
|
+
.. autoapisummary::
|
|
22
|
+
|
|
23
|
+
pyepr.FieldSweepAnalysis
|
|
24
|
+
pyepr.HahnEchoRelaxationAnalysis
|
|
25
|
+
pyepr.ResonatorProfileAnalysis
|
|
26
|
+
pyepr.CarrPurcellAnalysis
|
|
27
|
+
pyepr.ReptimeAnalysis
|
|
28
|
+
pyepr.AmplifierLinearityAnalysis
|
|
29
|
+
|
|
30
|
+
Sequences
|
|
31
|
+
~~~~~~~~~
|
|
32
|
+
|
|
33
|
+
Setup and Calibration Sequences
|
|
34
|
+
+++++++++++++++++++++++++++++++
|
|
35
|
+
.. _SetupSequences:
|
|
36
|
+
.. autoapisummary::
|
|
37
|
+
|
|
38
|
+
pyepr.sequences.HahnEchoSequence
|
|
39
|
+
pyepr.sequences.FieldSweepSequence
|
|
40
|
+
pyepr.sequences.ResonatorProfileSequence
|
|
41
|
+
pyepr.sequences.TWTProfileSequence
|
|
42
|
+
pyepr.sequences.T1InversionRecoverySequence
|
|
43
|
+
|
|
44
|
+
Relxation Sequences
|
|
45
|
+
+++++++++++++++++++++
|
|
46
|
+
.. _RelaxationSequences:
|
|
47
|
+
.. autoapisummary::
|
|
48
|
+
|
|
49
|
+
pyepr.sequences.HahnEchoRelaxationSequence
|
|
50
|
+
pyepr.sequences.CarrPurcellSequence
|
|
51
|
+
pyepr.sequences.T1InversionRecoverySequence
|
|
52
|
+
pyepr.sequences.ReptimeScanSequence
|
|
53
|
+
|
|
54
|
+
Dipolar EPR Sequences
|
|
55
|
+
+++++++++++++++++++++
|
|
56
|
+
.. _DipolarSequences:
|
|
57
|
+
|
|
58
|
+
.. autoapisummary::
|
|
59
|
+
|
|
60
|
+
pyepr.sequences.DEER.ThreePulseDEERSequence
|
|
61
|
+
pyepr.sequences.DEER.FourPulseDEERSequence
|
|
62
|
+
pyepr.sequences.DEER.FivePulseDEERSequence
|
|
63
|
+
|
|
64
|
+
Hyperfine Spectroscopy Sequences
|
|
65
|
+
++++++++++++++++++++++++++++++++
|
|
66
|
+
.. _HyperfineSequences:
|
|
67
|
+
|
|
68
|
+
.. autoapisummary::
|
|
69
|
+
|
|
70
|
+
pyepr.sequences.ESEEM.ThreePulseESEEMSequence
|
|
71
|
+
pyepr.sequences.ESEEM.HYSCORESequence
|
|
72
|
+
|
|
73
|
+
Pulses
|
|
74
|
+
~~~~~~
|
|
75
|
+
.. _Pulses:
|
|
76
|
+
|
|
77
|
+
.. autoapisummary::
|
|
78
|
+
|
|
79
|
+
pyepr.pulses.Pulse
|
|
80
|
+
pyepr.pulses.Detection
|
|
81
|
+
pyepr.pulses.RectPulse
|
|
82
|
+
pyepr.pulses.GaussianPulse
|
|
83
|
+
pyepr.pulses.ChirpPulse
|
|
84
|
+
pyepr.pulses.HSPulse
|
|
85
|
+
pyepr.pulses.SincPulse
|
|
86
|
+
pyepr.pulses.WURSTPulse
|
|
87
|
+
|
|
88
|
+
Termination Criteria
|
|
89
|
+
~~~~~~~~~~~~~~~~~~~~
|
|
90
|
+
|
|
91
|
+
Termination criteria are used for stopping sequences under specific conditions,
|
|
92
|
+
such as when a certain signal-to-noise ratio is reached or when a specific time has elapsed.
|
|
93
|
+
They are used through the :py:meth:`interface.terminate_at <pyepr.hardware.BaseInterfaceClass.Interface.terminate_at>` method.
|
|
94
|
+
|
|
95
|
+
.. autoapisummary::
|
|
96
|
+
|
|
97
|
+
pyepr.criteria.Criteria
|
|
98
|
+
pyepr.criteria.TimeCriteria
|
|
99
|
+
pyepr.criteria.SNRCriteria
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
Interfaces
|
|
103
|
+
~~~~~~~~~~
|
|
104
|
+
.. _Interfaces:
|
|
105
|
+
|
|
106
|
+
.. autoapisummary::
|
|
107
|
+
|
|
108
|
+
pyepr.hardware.BaseInterfaceClass.Interface
|
|
109
|
+
pyepr.hardware.Bruker_AWG.BrukerAWG
|
|
110
|
+
pyepr.hardware.Bruker_MPFU.BrukerMPFU
|
|
111
|
+
pyepr.hardware.ETH_awg.ETH_awg_interface
|
|
112
|
+
pyepr.hardware.PyEPR_control.PyEPRControlInterface
|
|
113
|
+
pyepr.hardware.XeprAPI_link.XeprAPILink
|
|
114
|
+
|
|
115
|
+
Utilities
|
|
116
|
+
~~~~~~~~~
|
|
117
|
+
|
|
118
|
+
.. autoapisummary::
|
|
119
|
+
|
|
120
|
+
pyepr.dataset.EPRAccessor
|
|
121
|
+
|
|
122
|
+
Functions
|
|
123
|
+
----------------
|
|
124
|
+
|
|
125
|
+
I/O
|
|
126
|
+
~~~
|
|
127
|
+
|
|
128
|
+
.. autoapisummary::
|
|
129
|
+
:nosignatures:
|
|
130
|
+
|
|
131
|
+
pyepr.tools.eprload
|
|
132
|
+
pyepr.utils.save_file
|
|
133
|
+
pyepr.dataset.create_dataset_from_sequence
|
|
134
|
+
pyepr.dataset.create_dataset_from_axes
|
|
135
|
+
pyepr.dataset.create_dataset_from_bruker
|
|
136
|
+
pyepr.dataset.downconvert_dataset
|
|
137
|
+
|
|
138
|
+
Utilities
|
|
139
|
+
~~~~~~~~~
|
|
140
|
+
|
|
141
|
+
.. autoapisummary::
|
|
142
|
+
:nosignatures:
|
|
143
|
+
|
|
144
|
+
pyepr.utils.transpose_dict_of_list
|
|
145
|
+
pyepr.utils.transpose_list_of_dicts
|
|
146
|
+
pyepr.utils.round_step
|
|
147
|
+
pyepr.utils.gcd
|
|
148
|
+
pyepr.utils.sop
|
|
149
|
+
pyepr.hardware.Bruker_tools.write_pulsespel_file
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Minimal makefile for Sphinx documentation
|
|
2
|
+
#
|
|
3
|
+
|
|
4
|
+
# You can set these variables from the command line, and also
|
|
5
|
+
# from the environment for the first two.
|
|
6
|
+
SPHINXOPTS ?=
|
|
7
|
+
SPHINXBUILD ?= sphinx-build
|
|
8
|
+
SOURCEDIR = .
|
|
9
|
+
BUILDDIR = _build
|
|
10
|
+
|
|
11
|
+
# Put it first so that "make" without argument is like "make help".
|
|
12
|
+
help:
|
|
13
|
+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
14
|
+
|
|
15
|
+
.PHONY: help Makefile
|
|
16
|
+
|
|
17
|
+
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
18
|
+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
19
|
+
%: Makefile
|
|
20
|
+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|