README

![spinner](spinner.png)

# Spinner: a spin system simulation library

This is Spinner, a collection of numerical routines for spin systems simulations. Spinner is free software, you can redistribute it and/or modify it under
the terms of the GNU General Public License. The GNU General Public License does not permit this software to be
redistributed in proprietary programs.

> **WARNING**: This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

> **WARNING**: This library is in early stage of development. Contributions are welcome.



## What has been implemented:

*

> **WARNING**: So far only the single spin-flip Metropolis and the cluster flip Wolff dynamics has been implemented, and the only interaction available is ferromagnetic.

> **NOTE**: Support for the Potts models and more interactions (long range, spin-glass, etc) is planned.

Read the [documentation](https://bertini97.gitlab.io/spinner/) for basic usage examples.