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_friendly API.

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:

Python 3.6 or higher: a dynamically typed programming language. [install]

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.8, etc.). If the above does not work, try using pip3 or python3 -m pip instead.

mud_friendly [C wrapper]: python access to MUD C functions
mdata [object]: access general MUD files pythonically
containers.mcontainer [object]: special container base class
containers.mdict [object]: enhanced dictionary class for sub-level lookup and attribute access
containers.mcomment [object]: special container for comments
containers.mhist [object]: special container for histograms
containers.mscaler [object]: special container for scalers
containers.mlist [object]: enhanced list class for sub-level lookup
containers.mvar [object]: special container for variables

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mud_py-1.2.11.tar.gz (73.4 kB view details)

Uploaded May 23, 2023 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

mud_py-1.2.11-py3-none-any.whl (38.1 kB view details)

Uploaded May 23, 2023 Python 3

File details

Details for the file mud_py-1.2.11.tar.gz.

File metadata

Download URL: mud_py-1.2.11.tar.gz
Upload date: May 23, 2023
Size: 73.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for mud_py-1.2.11.tar.gz
Algorithm	Hash digest
SHA256	`0a1bc88563c1be619b055d378b1bf011858c02e1baaba237da3b61a50cb4854d`
MD5	`242e2796450aabc744bff01ad977b782`
BLAKE2b-256	`1df6a77794602507ea9fe7bce076a3817cba9611c0599d7d33ca8837a9496f6f`

See more details on using hashes here.

File details

Details for the file mud_py-1.2.11-py3-none-any.whl.

File metadata

Download URL: mud_py-1.2.11-py3-none-any.whl
Upload date: May 23, 2023
Size: 38.1 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for mud_py-1.2.11-py3-none-any.whl
Algorithm	Hash digest
SHA256	`553739a43b6e3f2d71263db890b2e1baf48f1229dd92416f6a93ab751981487e`
MD5	`607886d0440e85b58b1e270d2e1fbcf8`
BLAKE2b-256	`24a74895148c7423306bd8bfb8c3d547b7bbc5d5ce6b4cee04072e9ca2582b7b`