Metadata-Version: 2.3
Name: hyperfine
Version: 0.0.4
Project-URL: Homepage, https://github.com/rmlmcfadden/hyperfine
Project-URL: Documentation, https://hyperfine.readthedocs.io/
Project-URL: Repository, https://github.com/rmlmcfadden/hyperfine.git
Project-URL: Issues, https://github.com/rmlmcfadden/hyperfine/issues
Author-email: "Ryan M. L. McFadden" <rmlm@triumf.ca>
License-Expression: MIT
License-File: LICENSE
Keywords: DPASS,SRIM,condensed matter,ion-implantation,materials science,superconductivity,β-NMR,μSR
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.8
Requires-Dist: iminuit>=2.24.0
Requires-Dist: joblib>=1.2.0
Requires-Dist: numpy>=1.23.0
Requires-Dist: pandas>=1.5.0
Requires-Dist: scipy>=1.10.0
Description-Content-Type: text/markdown

# `hyperfine`

`hyperfine` is a Python package providing miscellaneous tools to aid in
materials science studies using implanted-ion nuclear-decay spin probes,
such as [μSR] and [β-NMR].
The package's content and functionality largely reflect my scientific interests,
as well as the recent academic projects I've worked on
(see, e.g., my [Google Scholar profile]).
My hope is that some of the utilities implemented here will be useful for you,
too!

## Installing

From the repository:
```bash
python3 -m pip install . --user
```

[μSR]: https://doi.org/10.1038/s43586-021-00089-0
[β-NMR]: https://doi.org/10.1515/zpch-2021-3154
[Google Scholar profile]: https://scholar.google.ca/citations?hl=en&user=UIbyH7MAAAAJ
