mcmc-statphys 0.1.2

A library project of Monte Carlo simulation algorithms for some statistical physics models (in particular, the Ising model and its variants).

mcmc_statphys

A Python package of Monte Carlo simulation algorithms for some statistical physics models (in particular, the Ising model and its variants).

• Free software: MIT license

• Documentation: https://mcmc-statphys.readthedocs.io.

Features

A simple Ising model simulation.

>>> import mcmc_statphys as mcsp
>>> import matplotlib.pyplot as plt # We have not yet produced a built-in plotting module. Stay tuned.
>>> model = mcsp.model.Ising(16)
>>> simulator = mcsp.method.Simulation(model)
>>> energy, magnetization, _ = simulator.metropolis_sample(T=1, max_iter=10000)
>>> plt.plot(energy)

Install the latest version of mcmc_statphys:

$ pip install mcmc_statphys

Bugs

Please report any bugs that you find here. Or, even better, fork the repository on GitHub and create a pull request (PR). We welcome all changes, big or small, and we will help you make the PR if you are new to git (just ask on the issue and/or see CONTRIBUTING).

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

[Unreleased]

[0.1.2] - 2023-05-15

Security

• Add function annotations to all functions

• Add type hints to all functions

• Add type hints to all variables

• Change mcmc_statphys.py to method.py

Doc

• Add documentation to README

[0.1.1] - 2023-05-14

• First release on PyPI.