findspingroup 0.13.13__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.
Files changed (84) hide show
  1. findspingroup-0.13.13/LICENSE +203 -0
  2. findspingroup-0.13.13/PKG-INFO +202 -0
  3. findspingroup-0.13.13/README.md +173 -0
  4. findspingroup-0.13.13/pyproject.toml +57 -0
  5. findspingroup-0.13.13/setup.cfg +4 -0
  6. findspingroup-0.13.13/src/findspingroup/__init__.py +4 -0
  7. findspingroup-0.13.13/src/findspingroup/batch_mcif.py +1237 -0
  8. findspingroup-0.13.13/src/findspingroup/batch_poscar_roundtrip.py +395 -0
  9. findspingroup-0.13.13/src/findspingroup/batch_scif_roundtrip.py +314 -0
  10. findspingroup-0.13.13/src/findspingroup/cli.py +33 -0
  11. findspingroup-0.13.13/src/findspingroup/core/__init__.py +6 -0
  12. findspingroup-0.13.13/src/findspingroup/core/identify_index/__init__.py +0 -0
  13. findspingroup-0.13.13/src/findspingroup/core/identify_index/contract_222.py +48 -0
  14. findspingroup-0.13.13/src/findspingroup/core/identify_index/databases/__init__.py +5 -0
  15. findspingroup-0.13.13/src/findspingroup/core/identify_index/databases/point_groups.db +0 -0
  16. findspingroup-0.13.13/src/findspingroup/core/identify_index/databases/query_point_groups.py +64 -0
  17. findspingroup-0.13.13/src/findspingroup/core/identify_index/databases/query_space_groups.py +33 -0
  18. findspingroup-0.13.13/src/findspingroup/core/identify_index/databases/query_ssg_map.py +91 -0
  19. findspingroup-0.13.13/src/findspingroup/core/identify_index/databases/query_ssg_reduce.py +105 -0
  20. findspingroup-0.13.13/src/findspingroup/core/identify_index/databases/space_groups.db +0 -0
  21. findspingroup-0.13.13/src/findspingroup/core/identify_index/databases/ssg_map.db +0 -0
  22. findspingroup-0.13.13/src/findspingroup/core/identify_index/databases/ssg_reduce.db +0 -0
  23. findspingroup-0.13.13/src/findspingroup/core/identify_index/functions/__init__.py +5 -0
  24. findspingroup-0.13.13/src/findspingroup/core/identify_index/functions/find_ssg_reduce.py +71 -0
  25. findspingroup-0.13.13/src/findspingroup/core/identify_index/functions/find_stand_gen_maps.py +123 -0
  26. findspingroup-0.13.13/src/findspingroup/core/identify_index/functions/get_point_group.py +120 -0
  27. findspingroup-0.13.13/src/findspingroup/core/identify_index/functions/get_stand_trans.py +92 -0
  28. findspingroup-0.13.13/src/findspingroup/core/identify_index/functions/matrix_methods.py +95 -0
  29. findspingroup-0.13.13/src/findspingroup/core/identify_index/identify_index.py +32 -0
  30. findspingroup-0.13.13/src/findspingroup/core/identify_index/utils.py +11 -0
  31. findspingroup-0.13.13/src/findspingroup/core/identify_spin_space_group.py +545 -0
  32. findspingroup-0.13.13/src/findspingroup/core/identify_symmetry_from_ops.py +1889 -0
  33. findspingroup-0.13.13/src/findspingroup/core/pg_analyzer.py +1559 -0
  34. findspingroup-0.13.13/src/findspingroup/core/properties.py +255 -0
  35. findspingroup-0.13.13/src/findspingroup/core/symbol.py +0 -0
  36. findspingroup-0.13.13/src/findspingroup/core/tolerances.py +10 -0
  37. findspingroup-0.13.13/src/findspingroup/data/ARITHMETIC_CRYSTAL_CLASS.py +88 -0
  38. findspingroup-0.13.13/src/findspingroup/data/MSGMPG_DB.py +5190 -0
  39. findspingroup-0.13.13/src/findspingroup/data/PG_SYMBOL.py +61 -0
  40. findspingroup-0.13.13/src/findspingroup/data/POINT_GROUP_MATRIX.py +1246 -0
  41. findspingroup-0.13.13/src/findspingroup/data/SG_SYMBOL.py +702 -0
  42. findspingroup-0.13.13/src/findspingroup/data/__init__.py +0 -0
  43. findspingroup-0.13.13/src/findspingroup/examples/0.200_Mn3Sn.mcif +118 -0
  44. findspingroup-0.13.13/src/findspingroup/examples/0.800_MnTe.mcif +134 -0
  45. findspingroup-0.13.13/src/findspingroup/examples/1.0.48_MnSe2.mcif +119 -0
  46. findspingroup-0.13.13/src/findspingroup/examples/1.237_VCl2.mcif +119 -0
  47. findspingroup-0.13.13/src/findspingroup/examples/2.116_Na3Co2SbO6.mcif +145 -0
  48. findspingroup-0.13.13/src/findspingroup/examples/2.35_CrSe.mcif +123 -0
  49. findspingroup-0.13.13/src/findspingroup/examples/3.24_CaFe3Ti4O12.mcif +165 -0
  50. findspingroup-0.13.13/src/findspingroup/examples/CoNb3S6_tripleQ.mcif +117 -0
  51. findspingroup-0.13.13/src/findspingroup/examples/Fe.mcif +44 -0
  52. findspingroup-0.13.13/src/findspingroup/examples/MnO.mcif +45 -0
  53. findspingroup-0.13.13/src/findspingroup/examples/V2Te2O_input.mcif +38 -0
  54. findspingroup-0.13.13/src/findspingroup/examples/__init__.py +11 -0
  55. findspingroup-0.13.13/src/findspingroup/find_spin_group.py +3566 -0
  56. findspingroup-0.13.13/src/findspingroup/g0std_sg_cosets.py +221 -0
  57. findspingroup-0.13.13/src/findspingroup/io/__init__.py +36 -0
  58. findspingroup-0.13.13/src/findspingroup/io/cif_parser.py +1160 -0
  59. findspingroup-0.13.13/src/findspingroup/io/poscar_parser.py +208 -0
  60. findspingroup-0.13.13/src/findspingroup/io/scif_generator.py +1197 -0
  61. findspingroup-0.13.13/src/findspingroup/structure/__init__.py +3 -0
  62. findspingroup-0.13.13/src/findspingroup/structure/cell.py +864 -0
  63. findspingroup-0.13.13/src/findspingroup/structure/group.py +2278 -0
  64. findspingroup-0.13.13/src/findspingroup/utils/__init__.py +8 -0
  65. findspingroup-0.13.13/src/findspingroup/utils/international_symbol.py +764 -0
  66. findspingroup-0.13.13/src/findspingroup/utils/matrix_utils.py +278 -0
  67. findspingroup-0.13.13/src/findspingroup/utils/seitz_symbol.py +738 -0
  68. findspingroup-0.13.13/src/findspingroup/utils/space_group_flags.py +121 -0
  69. findspingroup-0.13.13/src/findspingroup/utils/symbolic_format.py +71 -0
  70. findspingroup-0.13.13/src/findspingroup/version.py +1 -0
  71. findspingroup-0.13.13/src/findspingroup.egg-info/PKG-INFO +202 -0
  72. findspingroup-0.13.13/src/findspingroup.egg-info/SOURCES.txt +82 -0
  73. findspingroup-0.13.13/src/findspingroup.egg-info/dependency_links.txt +1 -0
  74. findspingroup-0.13.13/src/findspingroup.egg-info/entry_points.txt +7 -0
  75. findspingroup-0.13.13/src/findspingroup.egg-info/requires.txt +8 -0
  76. findspingroup-0.13.13/src/findspingroup.egg-info/top_level.txt +1 -0
  77. findspingroup-0.13.13/tests/test_batch_generate_files.py +938 -0
  78. findspingroup-0.13.13/tests/test_cif_parser.py +100 -0
  79. findspingroup-0.13.13/tests/test_find_spin_group.py +2849 -0
  80. findspingroup-0.13.13/tests/test_g0std_sg_cosets.py +25 -0
  81. findspingroup-0.13.13/tests/test_international_symbol.py +147 -0
  82. findspingroup-0.13.13/tests/test_packaged_examples.py +8 -0
  83. findspingroup-0.13.13/tests/test_poscar_parser.py +306 -0
  84. findspingroup-0.13.13/tests/test_scif_parser.py +1013 -0
@@ -0,0 +1,203 @@
1
+ Copyright 2026 Yutong Yu
2
+
3
+ Apache License
4
+ Version 2.0, January 2004
5
+ http://www.apache.org/licenses/
6
+
7
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. Definitions.
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. Grant of Copyright License. Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. Grant of Patent License. Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. Redistribution. You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ (a) You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ (b) You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ (c) You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ (d) If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. Trademarks. This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. Disclaimer of Warranty. Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. Limitation of Liability. In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. Accepting Warranty or Additional Liability. While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ END OF TERMS AND CONDITIONS
179
+
180
+ APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "[]"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright [yyyy] [name of copyright owner]
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ http://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
@@ -0,0 +1,202 @@
1
+ Metadata-Version: 2.4
2
+ Name: findspingroup
3
+ Version: 0.13.13
4
+ Summary: Spin space group (SSG) symmetry analysis toolkit for magnetic materials. Automatically identifies and classifies SSGs, generating symmetry operations, spin Wyckoff positions, and spin Brillouin zones. Designed for integration with first-principles and high-throughput computational workflows.
5
+ Author-email: Yutong Yu <karl.yt.yu@gmail.com>
6
+ Maintainer-email: Yutong Yu <karl.yt.yu@gmail.com>
7
+ License-Expression: Apache-2.0
8
+ Project-URL: Homepage, https://github.com/LiuQH-lab/FindSpinGroup
9
+ Project-URL: Repository, https://github.com/LiuQH-lab/FindSpinGroup
10
+ Project-URL: Issues, https://github.com/LiuQH-lab/FindSpinGroup/issues
11
+ Keywords: spin space group,magnetic symmetry,crystallography,spglib,spinCIF
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Science/Research
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: Topic :: Scientific/Engineering :: Physics
18
+ Requires-Python: >=3.11
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: numpy>=1.26.0
22
+ Requires-Dist: scipy>=1.17.0
23
+ Requires-Dist: seekpath>=2.1.0
24
+ Requires-Dist: spglib>=2.6.0
25
+ Requires-Dist: spintensor
26
+ Provides-Extra: dev
27
+ Requires-Dist: pytest>=8.4.2; extra == "dev"
28
+ Dynamic: license-file
29
+
30
+ # findspingroup
31
+
32
+ `findspingroup` is a Python toolkit for identifying and analyzing **Spin Space Group (SSG)** symmetry of magnetic crystal structures.
33
+ Given a magnetic CIF file, it determines the corresponding spin space group, constructs a standardized primitive magnetic cell, and provides symmetry- and property-related results for downstream first-principles workflows.
34
+
35
+ The project is designed for **research use**, **high-throughput screening**, and **integration with DFT pipelines**.
36
+
37
+ ## What it does
38
+
39
+ Given a magnetic structure, `findspingroup` can:
40
+
41
+ - identify the spin space group and index
42
+ - construct primitive and standardized settings
43
+ - expose symmetry operations and international-style symbols
44
+ - export repo-generated `.scif` snapshots for roundtrip and workflow use
45
+ - provide symmetry-constrained property outputs for downstream calculations
46
+
47
+ ## Installation
48
+
49
+ ### From PyPI
50
+
51
+ ```bash
52
+ pip install findspingroup
53
+ ```
54
+
55
+ Python version: `>= 3.11`
56
+
57
+ ### From source
58
+
59
+ ```bash
60
+ git clone https://github.com/LiuQH-lab/FindSpinGroup.git
61
+ cd FindSpinGroup
62
+ pip install -e .
63
+ ```
64
+
65
+ ## 30-second example
66
+
67
+ ```python
68
+ from findspingroup import example_path, find_spin_group
69
+
70
+ result = find_spin_group(example_path("0.800_MnTe.mcif"))
71
+ print(result.index)
72
+ print(result.acc)
73
+ print(result.convention_ssg_international_linear)
74
+ ```
75
+
76
+ Minimal smoke check:
77
+
78
+ ```bash
79
+ python - <<'PY'
80
+ from findspingroup import example_path, find_spin_group
81
+ result = find_spin_group(example_path("0.800_MnTe.mcif"))
82
+ print(result.index)
83
+ print(result.convention_ssg_international_linear)
84
+ PY
85
+ ```
86
+
87
+ ## Supported inputs
88
+
89
+ `findspingroup` accepts:
90
+
91
+ - standard `.cif`
92
+ - magnetic `.mcif`
93
+ - repo-generated `.scif`
94
+ - a narrow first-version magnetic `POSCAR` contract used by this project
95
+
96
+ ## Main API
97
+
98
+ ```python
99
+ def find_spin_group(
100
+ cif: str,
101
+ space_tol: float = 0.02,
102
+ mtol: float = 0.02,
103
+ meigtol: float = 0.00002,
104
+ matrix_tol: float = 0.01,
105
+ ) -> MagSymmetryResult
106
+ ```
107
+
108
+ The function returns a `MagSymmetryResult` object containing the symmetry analysis result.
109
+
110
+ ## Common outputs
111
+
112
+ Useful fields on `MagSymmetryResult` include:
113
+
114
+ - `index`
115
+ - `acc`
116
+ - `msg_num`
117
+ - `msg_symbol`
118
+ - `convention_ssg_international_linear`
119
+ - `gspg_symbol_linear`
120
+ - `scif`
121
+
122
+ Example:
123
+
124
+ ```python
125
+ from findspingroup import example_path, find_spin_group
126
+
127
+ result = find_spin_group(example_path("1.237_VCl2.mcif"))
128
+
129
+ print("index:", result.index)
130
+ print("acc:", result.acc)
131
+ print("msg:", result.msg_symbol)
132
+ print("convention:", result.convention_ssg_international_linear)
133
+ ```
134
+
135
+ ## Input details
136
+
137
+ `findspingroup` supports standard `.cif`, magnetic `.mcif`, the current
138
+ repo-generated `.scif` files, and a narrow first-version `POSCAR` parser for
139
+ repo-generated magnetic POSCAR text.
140
+
141
+ * **Standard CIF**: Uses structural positions.
142
+ * **MCIF (Magnetic CIF)**: Supports files generated by **FINDSYM**, **ISOTROPY**, or **Vesta**.
143
+ * The parser looks for `_atom_site_moment` tags.
144
+ * It automatically handles magnetic vectors ($m_x, m_y, m_z$).
145
+ * **SCIF**: Supports the current repo-generated `.scif` contract for generator /
146
+ parser roundtrip work.
147
+ * **POSCAR**: Currently supports the repo-generated `CrystalCell.to_poscar(...)`
148
+ contract only.
149
+ * official POSCAR structural variants:
150
+ * `Direct`
151
+ * `Cartesian`
152
+ * optional `Selective dynamics`
153
+ * one / three scale factors
154
+ * negative target-volume scale
155
+ * optional trailing `# MAGMOM=` line
156
+ * if absent, moments default to zero
157
+ * multiple `#`, tabs, and extra spaces around `MAGMOM =` are tolerated
158
+ * if no inline `MAGMOM` is present, a sibling `INCAR` `MAGMOM` entry is
159
+ also supported
160
+ * repeated entries such as `6*0.0`
161
+ * `;` inline statements
162
+ * `\\` continuation
163
+ * `#` / `!` comments
164
+ * `NIONS` scalar form is currently promoted to the default z axis
165
+ * basename `POSCAR` / `CONTCAR` or suffix `.poscar` / `.vasp`
166
+ * species names are still required; VASP4 species-omitted files are not yet supported
167
+
168
+ ## `.scif` export and roundtrip
169
+
170
+ `findspingroup` can export a repo-generated spinCIF-style `.scif` snapshot from a
171
+ `MagSymmetryResult`, and can also parse that generated `.scif` back through the
172
+ same public input path.
173
+
174
+ ```python
175
+ from findspingroup import example_path, find_spin_group
176
+
177
+ result = find_spin_group(example_path("0.800_MnTe.mcif"))
178
+
179
+ # Default public `.scif` output: legacy profile in the oriented-G0 setting.
180
+ scif_text = result.scif
181
+
182
+ # The same output is also available explicitly.
183
+ assert scif_text == result.to_scif(profile="legacy", cell_mode="g0std_oriented")
184
+
185
+ # Additional export profiles / cell modes exist for audit and roundtrip work.
186
+ scif_working = result.to_scif(profile="spincif_working", cell_mode="g0std_oriented")
187
+ scif_primitive = result.to_scif(profile="legacy", cell_mode="magnetic_primitive")
188
+ ```
189
+
190
+ Current `.scif` generator rules:
191
+
192
+ - repo-local FINDSPINGROUP metadata is emitted under CIF-legal
193
+ `_space_group_spin.fsg_*` tags
194
+ - symmetry-operation and transform coefficients keep full precision by default
195
+ - values close to simple fractions or common square-root forms may be written as
196
+ symbolic expressions such as `1/3`, `2/3`, or `sqrt(6)/3`
197
+ - repo-generated `.scif` files can be parsed back with `find_spin_group(...)`
198
+ and are regression-tested to preserve the identified `index`
199
+
200
+ ## License
201
+ This project is licensed under the Apache License, Version 2.0.
202
+ See the LICENSE file for details.
@@ -0,0 +1,173 @@
1
+ # findspingroup
2
+
3
+ `findspingroup` is a Python toolkit for identifying and analyzing **Spin Space Group (SSG)** symmetry of magnetic crystal structures.
4
+ Given a magnetic CIF file, it determines the corresponding spin space group, constructs a standardized primitive magnetic cell, and provides symmetry- and property-related results for downstream first-principles workflows.
5
+
6
+ The project is designed for **research use**, **high-throughput screening**, and **integration with DFT pipelines**.
7
+
8
+ ## What it does
9
+
10
+ Given a magnetic structure, `findspingroup` can:
11
+
12
+ - identify the spin space group and index
13
+ - construct primitive and standardized settings
14
+ - expose symmetry operations and international-style symbols
15
+ - export repo-generated `.scif` snapshots for roundtrip and workflow use
16
+ - provide symmetry-constrained property outputs for downstream calculations
17
+
18
+ ## Installation
19
+
20
+ ### From PyPI
21
+
22
+ ```bash
23
+ pip install findspingroup
24
+ ```
25
+
26
+ Python version: `>= 3.11`
27
+
28
+ ### From source
29
+
30
+ ```bash
31
+ git clone https://github.com/LiuQH-lab/FindSpinGroup.git
32
+ cd FindSpinGroup
33
+ pip install -e .
34
+ ```
35
+
36
+ ## 30-second example
37
+
38
+ ```python
39
+ from findspingroup import example_path, find_spin_group
40
+
41
+ result = find_spin_group(example_path("0.800_MnTe.mcif"))
42
+ print(result.index)
43
+ print(result.acc)
44
+ print(result.convention_ssg_international_linear)
45
+ ```
46
+
47
+ Minimal smoke check:
48
+
49
+ ```bash
50
+ python - <<'PY'
51
+ from findspingroup import example_path, find_spin_group
52
+ result = find_spin_group(example_path("0.800_MnTe.mcif"))
53
+ print(result.index)
54
+ print(result.convention_ssg_international_linear)
55
+ PY
56
+ ```
57
+
58
+ ## Supported inputs
59
+
60
+ `findspingroup` accepts:
61
+
62
+ - standard `.cif`
63
+ - magnetic `.mcif`
64
+ - repo-generated `.scif`
65
+ - a narrow first-version magnetic `POSCAR` contract used by this project
66
+
67
+ ## Main API
68
+
69
+ ```python
70
+ def find_spin_group(
71
+ cif: str,
72
+ space_tol: float = 0.02,
73
+ mtol: float = 0.02,
74
+ meigtol: float = 0.00002,
75
+ matrix_tol: float = 0.01,
76
+ ) -> MagSymmetryResult
77
+ ```
78
+
79
+ The function returns a `MagSymmetryResult` object containing the symmetry analysis result.
80
+
81
+ ## Common outputs
82
+
83
+ Useful fields on `MagSymmetryResult` include:
84
+
85
+ - `index`
86
+ - `acc`
87
+ - `msg_num`
88
+ - `msg_symbol`
89
+ - `convention_ssg_international_linear`
90
+ - `gspg_symbol_linear`
91
+ - `scif`
92
+
93
+ Example:
94
+
95
+ ```python
96
+ from findspingroup import example_path, find_spin_group
97
+
98
+ result = find_spin_group(example_path("1.237_VCl2.mcif"))
99
+
100
+ print("index:", result.index)
101
+ print("acc:", result.acc)
102
+ print("msg:", result.msg_symbol)
103
+ print("convention:", result.convention_ssg_international_linear)
104
+ ```
105
+
106
+ ## Input details
107
+
108
+ `findspingroup` supports standard `.cif`, magnetic `.mcif`, the current
109
+ repo-generated `.scif` files, and a narrow first-version `POSCAR` parser for
110
+ repo-generated magnetic POSCAR text.
111
+
112
+ * **Standard CIF**: Uses structural positions.
113
+ * **MCIF (Magnetic CIF)**: Supports files generated by **FINDSYM**, **ISOTROPY**, or **Vesta**.
114
+ * The parser looks for `_atom_site_moment` tags.
115
+ * It automatically handles magnetic vectors ($m_x, m_y, m_z$).
116
+ * **SCIF**: Supports the current repo-generated `.scif` contract for generator /
117
+ parser roundtrip work.
118
+ * **POSCAR**: Currently supports the repo-generated `CrystalCell.to_poscar(...)`
119
+ contract only.
120
+ * official POSCAR structural variants:
121
+ * `Direct`
122
+ * `Cartesian`
123
+ * optional `Selective dynamics`
124
+ * one / three scale factors
125
+ * negative target-volume scale
126
+ * optional trailing `# MAGMOM=` line
127
+ * if absent, moments default to zero
128
+ * multiple `#`, tabs, and extra spaces around `MAGMOM =` are tolerated
129
+ * if no inline `MAGMOM` is present, a sibling `INCAR` `MAGMOM` entry is
130
+ also supported
131
+ * repeated entries such as `6*0.0`
132
+ * `;` inline statements
133
+ * `\\` continuation
134
+ * `#` / `!` comments
135
+ * `NIONS` scalar form is currently promoted to the default z axis
136
+ * basename `POSCAR` / `CONTCAR` or suffix `.poscar` / `.vasp`
137
+ * species names are still required; VASP4 species-omitted files are not yet supported
138
+
139
+ ## `.scif` export and roundtrip
140
+
141
+ `findspingroup` can export a repo-generated spinCIF-style `.scif` snapshot from a
142
+ `MagSymmetryResult`, and can also parse that generated `.scif` back through the
143
+ same public input path.
144
+
145
+ ```python
146
+ from findspingroup import example_path, find_spin_group
147
+
148
+ result = find_spin_group(example_path("0.800_MnTe.mcif"))
149
+
150
+ # Default public `.scif` output: legacy profile in the oriented-G0 setting.
151
+ scif_text = result.scif
152
+
153
+ # The same output is also available explicitly.
154
+ assert scif_text == result.to_scif(profile="legacy", cell_mode="g0std_oriented")
155
+
156
+ # Additional export profiles / cell modes exist for audit and roundtrip work.
157
+ scif_working = result.to_scif(profile="spincif_working", cell_mode="g0std_oriented")
158
+ scif_primitive = result.to_scif(profile="legacy", cell_mode="magnetic_primitive")
159
+ ```
160
+
161
+ Current `.scif` generator rules:
162
+
163
+ - repo-local FINDSPINGROUP metadata is emitted under CIF-legal
164
+ `_space_group_spin.fsg_*` tags
165
+ - symmetry-operation and transform coefficients keep full precision by default
166
+ - values close to simple fractions or common square-root forms may be written as
167
+ symbolic expressions such as `1/3`, `2/3`, or `sqrt(6)/3`
168
+ - repo-generated `.scif` files can be parsed back with `find_spin_group(...)`
169
+ and are regression-tested to preserve the identified `index`
170
+
171
+ ## License
172
+ This project is licensed under the Apache License, Version 2.0.
173
+ See the LICENSE file for details.
@@ -0,0 +1,57 @@
1
+ [build-system]
2
+ requires = ["setuptools>=68", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "findspingroup"
7
+ description = "Spin space group (SSG) symmetry analysis toolkit for magnetic materials. Automatically identifies and classifies SSGs, generating symmetry operations, spin Wyckoff positions, and spin Brillouin zones. Designed for integration with first-principles and high-throughput computational workflows."
8
+ readme = "README.md"
9
+ license = "Apache-2.0"
10
+ license-files = ["LICENSE"]
11
+ authors = [{ name = "Yutong Yu", email = "karl.yt.yu@gmail.com" }]
12
+ maintainers = [{ name = "Yutong Yu", email = "karl.yt.yu@gmail.com" }]
13
+ requires-python = ">=3.11"
14
+ dependencies = [
15
+ "numpy>=1.26.0",
16
+ "scipy>=1.17.0",
17
+ "seekpath>=2.1.0",
18
+ "spglib>=2.6.0",
19
+ "spintensor",
20
+ ]
21
+ classifiers = [
22
+ "Development Status :: 3 - Alpha",
23
+ "Intended Audience :: Science/Research",
24
+ "Programming Language :: Python :: 3",
25
+ "Programming Language :: Python :: 3.11",
26
+ "Programming Language :: Python :: 3.12",
27
+ "Topic :: Scientific/Engineering :: Physics",
28
+ ]
29
+ keywords = ["spin space group", "magnetic symmetry", "crystallography", "spglib", "spinCIF"]
30
+ dynamic = ["version"]
31
+
32
+ [project.optional-dependencies]
33
+ dev = ["pytest>=8.4.2"]
34
+
35
+ [project.urls]
36
+ Homepage = "https://github.com/LiuQH-lab/FindSpinGroup"
37
+ Repository = "https://github.com/LiuQH-lab/FindSpinGroup"
38
+ Issues = "https://github.com/LiuQH-lab/FindSpinGroup/issues"
39
+
40
+ [tool.setuptools.dynamic]
41
+ version = {attr = "findspingroup.version.__version__"}
42
+
43
+ [tool.setuptools.packages.find]
44
+ where = ["src"]
45
+ include = ["findspingroup*"]
46
+ namespaces = false
47
+
48
+ [tool.setuptools.package-data]
49
+ findspingroup = ["core/identify_index/databases/*.db", "examples/*.mcif"]
50
+
51
+ [project.scripts]
52
+ fsg = "findspingroup.cli:main"
53
+ fsg-batch = "findspingroup.batch_mcif:main"
54
+ findspin = "findspingroup.cli:main"
55
+ findspin-batch = "findspingroup.batch_mcif:main"
56
+ findspingroup = "findspingroup.cli:main"
57
+ findspingroup-batch = "findspingroup.batch_mcif:main"
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,4 @@
1
+ from .find_spin_group import find_spin_group, find_spin_group_from_data
2
+ from .examples import example_path
3
+
4
+ __all__ = ['find_spin_group', 'find_spin_group_from_data', 'example_path']