A python package containing tools and functions to evaluate local fields at the muon site for muon spin rotation and relaxation spectroscopy
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
examples added CuSe2O5 as a notebook Mar 30, 2018
muesr New style APIs also for clfc Mar 15, 2018
.gitattributes Updated travis and gitattributes for 0.1 release. Jan 27, 2018
.gitignore
.travis.yml Updated travis and gitattributes for 0.1 release. Jan 27, 2018
CHANGELOG.md Version tick and updated CHANGELOG Mar 4, 2018
LICENSE Initial commit May 17, 2016
MANIFEST.in examples will be distributed separately. Preparung for automatic deploy Jan 25, 2018
README.md Updated README and appdir Feb 24, 2018
TODO.md
appveyor.yml Only python 2.7 and 3.5 supported on Windows. Feb 18, 2018
requirements.txt Now mulfc is on pypi (and muesr will be there soon) Jan 14, 2018
setup.py Version tick and updated CHANGELOG Mar 4, 2018

README.md

Magnetic structure and mUon Embedding Site Refinement

Muesr is a tool for quickly evaluating local fields at the muon sites in Muon Spin Rotation and Relaxation experiments (muSR).

Requirements

Muesr works with the following minimal requirements:

package version url
python 2.7+ or 3 python.org
numpy 1.6+ numpy.org
lfclib 0.1 muLFC

Optional dependencies are:

package version url provides
spglib 1.8+ Spglib library for finding lattice structure symmetries
XCrysden any XCrysden tool for showing lattice and magnetic structures
sympy 1.0+ Sympy for symbolic Fourier components definition

Install and Usage

The easiest way to install muesr is using pip:

pip install -r requirements.txt muesr

For a detailed description see the documentation.

Known problems

  • Non-standard spacegroup settings can cause some tedious problems when using the spglib functions. Pay attention!

Please note that the code is still under development. You'll probably find bugs, please report them.

Authors & Contributors

Pietro Bonfa', Ifeanyi John Onuorah, Anthony Lim and Roberto De Renzi.

Notes and License

Part of the code in this repository comes from the ASE project. Where not differently specifies, the source code is provided under the GPLv3 license.