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]
Cython : C-language extensions for Python. [install]
NumPy : array programming library for Python. [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.1.1.tar.gz (232.4 kB view details)

Uploaded Mar 11, 2021 Source

File details

Details for the file mud-py-1.1.1.tar.gz.

File metadata

Download URL: mud-py-1.1.1.tar.gz
Upload date: Mar 11, 2021
Size: 232.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.2.0 pkginfo/1.4.2 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.8.0 tqdm/4.51.0 CPython/3.6.9

File hashes

Hashes for mud-py-1.1.1.tar.gz
Algorithm	Hash digest
SHA256	`9e24d92cfde965ed63f71d9e80fb391012c6c5574ac0a6d6e64e22093373f545`
MD5	`b90c4110d8f674daf41e5f0a0d0d0669`
BLAKE2b-256	`809df138630a7e37cf6a51e4a0476dff36c265e0eec41ef7d0c7363685a68cea`