mmg_toolbox
Repository for useful python data analysis functions for the Diamond Magnetic Materials Group
| Source | https://github.com/DiamondLightSource/mmg_toolbox |
|---|---|
| PyPI | pip install mmg_toolbox |
| Documentation | https://diamondlightsource.github.io/mmg_toolbox |
| Releases | https://github.com/DiamondLightSource/mmg_toolbox/releases |
Installation
Requires: Python >=3.10, Numpy, h5py, matplotlib, hdfmap, nexus2srs
python -m pip install mmg_toolbox
@DLS
mmg_toolbox is available via the module system:
$ module load mmg
(python)$ dataviewer
# OR
(python)$ create_notebooks
Usage - Read a NeXus scan file
Read data from a NeXus scan file in a python prompt or script
from mmg_toolbox import data_file_reader
scan = data_file_reader('12345.nxs', beamline='i16')
print(scan) # print a metadata string
scan.plot.plot() # plot defaults
scan.plot.show()
Usage - DataViewer
Start the dataviewer from a terminal
$ dataviewer
Or, to open the data viewer in the current folder:
$ dataviewer .
Or, to open the file viewer for a specific file:
dataviewer path/to/file.nxs
Usage - Scripting
mmg_toolbox contains many useful tools for data analysis in python scripts, for example:
import matplotlib.pyplot as plt
from mmg_toolbox import Experiment
exp = Experiment('/path/to/files')
# list scans
all_scans = exp.all_scan_numbers() # {scan_number: filename}
print('\n'.join(exp.scans_str(*all_scans)))
exp.plot(1108746, 1108747, 1108748)
scans = exp.scans(*range(-10, 0))
for scan in scans:
scan.plot()
axes, signal = scan.eval('axes, signal')
create_notebooks
the create_notebooks script is included as a simple way to get started and create some default scripts in your working directory. By default you will be prompted to provide a beamline and a directory or visit ID. The script can then start a Jupyter Lab instance in that directory.
| command | |
|---|---|
$ create_notebooks |
interactively create scripts and start jupyter |
$ create_notebooks -b i10-1 . |
create i10-1 specific scripts in the current directory |
$ create_notebooks --help |
additional options |
Dataviewer
mmg_toolbox contains a tkinter based dataviewer for viewing data in NeXus files. Various plotting and processing
capabilities are available.
Feedback
mmg_toolbox is still under development, so if you have any feedback, found any bugs or have any feature requests - please do let me know!
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mmg_toolbox-0.6.5.tar.gz.
File metadata
- Download URL: mmg_toolbox-0.6.5.tar.gz
- Upload date:
- Size: 252.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
13d19e311a41938dd78727fb9786a3ac481b3d9bf68460e14fa895023132da7f
|
|
| MD5 |
5280f5356804cfcb152bfce063bc5866
|
|
| BLAKE2b-256 |
1b4fa02510130ec55779285475a346c88c6ba745a2ba0d02024d4c77cef3e97c
|
Provenance
The following attestation bundles were made for mmg_toolbox-0.6.5.tar.gz:
Publisher:
pypi-publish.yml on DiamondLightSource/mmg_toolbox
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mmg_toolbox-0.6.5.tar.gz -
Subject digest:
13d19e311a41938dd78727fb9786a3ac481b3d9bf68460e14fa895023132da7f - Sigstore transparency entry: 2343792681
- Sigstore integration time:
-
Permalink:
DiamondLightSource/mmg_toolbox@cab4294a926fa1922e6afda1bc8900ab535027de -
Branch / Tag:
refs/tags/v0.6.5b - Owner: https://github.com/DiamondLightSource
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi-publish.yml@cab4294a926fa1922e6afda1bc8900ab535027de -
Trigger Event:
push
-
Statement type:
File details
Details for the file mmg_toolbox-0.6.5-py3-none-any.whl.
File metadata
- Download URL: mmg_toolbox-0.6.5-py3-none-any.whl
- Upload date:
- Size: 291.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8522fb2a783add986c7b34b9d9feaced1b1f9f74ece7a930d5d3ad1a76cfca1f
|
|
| MD5 |
2bb629990f90a3566936dee4f1ab5af1
|
|
| BLAKE2b-256 |
239ea50a7e074b46bd8295c10d559c14071af8d87f10d67ebd58815af2cdaeb7
|
Provenance
The following attestation bundles were made for mmg_toolbox-0.6.5-py3-none-any.whl:
Publisher:
pypi-publish.yml on DiamondLightSource/mmg_toolbox
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mmg_toolbox-0.6.5-py3-none-any.whl -
Subject digest:
8522fb2a783add986c7b34b9d9feaced1b1f9f74ece7a930d5d3ad1a76cfca1f - Sigstore transparency entry: 2343792695
- Sigstore integration time:
-
Permalink:
DiamondLightSource/mmg_toolbox@cab4294a926fa1922e6afda1bc8900ab535027de -
Branch / Tag:
refs/tags/v0.6.5b - Owner: https://github.com/DiamondLightSource
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi-publish.yml@cab4294a926fa1922e6afda1bc8900ab535027de -
Trigger Event:
push
-
Statement type:
