PyQUDA-Utils 0.9.0.dev3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2022-2024 PyQUDA Developers
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1 @@
1
+ exclude tests/*
@@ -0,0 +1,115 @@
1
+ Metadata-Version: 2.1
2
+ Name: PyQUDA-Utils
3
+ Version: 0.9.0.dev3
4
+ Summary: Utility scripts based on PyQUDA
5
+ Author-email: SaltyChiang <SaltyChiang@users.noreply.github.com>
6
+ Maintainer-email: SaltyChiang <SaltyChiang@users.noreply.github.com>
7
+ License: MIT License
8
+
9
+ Copyright (c) 2022-2024 PyQUDA Developers
10
+
11
+ Permission is hereby granted, free of charge, to any person obtaining a copy
12
+ of this software and associated documentation files (the "Software"), to deal
13
+ in the Software without restriction, including without limitation the rights
14
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15
+ copies of the Software, and to permit persons to whom the Software is
16
+ furnished to do so, subject to the following conditions:
17
+
18
+ The above copyright notice and this permission notice shall be included in all
19
+ copies or substantial portions of the Software.
20
+
21
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27
+ SOFTWARE.
28
+
29
+ Project-URL: Homepage, https://github.com/CLQCD/PyQUDA
30
+ Project-URL: Documentation, https://github.com/CLQCD/PyQUDA/wiki/Documentation
31
+ Project-URL: Repository, https://github.com/CLQCD/PyQUDA.git
32
+ Project-URL: Issues, https://github.com/CLQCD/PyQUDA/issues
33
+ Keywords: lattice-gauge-theory,lattice-field-theory,lattice-qcd,hep-lat
34
+ Classifier: Development Status :: 2 - Pre-Alpha
35
+ Classifier: Programming Language :: Python :: 3 :: Only
36
+ Classifier: Programming Language :: Cython
37
+ Classifier: License :: OSI Approved :: MIT License
38
+ Classifier: Operating System :: POSIX :: Linux
39
+ Classifier: Environment :: GPU
40
+ Classifier: Environment :: GPU :: NVIDIA CUDA
41
+ Classifier: Topic :: Scientific/Engineering :: Physics
42
+ Requires-Python: >=3.8
43
+ Description-Content-Type: text/markdown
44
+ License-File: LICENSE
45
+ Requires-Dist: PyQUDA
46
+
47
+ # PyQUDA
48
+
49
+ Python wrapper for [QUDA](https://github.com/lattice/quda) written in Cython.
50
+
51
+ 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.
52
+
53
+ 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.
54
+
55
+ ## Feature
56
+
57
+ - Multi-GPU supported
58
+ - with [MPI for Python](https://mpi4py.readthedocs.io/en/stable/) package
59
+ - File I/O
60
+ - Read gauge and propagator in Chroma format
61
+ - Read gauge and propagator in MILC format
62
+ - Read/write gauge and propagator in KYU format
63
+ - Read/write gauge and propagator in XQCD format
64
+ - Read/write gauge and propagator in NPY format (numpy)
65
+ - Quark propagator
66
+ - Isotropic/anisotropic Wilson fermion action with multigrid support
67
+ - Isotropic/anisotropic Clover fermion action with multigrid support
68
+ - Isotropic HISQ fermion action
69
+ - HMC
70
+ - Isotropic Wilson gauge action
71
+ - Isotropic Symanzik gauge action
72
+ - 1-flavor isotropic clover fermion action
73
+ - 2-flavor isotropic clover fermion action
74
+ - Gauge fixing
75
+ - Rotation field with over-relaxation method (waiting for QUDA merge)
76
+ - Gauge smearing
77
+ - 3D/4D APE smearing
78
+ - 3D/4D stout smearing
79
+ - 3D/4D HYP smearing
80
+ - Fermion smearing
81
+ - Gaussian smearing
82
+ - Gradient flow
83
+ - Wilson flow
84
+ - Symanzik flow
85
+
86
+ ## Installation
87
+
88
+ Refer to https://github.com/CLQCD/PyQUDA/wiki/Installation for detailed instructions to install PyQUDA from the source.
89
+
90
+ ## Benchmark
91
+
92
+ Refer to https://github.com/CLQCD/PyQUDA/wiki/Benchmark for detailed instructions to run the PyQUDA benchmark.
93
+
94
+ ## Documentation (draft)
95
+
96
+ https://github.com/CLQCD/PyQUDA/wiki/Documentation
97
+
98
+ ## Development
99
+
100
+ We recommend building PyQUDA using in-place mode instead of installing PyQUDA for development.
101
+
102
+ ```bash
103
+ git clone https://github.com/CLQCD/PyQUDA.git
104
+ cd PyQUDA
105
+ ln -s pyquda_core/pyquda pyquda
106
+ cd pyquda_core
107
+ export QUDA_PATH=/path/to/quda/build/usqcd
108
+ python3 setup.py build_ext --inplace
109
+ ```
110
+
111
+ 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.
112
+
113
+ ## Maintenance
114
+
115
+ 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.
@@ -0,0 +1,115 @@
1
+ Metadata-Version: 2.1
2
+ Name: PyQUDA-Utils
3
+ Version: 0.9.0.dev3
4
+ Summary: Utility scripts based on PyQUDA
5
+ Author-email: SaltyChiang <SaltyChiang@users.noreply.github.com>
6
+ Maintainer-email: SaltyChiang <SaltyChiang@users.noreply.github.com>
7
+ License: MIT License
8
+
9
+ Copyright (c) 2022-2024 PyQUDA Developers
10
+
11
+ Permission is hereby granted, free of charge, to any person obtaining a copy
12
+ of this software and associated documentation files (the "Software"), to deal
13
+ in the Software without restriction, including without limitation the rights
14
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15
+ copies of the Software, and to permit persons to whom the Software is
16
+ furnished to do so, subject to the following conditions:
17
+
18
+ The above copyright notice and this permission notice shall be included in all
19
+ copies or substantial portions of the Software.
20
+
21
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27
+ SOFTWARE.
28
+
29
+ Project-URL: Homepage, https://github.com/CLQCD/PyQUDA
30
+ Project-URL: Documentation, https://github.com/CLQCD/PyQUDA/wiki/Documentation
31
+ Project-URL: Repository, https://github.com/CLQCD/PyQUDA.git
32
+ Project-URL: Issues, https://github.com/CLQCD/PyQUDA/issues
33
+ Keywords: lattice-gauge-theory,lattice-field-theory,lattice-qcd,hep-lat
34
+ Classifier: Development Status :: 2 - Pre-Alpha
35
+ Classifier: Programming Language :: Python :: 3 :: Only
36
+ Classifier: Programming Language :: Cython
37
+ Classifier: License :: OSI Approved :: MIT License
38
+ Classifier: Operating System :: POSIX :: Linux
39
+ Classifier: Environment :: GPU
40
+ Classifier: Environment :: GPU :: NVIDIA CUDA
41
+ Classifier: Topic :: Scientific/Engineering :: Physics
42
+ Requires-Python: >=3.8
43
+ Description-Content-Type: text/markdown
44
+ License-File: LICENSE
45
+ Requires-Dist: PyQUDA
46
+
47
+ # PyQUDA
48
+
49
+ Python wrapper for [QUDA](https://github.com/lattice/quda) written in Cython.
50
+
51
+ 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.
52
+
53
+ 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.
54
+
55
+ ## Feature
56
+
57
+ - Multi-GPU supported
58
+ - with [MPI for Python](https://mpi4py.readthedocs.io/en/stable/) package
59
+ - File I/O
60
+ - Read gauge and propagator in Chroma format
61
+ - Read gauge and propagator in MILC format
62
+ - Read/write gauge and propagator in KYU format
63
+ - Read/write gauge and propagator in XQCD format
64
+ - Read/write gauge and propagator in NPY format (numpy)
65
+ - Quark propagator
66
+ - Isotropic/anisotropic Wilson fermion action with multigrid support
67
+ - Isotropic/anisotropic Clover fermion action with multigrid support
68
+ - Isotropic HISQ fermion action
69
+ - HMC
70
+ - Isotropic Wilson gauge action
71
+ - Isotropic Symanzik gauge action
72
+ - 1-flavor isotropic clover fermion action
73
+ - 2-flavor isotropic clover fermion action
74
+ - Gauge fixing
75
+ - Rotation field with over-relaxation method (waiting for QUDA merge)
76
+ - Gauge smearing
77
+ - 3D/4D APE smearing
78
+ - 3D/4D stout smearing
79
+ - 3D/4D HYP smearing
80
+ - Fermion smearing
81
+ - Gaussian smearing
82
+ - Gradient flow
83
+ - Wilson flow
84
+ - Symanzik flow
85
+
86
+ ## Installation
87
+
88
+ Refer to https://github.com/CLQCD/PyQUDA/wiki/Installation for detailed instructions to install PyQUDA from the source.
89
+
90
+ ## Benchmark
91
+
92
+ Refer to https://github.com/CLQCD/PyQUDA/wiki/Benchmark for detailed instructions to run the PyQUDA benchmark.
93
+
94
+ ## Documentation (draft)
95
+
96
+ https://github.com/CLQCD/PyQUDA/wiki/Documentation
97
+
98
+ ## Development
99
+
100
+ We recommend building PyQUDA using in-place mode instead of installing PyQUDA for development.
101
+
102
+ ```bash
103
+ git clone https://github.com/CLQCD/PyQUDA.git
104
+ cd PyQUDA
105
+ ln -s pyquda_core/pyquda pyquda
106
+ cd pyquda_core
107
+ export QUDA_PATH=/path/to/quda/build/usqcd
108
+ python3 setup.py build_ext --inplace
109
+ ```
110
+
111
+ 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.
112
+
113
+ ## Maintenance
114
+
115
+ 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.
@@ -0,0 +1,24 @@
1
+ LICENSE
2
+ MANIFEST.in
3
+ README.md
4
+ pyproject.toml
5
+ setup.py
6
+ PyQUDA_Utils.egg-info/PKG-INFO
7
+ PyQUDA_Utils.egg-info/SOURCES.txt
8
+ PyQUDA_Utils.egg-info/dependency_links.txt
9
+ PyQUDA_Utils.egg-info/requires.txt
10
+ PyQUDA_Utils.egg-info/top_level.txt
11
+ pyquda_utils/__init__.py
12
+ pyquda_utils/_version.py
13
+ pyquda_utils/core.py
14
+ pyquda_utils/deprecated.py
15
+ pyquda_utils/gamma.py
16
+ pyquda_utils/hmc_param.py
17
+ pyquda_utils/phase.py
18
+ pyquda_utils/source.py
19
+ pyquda_utils/io/__init__.py
20
+ pyquda_utils/io/chroma.py
21
+ pyquda_utils/io/kyu.py
22
+ pyquda_utils/io/milc.py
23
+ pyquda_utils/io/npy.py
24
+ pyquda_utils/io/xqcd.py
@@ -0,0 +1 @@
1
+ pyquda_utils
@@ -0,0 +1,69 @@
1
+ # PyQUDA
2
+
3
+ Python wrapper for [QUDA](https://github.com/lattice/quda) written in Cython.
4
+
5
+ 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.
6
+
7
+ 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.
8
+
9
+ ## Feature
10
+
11
+ - Multi-GPU supported
12
+ - with [MPI for Python](https://mpi4py.readthedocs.io/en/stable/) package
13
+ - File I/O
14
+ - Read gauge and propagator in Chroma format
15
+ - Read gauge and propagator in MILC format
16
+ - Read/write gauge and propagator in KYU format
17
+ - Read/write gauge and propagator in XQCD format
18
+ - Read/write gauge and propagator in NPY format (numpy)
19
+ - Quark propagator
20
+ - Isotropic/anisotropic Wilson fermion action with multigrid support
21
+ - Isotropic/anisotropic Clover fermion action with multigrid support
22
+ - Isotropic HISQ fermion action
23
+ - HMC
24
+ - Isotropic Wilson gauge action
25
+ - Isotropic Symanzik gauge action
26
+ - 1-flavor isotropic clover fermion action
27
+ - 2-flavor isotropic clover fermion action
28
+ - Gauge fixing
29
+ - Rotation field with over-relaxation method (waiting for QUDA merge)
30
+ - Gauge smearing
31
+ - 3D/4D APE smearing
32
+ - 3D/4D stout smearing
33
+ - 3D/4D HYP smearing
34
+ - Fermion smearing
35
+ - Gaussian smearing
36
+ - Gradient flow
37
+ - Wilson flow
38
+ - Symanzik flow
39
+
40
+ ## Installation
41
+
42
+ Refer to https://github.com/CLQCD/PyQUDA/wiki/Installation for detailed instructions to install PyQUDA from the source.
43
+
44
+ ## Benchmark
45
+
46
+ Refer to https://github.com/CLQCD/PyQUDA/wiki/Benchmark for detailed instructions to run the PyQUDA benchmark.
47
+
48
+ ## Documentation (draft)
49
+
50
+ https://github.com/CLQCD/PyQUDA/wiki/Documentation
51
+
52
+ ## Development
53
+
54
+ We recommend building PyQUDA using in-place mode instead of installing PyQUDA for development.
55
+
56
+ ```bash
57
+ git clone https://github.com/CLQCD/PyQUDA.git
58
+ cd PyQUDA
59
+ ln -s pyquda_core/pyquda pyquda
60
+ cd pyquda_core
61
+ export QUDA_PATH=/path/to/quda/build/usqcd
62
+ python3 setup.py build_ext --inplace
63
+ ```
64
+
65
+ 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.
66
+
67
+ ## Maintenance
68
+
69
+ 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.
@@ -0,0 +1,45 @@
1
+ [build-system]
2
+ requires = ["setuptools"]
3
+
4
+ [tool.setuptools.packages.find]
5
+ include = ["pyquda_utils*"]
6
+
7
+ [tool.setuptools.dynamic]
8
+ version = { attr = "pyquda_utils._version.__version__" }
9
+
10
+ [project]
11
+ dynamic = ["version"]
12
+ name = "PyQUDA-Utils"
13
+ dependencies = ["PyQUDA"]
14
+ requires-python = ">=3.8"
15
+ authors = [
16
+ { name = "SaltyChiang", email = "SaltyChiang@users.noreply.github.com" },
17
+ ]
18
+ maintainers = [
19
+ { name = "SaltyChiang", email = "SaltyChiang@users.noreply.github.com" },
20
+ ]
21
+ description = "Utility scripts based on PyQUDA"
22
+ readme = "README.md"
23
+ license = { file = "LICENSE" }
24
+ keywords = [
25
+ "lattice-gauge-theory",
26
+ "lattice-field-theory",
27
+ "lattice-qcd",
28
+ "hep-lat",
29
+ ]
30
+ classifiers = [
31
+ "Development Status :: 2 - Pre-Alpha",
32
+ "Programming Language :: Python :: 3 :: Only",
33
+ "Programming Language :: Cython",
34
+ "License :: OSI Approved :: MIT License",
35
+ "Operating System :: POSIX :: Linux",
36
+ "Environment :: GPU",
37
+ "Environment :: GPU :: NVIDIA CUDA",
38
+ "Topic :: Scientific/Engineering :: Physics",
39
+ ]
40
+
41
+ [project.urls]
42
+ Homepage = "https://github.com/CLQCD/PyQUDA"
43
+ Documentation = "https://github.com/CLQCD/PyQUDA/wiki/Documentation"
44
+ Repository = "https://github.com/CLQCD/PyQUDA.git"
45
+ Issues = "https://github.com/CLQCD/PyQUDA/issues"
@@ -0,0 +1 @@
1
+ from ._version import __version__ # noqa: F401
@@ -0,0 +1 @@
1
+ __version__ = "0.9.0.dev3"