mudpy
MUon (MUD) Data file IO package.
mudpy is a lightwieght Python package aimed to aid in the analysis of muon spin rotation (μSR) and β-detected nuclear magnetic/quadrupole resonance (β-NMR and β-NQR) data taken at TRIUMF. These techniques are similar to "conventional" nuclear magnetic resonance (NMR), but use radioactive nuclei or a muon as the NMR probe in place of a stable isotope.
The intended user of mudpy is anyone analyzing data in TRIUMF's MUD file format. A key goal of the project is to alleviate much of the technical tedium that is often encountered during any analysis.
mudpy has been written to fullfill the following needs:
- Provide a pythonic means of interfacing with MUD files in Python.
- Provide low-level wrappers of the
mud_friendlyAPI.
Citing
If you use mudpy in your work, please cite:
- D. Fujimoto. Digging Into MUD With Python: mudpy, bdata, and bfit. arXiv:2004.10395 [physics.data-an].
Community Guidelines
- Please submit contributions to mudpy via a pull request
- To report issues or get support, please file a new issue
Installation and Use
Dependencies
The following packages/applications are needed prior to installation:
Install Instructions
| Command | |
|---|---|
| From the PyPI as user (recommended) | pip install --user mud-py |
| From the PyPI as root | pip install mud-py |
| From source | python3 setup.py install |
Note the hyphen in mud-py. The pip command should point to a (version 3)
Python executable (e.g., python3, python3.9, etc. - python version must be >=3.9).
If the above does not work, try using pip3 or python3 -m pip instead.
Contents
mud_friendly[C wrapper]: python access to MUD C functionsmdata[object]: access general MUD files pythonicallycontainers.mcontainer[object]: special container base classcontainers.mdict[object]: enhanced dictionary class for sub-level lookup and attribute accesscontainers.mcomment[object]: special container for commentscontainers.mhist[object]: special container for histogramscontainers.mscaler[object]: special container for scalerscontainers.mlist[object]: enhanced list class for sub-level lookupcontainers.mvar[object]: special container for variables
1 maintainer
Metadata
1 maintainer
Release files for mud-py 1.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| mud_py-1.3.1.tar.gz | 75.6 kB | Without provenance | Details |
Release files / mud_py-1.3.1.tar.gz
| Download URL | mud_py-1.3.1.tar.gz |
|---|---|
| Size | 75.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ccb993585123f9d6079aff0d22d276b052679dc27d7dd80c3c5e43e13180d6a3
|
|
BLAKE2b-256 checksum How to use checksums |
683566c2923dac564243ef744ae2ca78f66460db4785bde54e8f5621b2a0cd06
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.12
|
Security for mud-py 1.3.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
