μLFC
μLFC is a small library to facilitate the evaluation of the local field
at the muon site. It is distributed as a standard library with C APIs
and a Python extension.
Install
The μLFC C library has no dependencies. CMake is used as a building tool.
Any C90 compiler can be used to build the library.
The details for the Python package follows.
Prerequisites
The python extension has the following dependencies:
Installation
The easiest way to install the Python extension is using pre-baked
wheels with pip:
pip install mulfc
Important note: when installing on Windows with pip
, the minimal
dependencies for Numpy are:
- Python 3.5 ➜ Numpy 1.10+
- Python 3.6 ➜ Numpy 1.12+
For Python versions different from the ones listed above muLFC is not
available as Python Wheels, you'll have to compile and install it from source.
Compilation
You may want to build the extension yourself, especially for optimizing performances.
To compile and install the C library just do
mkdir build
cd build
cmake ..
make
make install
To install the python extension you can do
cd python
python setup.py build
python setup.py test
python setup.py install
The library and the Python extension are independent from each other.
Usage
See muesr documentation or the documentation
in the header of the various functions' source code.