This code depends on numpy and scipy and works only with Python 3.
For the functions written in Rust to be available, you need Rust on your system. See https://www.rust-lang.org/en-US/install.html.
Clone the repository into your favorite location. To set up the development
environment, run python setup.py develop --user.
Please refer to the docstrings of individual functions and classes.
All model specifications (hamiltonians and other model specific code) belong to "models" and all scripts, big and small, go into the "scripts" folder. Only reusable Python code goes into "spinsys". The "hamiltonians" directory exists to accommodate old code that depends on the old directory structure.
All Rust code goes into "rust".
All code in this repository is released under the BSD 3-clause license. For details please refer to LICENSE.txt.