[](https://github.com/JulianWack/SU2xSU2)
[](https://zenodo.org/badge/latestdoi/668764614)
[](https://arxiv.org/abs/2308.14628v2)
[](https://su2xsu2.readthedocs.io/en/stable/?badge=stable)
[](https://badge.fury.io/py/SU2xSU2)
[](https://pepy.tech/project/SU2xSU2)
This python package offers efficient simulation and data analysis routines for the $SU(2) \times SU(2)$ Principal Chiral model. The key feature offered is the integration of Fourier Acceleration into the Hybrid Monte Carlo algorithm which leads to a significant reduction in the degree of critical slowing down.
The simulation is supported for cubic lattices with even side length in arbitary dimensions.
## Installation
To install ``SU2xSU2`` using ``pip`` run:
```bash
pip install SU2xSU2
```
Its is recommended to work in a virtual environment. The package comes with a custom style sheet which is used by default.
## Documentation
Read the docs [here](https://su2xsu2.readthedocs.io/).
## Example
A basic example showing how to set up a simulation using Fourier accelerated HMC to measure the wall-to-wall correlation function.
Further examples can be found [here](https://su2xsu2.readthedocs.io/en/stable/usage.html#examples).
```python
from SU2xSU2.SU2xSU2 import SU2xSU2
# define model and lattice parameters
model_paras = {'D':2, L':40, 'a':1, 'ell':5, 'eps':1/5, 'beta':0.6}
model = SU2xSU2(**model_paras)
# define simulation parameters and measurements
sim_paras = {'M':500, 'burnin_frac':0.5, 'accel':True, 'measurements':[model.ww_correlation_func], 'chain_paths':['corfunc_chain.npy']}
model.run_HMC(**sim_paras)
```
## Attribution
Please cite the following paper if you found this code useful in your research:
```bash
@article{WackFAHMC2024,
author = {Roger Horsley and Brian Pendleton and Julian Wack},
title = {Hybrid Monte Carlo simulation with Fourier acceleration of the N = 2 principal chiral model in two dimensions},
journal = {Physics Letters B},
volume = {849},
pages = {138429},
year = {2024},
issn = {0370-2693},
doi = {https://doi.org/10.1016/j.physletb.2023.138429},
eprint={2308.14628v2},
archivePrefix={arXiv},
primaryClass={hep-lat}
}
```
## Licence
``SU2xSU2`` is free software made available under the MIT License. For details see the `LICENSE` file.
## To Do
- Runtime warning in correlations l.64
- implement weak coupling expansion for all D
Raw data
{
"_id": null,
"home_page": "",
"name": "SU2xSU2",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11.4",
"maintainer_email": "",
"keywords": "Hybrid Monte Carlo,Fourier Acceleration,Principal Chiral model",
"author": "Julian Wack",
"author_email": "julianfriedrichwack@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5b/14/73819701e20f2d5c7f39bafdbc21e28d3bc0534e3c745135797a5252e5eb/SU2xSU2-2.tar.gz",
"platform": "any",
"description": "\r\n\r\n[](https://github.com/JulianWack/SU2xSU2)\r\n[](https://zenodo.org/badge/latestdoi/668764614)\r\n[](https://arxiv.org/abs/2308.14628v2)\r\n[](https://su2xsu2.readthedocs.io/en/stable/?badge=stable)\r\n[](https://badge.fury.io/py/SU2xSU2)\r\n[](https://pepy.tech/project/SU2xSU2)\r\n\r\nThis python package offers efficient simulation and data analysis routines for the $SU(2) \\times SU(2)$ Principal Chiral model. The key feature offered is the integration of Fourier Acceleration into the Hybrid Monte Carlo algorithm which leads to a significant reduction in the degree of critical slowing down.\r\n\r\nThe simulation is supported for cubic lattices with even side length in arbitary dimensions.\r\n\r\n## Installation \r\nTo install ``SU2xSU2`` using ``pip`` run:\r\n\r\n```bash\r\npip install SU2xSU2\r\n```\r\nIts is recommended to work in a virtual environment. The package comes with a custom style sheet which is used by default.\r\n\r\n\r\n## Documentation\r\nRead the docs [here](https://su2xsu2.readthedocs.io/).\r\n\r\n\r\n## Example\r\nA basic example showing how to set up a simulation using Fourier accelerated HMC to measure the wall-to-wall correlation function.\r\nFurther examples can be found [here](https://su2xsu2.readthedocs.io/en/stable/usage.html#examples).\r\n```python\r\nfrom SU2xSU2.SU2xSU2 import SU2xSU2\r\n\r\n# define model and lattice parameters \r\nmodel_paras = {'D':2, L':40, 'a':1, 'ell':5, 'eps':1/5, 'beta':0.6}\r\nmodel = SU2xSU2(**model_paras)\r\n# define simulation parameters and measurements\r\nsim_paras = {'M':500, 'burnin_frac':0.5, 'accel':True, 'measurements':[model.ww_correlation_func], 'chain_paths':['corfunc_chain.npy']}\r\nmodel.run_HMC(**sim_paras) \r\n```\r\n\r\n\r\n## Attribution\r\n\r\nPlease cite the following paper if you found this code useful in your research:\r\n```bash\r\n@article{WackFAHMC2024,\r\n author = {Roger Horsley and Brian Pendleton and Julian Wack},\r\n title = {Hybrid Monte Carlo simulation with Fourier acceleration of the N\u202f=\u202f2 principal chiral model in two dimensions},\r\n journal = {Physics Letters B},\r\n volume = {849},\r\n pages = {138429},\r\n year = {2024},\r\n issn = {0370-2693},\r\n doi = {https://doi.org/10.1016/j.physletb.2023.138429},\r\n eprint={2308.14628v2},\r\n archivePrefix={arXiv},\r\n primaryClass={hep-lat}\r\n}\r\n```\r\n\r\n\r\n## Licence\r\n\r\n``SU2xSU2`` is free software made available under the MIT License. For details see the `LICENSE` file.\r\n\r\n## To Do\r\n- Runtime warning in correlations l.64\r\n- implement weak coupling expansion for all D\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Hybrid Monte Carlo with Fourier Acceleration simulation package for the N=2 Principal Chiral model.",
"version": "2",
"project_urls": {
"Documentation": "https://su2xsu2.readthedocs.io/",
"Download": "https://pypi.org/project/SU2xSU2/",
"Source": "https://github.com/JulianWack/SU2xSU2"
},
"split_keywords": [
"hybrid monte carlo",
"fourier acceleration",
"principal chiral model"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "299d15ab85eaf290ba3b1e729951beca0addd43acf907123848018e916a4de02",
"md5": "5e03ba0820e25ab3f7cdd485bf8cfe28",
"sha256": "4be397e907fe1bf3bd6c76e446c82ecc4884611b294017741df920cceb01daf9"
},
"downloads": -1,
"filename": "SU2xSU2-2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e03ba0820e25ab3f7cdd485bf8cfe28",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11.4",
"size": 35697,
"upload_time": "2024-01-04T12:28:05",
"upload_time_iso_8601": "2024-01-04T12:28:05.770037Z",
"url": "https://files.pythonhosted.org/packages/29/9d/15ab85eaf290ba3b1e729951beca0addd43acf907123848018e916a4de02/SU2xSU2-2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5b1473819701e20f2d5c7f39bafdbc21e28d3bc0534e3c745135797a5252e5eb",
"md5": "e2fafd520bc5603b9c4b1b0c18dbfcb6",
"sha256": "426341d6e5c7cd88730caf9816bdfa235bce2e1bf8db98b41c5c8745dd2a20fa"
},
"downloads": -1,
"filename": "SU2xSU2-2.tar.gz",
"has_sig": false,
"md5_digest": "e2fafd520bc5603b9c4b1b0c18dbfcb6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11.4",
"size": 38369,
"upload_time": "2024-01-04T12:28:07",
"upload_time_iso_8601": "2024-01-04T12:28:07.733677Z",
"url": "https://files.pythonhosted.org/packages/5b/14/73819701e20f2d5c7f39bafdbc21e28d3bc0534e3c745135797a5252e5eb/SU2xSU2-2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-04 12:28:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JulianWack",
"github_project": "SU2xSU2",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "su2xsu2"
}
JSON
