Assorted small utilities for MC simulations with Cython.

Installation

  pip install git+https://github.com/ev-br/mc_lib.git

on Windows msvcompiler need to be installed

Usage

>>> from mc_lib.lattice import get_neighbors    # for sc and other lattices

and

%% cython --cplus
from mc_lib cimport RealObservable          # for statistics
from mc_lib.rndm cimport RndmWrapper        # For rndm.uniform in Cython

See examples/cy_ising.pyx for a usage example.

Note that RealObservable uses C++, so you'll need to compile your client Cython code to C++ not C. E.g. in a Jupyter notebook, use

%%cython --cplus
from mc_lib cimport RealObservable

Dependencies are cython, numpy >= 1.19.0 (needs np.random.Generator) and pytest for testing.

To build on Apple M1, need numpy >= 1.21.0 (which is the first numpy version to support this hardware).

Hat tip to Jake VanderPlas for his cython_template package.

Package Template for a Project Using Cython

This is a package template for a Python project using Cython. There are many different ways to build cython extensions within a project, as seen in the Cython documentation, but the best way to integrate Cython into a distributed package is not always clear.

This template borrows utility scripts used in the scipy and scikit-learn projects, which give the template a few nice features:

• Cython is required when the package is built, but not when the package is installed from a distributed source. That means that cython-generated C code is not included in the git repository, but is automatically included in any distribution. Further, it means that Cython is a requirement for package developers, but not for package users.
• The __check_build submodule includes scripts which detect whether the package has been properly built, and raise useful errors if this is not the case. This is especially important for when users try to import the package from the source directory without first building/compiling the cython sources.

Note that any "*.pyx" files added to the repository will have to be explicitly added to the setup.py file within the same directory: in most cases you should be able to simply copy the example setup.py within this repository.

This repository has a very permissive BSD license: please feel free to use the contents to help set up your own cython-driven packages!