Package `spinparser`

Overview

This is the user documenation for the optional Python tools, which are included in the SpinParser software. See also the usage examples on the project's Github page.

The developer documentation for the SpinParser software itself can be found here.

Installation

In order to make the Python tools available, simply add the directory opt/python in your SpinParser installation to the $PYTHONPATH environment variable, such that the scripts can be found by the Python installation.

The following Python packages are prerequisite:

h5py
numpy
matplotlib

The prerequisites can be installed via invoking python -m pip install h5py numpy matplotlib.

Once installed, the Python tools provide access to two modules: spinparser.ldf and spinparser.obs. Their functionality is documented below.

Expand source code

"""
Overview
----------
This is the user documenation for the optional Python tools, which are included in the SpinParser software. 
See also the usage examples on the project's [Github page](https://github.com/fbuessen/SpinParser#evaluate-spinparser-output-and-measurements). 

**The developer documentation for the SpinParser software itself can be found [here](../doc-dev/index.html).**

Installation
----------
In order to make the Python tools available, simply add the directory `opt/python` in your SpinParser installation to the `$PYTHONPATH` environment variable, such that the scripts can be found by the Python installation.

The following Python packages are prerequisite:

- `h5py`
- `numpy`
- `matplotlib`

The prerequisites can be installed via invoking `python -m pip install h5py numpy matplotlib`.

Once installed, the Python tools provide access to two modules: `spinparser.ldf` and `spinparser.obs`. 
Their functionality is documented below. 
"""

Sub-modules

spinparser.ldf: Visualization tools for lattice graphs that are stored in the ".ldf" file format. Useful to inspect lattice spin models used in SpinParser calculations.
spinparser.obs: Collection of functions to import data from ".obs" files generated by SpinParser. Provides convenient access to lattice geometry, spin correlations, …