| Name | PyQUDA-Utils JSON |
| Version |
0.10.25.post0
JSON |
| download |
| home_page | None |
| Summary | Utility scripts based on PyQUDA |
| upload_time | 2025-07-15 09:51:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License
Copyright (c) 2022-2024 PyQUDA Developers
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
lattice-gauge-theory
lattice-field-theory
lattice-qcd
hep-lat
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyQUDA
Python wrapper for [QUDA](https://github.com/lattice/quda) written in Cython.
This project aims to benefit from the optimized linear algebra library [CuPy](https://cupy.dev/) in Python based on CUDA. CuPy and QUDA will allow us to perform most lattice QCD research operations with high performance. [PyTorch](https://pytorch.org/) is an alternative option.
This project is based on the latest QUDA `develop` branch. PyQUDA should be compatible with any commit of QUDA after https://github.com/lattice/quda/pull/1489, but leave some features disabled.
## Feature
- Multi-GPU supported
- with [MPI for Python](https://mpi4py.readthedocs.io/en/stable/) package
- File I/O
- Read gauge and propagator in Chroma format (with checksum)
- Read gauge and propagator in MILC format (with checksum)
- Read/write gauge and propagator in KYU format
- Read/write gauge and propagator in XQCD format
- Read/write gauge and propagator in NPY format (numpy)
- Quark propagator
- Isotropic/anisotropic Wilson fermion action with multigrid support
- Isotropic/anisotropic Clover fermion action with multigrid support
- Isotropic HISQ fermion action
- HMC
- Isotropic gauge action
- 1-flavor isotropic clover fermion action
- 2-flavor isotropic clover fermion action
- N-flavor isotropic HISQ fermion action
- Gauge fixing
- Rotation field with over-relaxation method (waiting for QUDA merge)
- Gauge smearing
- 3D/4D APE smearing
- 3D/4D stout smearing
- 3D/4D HYP smearing
- Fermion smearing
- Gaussian smearing
- Gradient flow
- Wilson flow
- Symanzik flow
## Installation
### Install from PyPI
Assuming the QUDA installation path is `/path/to/quda/build/usqcd`
```bash
export QUDA_PATH=/path/to/quda/build/usqcd
python3 -m pip install pyquda pyquda-utils
```
### Install from source
Refer to https://github.com/CLQCD/PyQUDA/wiki/Installation for detailed instructions to install PyQUDA from the source.
## Benchmark
Refer to https://github.com/CLQCD/PyQUDA/wiki/Benchmark for detailed instructions to run the PyQUDA benchmark.
## Documentation (draft)
https://github.com/CLQCD/PyQUDA/wiki/Documentation
## Plugin
Refer to https://github.com/CLQCD/PyQUDA/wiki/Plugin for detailed instructions to build PyQUDA plugins.
Here are plugins developed by PyQUDA developers:
- [pycontract](https://github.com/CLQCD/contract)
## Development
We recommend building PyQUDA using in-place mode instead of installing PyQUDA for development.
```bash
git clone --recursive https://github.com/CLQCD/PyQUDA.git
cd PyQUDA
ln -s pyquda_core/pyquda_comm ./
ln -s pyquda_core/pyquda ./
cd pyquda_core
export QUDA_PATH=/path/to/quda/build/usqcd
python3 setup.py build_ext --inplace
cd ..
```
Now you can modify Python files in the project and immediately get the new result by running scripts. Adding the root directory to `sys.path` is needed if you are running scripts from other directories.
## Maintenance
Function definitions (mainly in `quda.in.pxd` and `pyquda.in.pyx`) and most docstrings (mainly in `pyquda.pyi` and `enum_quda.in.py`) should be manually updated as they cannot be autogenerated now. This also means PyQUDA should work well with future versions if the API remains unchanged.
Raw data
{
"_id": null,
"home_page": null,
"name": "PyQUDA-Utils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "SaltyChiang <SaltyChiang@users.noreply.github.com>",
"keywords": "lattice-gauge-theory, lattice-field-theory, lattice-qcd, hep-lat",
"author": null,
"author_email": "SaltyChiang <SaltyChiang@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/0f/d1/334647d2117bf8d1cb4513d8ec9eb852ffcf5f7628b32cbd2f6eba32881e/pyquda_utils-0.10.25.post0.tar.gz",
"platform": null,
"description": "# PyQUDA\n\nPython wrapper for [QUDA](https://github.com/lattice/quda) written in Cython.\n\nThis project aims to benefit from the optimized linear algebra library [CuPy](https://cupy.dev/) in Python based on CUDA. CuPy and QUDA will allow us to perform most lattice QCD research operations with high performance. [PyTorch](https://pytorch.org/) is an alternative option.\n\nThis project is based on the latest QUDA `develop` branch. PyQUDA should be compatible with any commit of QUDA after https://github.com/lattice/quda/pull/1489, but leave some features disabled.\n\n## Feature\n\n- Multi-GPU supported\n - with [MPI for Python](https://mpi4py.readthedocs.io/en/stable/) package\n- File I/O\n - Read gauge and propagator in Chroma format (with checksum)\n - Read gauge and propagator in MILC format (with checksum)\n - Read/write gauge and propagator in KYU format\n - Read/write gauge and propagator in XQCD format\n - Read/write gauge and propagator in NPY format (numpy)\n- Quark propagator\n - Isotropic/anisotropic Wilson fermion action with multigrid support\n - Isotropic/anisotropic Clover fermion action with multigrid support\n - Isotropic HISQ fermion action\n- HMC\n - Isotropic gauge action\n - 1-flavor isotropic clover fermion action\n - 2-flavor isotropic clover fermion action\n - N-flavor isotropic HISQ fermion action\n- Gauge fixing\n - Rotation field with over-relaxation method (waiting for QUDA merge)\n- Gauge smearing\n - 3D/4D APE smearing\n - 3D/4D stout smearing\n - 3D/4D HYP smearing\n- Fermion smearing\n - Gaussian smearing\n- Gradient flow\n - Wilson flow\n - Symanzik flow\n\n## Installation\n\n### Install from PyPI\n\nAssuming the QUDA installation path is `/path/to/quda/build/usqcd`\n\n```bash\nexport QUDA_PATH=/path/to/quda/build/usqcd\npython3 -m pip install pyquda pyquda-utils\n```\n\n### Install from source\n\nRefer to https://github.com/CLQCD/PyQUDA/wiki/Installation for detailed instructions to install PyQUDA from the source.\n\n## Benchmark\n\nRefer to https://github.com/CLQCD/PyQUDA/wiki/Benchmark for detailed instructions to run the PyQUDA benchmark.\n\n## Documentation (draft)\n\nhttps://github.com/CLQCD/PyQUDA/wiki/Documentation\n\n## Plugin\n\nRefer to https://github.com/CLQCD/PyQUDA/wiki/Plugin for detailed instructions to build PyQUDA plugins.\n\nHere are plugins developed by PyQUDA developers:\n- [pycontract](https://github.com/CLQCD/contract)\n\n## Development\n\nWe recommend building PyQUDA using in-place mode instead of installing PyQUDA for development.\n\n```bash\ngit clone --recursive https://github.com/CLQCD/PyQUDA.git\ncd PyQUDA\nln -s pyquda_core/pyquda_comm ./\nln -s pyquda_core/pyquda ./\ncd pyquda_core\nexport QUDA_PATH=/path/to/quda/build/usqcd\npython3 setup.py build_ext --inplace\ncd ..\n```\n\nNow you can modify Python files in the project and immediately get the new result by running scripts. Adding the root directory to `sys.path` is needed if you are running scripts from other directories.\n\n## Maintenance\n\nFunction definitions (mainly in `quda.in.pxd` and `pyquda.in.pyx`) and most docstrings (mainly in `pyquda.pyi` and `enum_quda.in.py`) should be manually updated as they cannot be autogenerated now. This also means PyQUDA should work well with future versions if the API remains unchanged.\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2022-2024 PyQUDA Developers\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Utility scripts based on PyQUDA",
"version": "0.10.25.post0",
"project_urls": {
"Documentation": "https://github.com/CLQCD/PyQUDA/wiki/Documentation",
"Homepage": "https://github.com/CLQCD/PyQUDA",
"Issues": "https://github.com/CLQCD/PyQUDA/issues",
"Repository": "https://github.com/CLQCD/PyQUDA.git"
},
"split_keywords": [
"lattice-gauge-theory",
" lattice-field-theory",
" lattice-qcd",
" hep-lat"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0fd1334647d2117bf8d1cb4513d8ec9eb852ffcf5f7628b32cbd2f6eba32881e",
"md5": "0adaa0160152c3c0c21c0210d5684104",
"sha256": "2ebb80d57cf68c6fefae6df347ac5f96de9be32ab774024598ca4dcb6478426f"
},
"downloads": -1,
"filename": "pyquda_utils-0.10.25.post0.tar.gz",
"has_sig": false,
"md5_digest": "0adaa0160152c3c0c21c0210d5684104",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 134384,
"upload_time": "2025-07-15T09:51:07",
"upload_time_iso_8601": "2025-07-15T09:51:07.516201Z",
"url": "https://files.pythonhosted.org/packages/0f/d1/334647d2117bf8d1cb4513d8ec9eb852ffcf5f7628b32cbd2f6eba32881e/pyquda_utils-0.10.25.post0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-15 09:51:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CLQCD",
"github_project": "PyQUDA",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyquda-utils"
}
