=============
mcmc_statphys
=============
.. image:: https://img.shields.io/pypi/v/mcmc_statphys.svg
:target: https://pypi.python.org/pypi/mcmc_statphys
.. image:: https://img.shields.io/travis/uynajgi/mcmc_statphys.svg
:target: https://travis-ci.com/uynajgi/mcmc_statphys
.. image:: https://readthedocs.org/projects/mcmc-statphys/badge/?version=latest
:target: https://mcmc-statphys.readthedocs.io/en/latest/?version=latest
:alt: Documentation Status
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.
.. code-block:: python
>>> import mcmc_statphys as mcsp
>>> model = mcsp.model.Ising(12) # 12x12 Ising model
>>> algorithm = mcsp.method.Metropolis(model) # Metropolis algorithm
>>> uid = algorithm.equil_sample(T=1, max_iter=1000) # sample until equilibrium
>>> fig = mcsp.draw.Plot(algorithm)
>>> fig.curve(uid=uid, comlumn='energy') # plot the energy curve
Install
-------
the latest version of mcmc_statphys:
.. code-block:: console
$ pip install mcmc_statphys
upgrade to the latest version:
.. code-block:: console
$ pip install --upgrade 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`_).
.. _here: https://github.com/uynajgi/mcmc_statphys/issues
.. _GitHub: https://github.com/uynajgi/mcmc_statphys/
.. _CONTRIBUTING: https://mcmc-statphys.readthedocs.io/en/latest/contributing.html
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
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.4.0] - 2023-05-20
--------------------
Added
~~~~~
* Add `imshow` in `draw`
* Add `animate` in `draw`
Fixed
~~~~~
* Fix: `Wolff` and `Anneal` uid does not return
[0.3.0] - 2023-05-18
--------------------
Added
~~~~~
* Add `cv` in `analysis` to calculate the cv
* Add `spin2svd` in `analysis`
* Add `uid2svd` in `analysis`
[0.2.1] - 2023-05-17
--------------------
Fixed
~~~~~
* Fix the bug of saving `_get_per_magnetization` in `_save_data` in `algorithm`
Added
~~~~~
* Add moudle `analysis` to analyze the data
* Add moudle `draw` to draw the figures
* Add method `setspin` in `model`
* Add tqmd to show the progress bar
Doc
~~~
* Add documentation to README
* Add documentation to Usages
Changed
~~~~~~~
* Change the methods in the `analysis` module: removed the `Sample` and `ParameterSample` classes, added `Metropolis`, `Wolff`, `Anneal` classes and several methods
[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.
Raw data
{
"_id": null,
"home_page": "https://github.com/uynajgi/mcmc_statphys",
"name": "mcmc-statphys",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "mcmc_statphys",
"author": "Uynaj GI",
"author_email": "suquan12148@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/0d/80/8ac1a9c3ace7500481c6b227cb4bea7d34505f020c53e335424b71b07cc1/mcmc_statphys-0.4.3.tar.gz",
"platform": null,
"description": "=============\nmcmc_statphys\n=============\n\n\n.. image:: https://img.shields.io/pypi/v/mcmc_statphys.svg\n :target: https://pypi.python.org/pypi/mcmc_statphys\n\n.. image:: https://img.shields.io/travis/uynajgi/mcmc_statphys.svg\n :target: https://travis-ci.com/uynajgi/mcmc_statphys\n\n.. image:: https://readthedocs.org/projects/mcmc-statphys/badge/?version=latest\n :target: https://mcmc-statphys.readthedocs.io/en/latest/?version=latest\n :alt: Documentation Status\n\n\n\n\nA Python package of Monte Carlo simulation algorithms for some statistical physics models (in particular, the Ising model and its variants).\n\n\n* Free software: MIT license\n* Documentation: https://mcmc-statphys.readthedocs.io.\n\n\nFeatures\n--------\n\nA simple Ising model simulation.\n\n.. code-block:: python\n\n >>> import mcmc_statphys as mcsp\n >>> model = mcsp.model.Ising(12) # 12x12 Ising model\n >>> algorithm = mcsp.method.Metropolis(model) # Metropolis algorithm\n >>> uid = algorithm.equil_sample(T=1, max_iter=1000) # sample until equilibrium\n >>> fig = mcsp.draw.Plot(algorithm) \n >>> fig.curve(uid=uid, comlumn='energy') # plot the energy curve\n\nInstall\n-------\n\nthe latest version of mcmc_statphys: \n\n.. code-block:: console\n\n $ pip install mcmc_statphys\n\nupgrade to the latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade mcmc_statphys\n\nBugs\n----\n\nPlease 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`_).\n\n.. _here: https://github.com/uynajgi/mcmc_statphys/issues\n.. _GitHub: https://github.com/uynajgi/mcmc_statphys/\n.. _CONTRIBUTING: https://mcmc-statphys.readthedocs.io/en/latest/contributing.html\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n[Unreleased]\n------------\n\n[0.4.0] - 2023-05-20\n--------------------\n\nAdded\n~~~~~\n\n* Add `imshow` in `draw`\n* Add `animate` in `draw`\n\nFixed\n~~~~~\n\n* Fix: `Wolff` and `Anneal` uid does not return\n\n[0.3.0] - 2023-05-18\n--------------------\n\nAdded\n~~~~~\n\n* Add `cv` in `analysis` to calculate the cv\n* Add `spin2svd` in `analysis`\n* Add `uid2svd` in `analysis`\n\n[0.2.1] - 2023-05-17\n--------------------\n\nFixed\n~~~~~\n\n* Fix the bug of saving `_get_per_magnetization` in `_save_data` in `algorithm`\n\nAdded\n~~~~~\n\n* Add moudle `analysis` to analyze the data\n* Add moudle `draw` to draw the figures\n* Add method `setspin` in `model`\n* Add tqmd to show the progress bar\n\nDoc\n~~~\n\n* Add documentation to README\n* Add documentation to Usages\n\nChanged\n~~~~~~~\n\n* Change the methods in the `analysis` module: removed the `Sample` and `ParameterSample` classes, added `Metropolis`, `Wolff`, `Anneal` classes and several methods\n\n[0.1.2] - 2023-05-15\n--------------------\n\nSecurity\n~~~~~~~~\n\n* Add function annotations to all functions\n* Add type hints to all functions\n* Add type hints to all variables\n* Change `mcmc_statphys.py` to `method.py`\n\nDoc\n~~~\n\n* Add documentation to README\n\n[0.1.1] - 2023-05-14\n--------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "A library project of Monte Carlo simulation algorithms for some statistical physics models (in particular, the Ising model and its variants).",
"version": "0.4.3",
"project_urls": {
"Homepage": "https://github.com/uynajgi/mcmc_statphys"
},
"split_keywords": [
"mcmc_statphys"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eb955e2c68152fe3fda110d09d597ea6b9aea00f1f64772842138b3621244bdf",
"md5": "bc5089eac4be6b3eaff2a4c67f381575",
"sha256": "571222f3f1895972f41853a9129309b1b084ebcfc820496f68061a1c6d967576"
},
"downloads": -1,
"filename": "mcmc_statphys-0.4.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "bc5089eac4be6b3eaff2a4c67f381575",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 19688,
"upload_time": "2023-05-21T09:27:58",
"upload_time_iso_8601": "2023-05-21T09:27:58.317458Z",
"url": "https://files.pythonhosted.org/packages/eb/95/5e2c68152fe3fda110d09d597ea6b9aea00f1f64772842138b3621244bdf/mcmc_statphys-0.4.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0d808ac1a9c3ace7500481c6b227cb4bea7d34505f020c53e335424b71b07cc1",
"md5": "bc0eb6abf93ea587e22408c698da6e46",
"sha256": "5da9c00ef87908e66ab67551ec9baaf6ae8b1d64c01186d335e2b157c39daca5"
},
"downloads": -1,
"filename": "mcmc_statphys-0.4.3.tar.gz",
"has_sig": false,
"md5_digest": "bc0eb6abf93ea587e22408c698da6e46",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 43341,
"upload_time": "2023-05-21T09:28:00",
"upload_time_iso_8601": "2023-05-21T09:28:00.339743Z",
"url": "https://files.pythonhosted.org/packages/0d/80/8ac1a9c3ace7500481c6b227cb4bea7d34505f020c53e335424b71b07cc1/mcmc_statphys-0.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-21 09:28:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "uynajgi",
"github_project": "mcmc_statphys",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "mcmc-statphys"
}
JSON
