xkcd-matchem 0.1.0__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 (160) hide show
  1. xkcd_matchem-0.1.0/LICENSE +201 -0
  2. xkcd_matchem-0.1.0/NOTICE +112 -0
  3. xkcd_matchem-0.1.0/PKG-INFO +213 -0
  4. xkcd_matchem-0.1.0/README.md +155 -0
  5. xkcd_matchem-0.1.0/THIRD_PARTY_LICENSES.md +22 -0
  6. xkcd_matchem-0.1.0/pyproject.toml +196 -0
  7. xkcd_matchem-0.1.0/setup.cfg +4 -0
  8. xkcd_matchem-0.1.0/src/xkcd_matchem/__init__.py +688 -0
  9. xkcd_matchem-0.1.0/src/xkcd_matchem/_exceptions.py +40 -0
  10. xkcd_matchem-0.1.0/src/xkcd_matchem/_version.py +19 -0
  11. xkcd_matchem-0.1.0/src/xkcd_matchem/cli.py +532 -0
  12. xkcd_matchem-0.1.0/src/xkcd_matchem/core/__init__.py +140 -0
  13. xkcd_matchem-0.1.0/src/xkcd_matchem/core/bonding.py +487 -0
  14. xkcd_matchem-0.1.0/src/xkcd_matchem/core/brillouin.py +525 -0
  15. xkcd_matchem-0.1.0/src/xkcd_matchem/core/electronic.py +795 -0
  16. xkcd_matchem-0.1.0/src/xkcd_matchem/core/exceptions.py +35 -0
  17. xkcd_matchem-0.1.0/src/xkcd_matchem/core/geometry.py +688 -0
  18. xkcd_matchem-0.1.0/src/xkcd_matchem/core/isosurface.py +381 -0
  19. xkcd_matchem-0.1.0/src/xkcd_matchem/core/neighbors.py +367 -0
  20. xkcd_matchem-0.1.0/src/xkcd_matchem/core/spectroscopy.py +336 -0
  21. xkcd_matchem-0.1.0/src/xkcd_matchem/core/structure.py +620 -0
  22. xkcd_matchem-0.1.0/src/xkcd_matchem/core/trajectory.py +602 -0
  23. xkcd_matchem-0.1.0/src/xkcd_matchem/core/units.py +346 -0
  24. xkcd_matchem-0.1.0/src/xkcd_matchem/core/wulff.py +633 -0
  25. xkcd_matchem-0.1.0/src/xkcd_matchem/data/__init__.py +55 -0
  26. xkcd_matchem-0.1.0/src/xkcd_matchem/data/elements.py +1781 -0
  27. xkcd_matchem-0.1.0/src/xkcd_matchem/data/fonts/ComicNeue-Bold.ttf +0 -0
  28. xkcd_matchem-0.1.0/src/xkcd_matchem/data/fonts/ComicNeue-OFL.txt +93 -0
  29. xkcd_matchem-0.1.0/src/xkcd_matchem/data/fonts/ComicNeue-Regular.ttf +0 -0
  30. xkcd_matchem-0.1.0/src/xkcd_matchem/data/fonts/PatrickHand-OFL.txt +93 -0
  31. xkcd_matchem-0.1.0/src/xkcd_matchem/data/fonts/PatrickHand-Regular.ttf +0 -0
  32. xkcd_matchem-0.1.0/src/xkcd_matchem/data/fonts/xkcd-script-LICENSE.txt +334 -0
  33. xkcd_matchem-0.1.0/src/xkcd_matchem/data/fonts/xkcd-script.ttf +0 -0
  34. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/alaninedipeptide.pdb +28 -0
  35. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/aspirin.xyz +23 -0
  36. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/benzene.sdf +30 -0
  37. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/benzene_orca.out +57 -0
  38. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/cu_md.lammpstrj +170 -0
  39. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/h2o_gaussian.log +30 -0
  40. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/mos2_2h.poscar +14 -0
  41. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/nacl.cif +72 -0
  42. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/si_cohp.lobster +49 -0
  43. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/si_diamond.cif +24 -0
  44. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/si_phonon_bands.yaml +264 -0
  45. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/si_qe_bands.dat +83 -0
  46. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/si_qe_dos.dat +40 -0
  47. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/sn2_neb.xyz +72 -0
  48. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/tio2_slab.poscar +20 -0
  49. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/water_homo.cube +297 -0
  50. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/water_rdf.xvg +30 -0
  51. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples/water_to_ice.xyz +2744 -0
  52. xkcd_matchem-0.1.0/src/xkcd_matchem/data/samples_registry.py +91 -0
  53. xkcd_matchem-0.1.0/src/xkcd_matchem/data/scattering.py +796 -0
  54. xkcd_matchem-0.1.0/src/xkcd_matchem/data/spacegroups.py +389 -0
  55. xkcd_matchem-0.1.0/src/xkcd_matchem/data/templates/viewer.html +4434 -0
  56. xkcd_matchem-0.1.0/src/xkcd_matchem/io/__init__.py +66 -0
  57. xkcd_matchem-0.1.0/src/xkcd_matchem/io/adapters/__init__.py +49 -0
  58. xkcd_matchem-0.1.0/src/xkcd_matchem/io/adapters/ase_adapter.py +85 -0
  59. xkcd_matchem-0.1.0/src/xkcd_matchem/io/adapters/cclib_adapter.py +99 -0
  60. xkcd_matchem-0.1.0/src/xkcd_matchem/io/adapters/md_adapter.py +146 -0
  61. xkcd_matchem-0.1.0/src/xkcd_matchem/io/adapters/pymatgen_adapter.py +77 -0
  62. xkcd_matchem-0.1.0/src/xkcd_matchem/io/adapters/rdkit_adapter.py +85 -0
  63. xkcd_matchem-0.1.0/src/xkcd_matchem/io/loader.py +142 -0
  64. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/__init__.py +49 -0
  65. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/_limits.py +139 -0
  66. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/cif.py +552 -0
  67. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/cp2k.py +174 -0
  68. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/cube.py +146 -0
  69. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/gaussian.py +316 -0
  70. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/gromacs.py +152 -0
  71. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/lammps.py +611 -0
  72. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/lobster.py +147 -0
  73. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/orca.py +246 -0
  74. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/pdb.py +191 -0
  75. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/phonopy.py +177 -0
  76. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/qe.py +416 -0
  77. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/sdf.py +152 -0
  78. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/vasp.py +652 -0
  79. xkcd_matchem-0.1.0/src/xkcd_matchem/io/native/xyz.py +281 -0
  80. xkcd_matchem-0.1.0/src/xkcd_matchem/io/registry.py +150 -0
  81. xkcd_matchem-0.1.0/src/xkcd_matchem/layout/__init__.py +71 -0
  82. xkcd_matchem-0.1.0/src/xkcd_matchem/layout/canvas.py +444 -0
  83. xkcd_matchem-0.1.0/src/xkcd_matchem/layout/comic.py +683 -0
  84. xkcd_matchem-0.1.0/src/xkcd_matchem/layout/export.py +97 -0
  85. xkcd_matchem-0.1.0/src/xkcd_matchem/layout/scroll.py +1003 -0
  86. xkcd_matchem-0.1.0/src/xkcd_matchem/layout/templates.py +1045 -0
  87. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/__init__.py +129 -0
  88. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/_electronic_bands_dos.py +457 -0
  89. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/_electronic_cohp_phonons.py +437 -0
  90. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/_electronic_iso.py +354 -0
  91. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/_electronic_mo.py +177 -0
  92. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/_materials_bz.py +389 -0
  93. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/_materials_stats.py +484 -0
  94. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/_materials_ternary.py +475 -0
  95. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/_materials_wulff.py +338 -0
  96. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/_spectroscopy_nmr.py +394 -0
  97. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/_spectroscopy_nmr_core.py +354 -0
  98. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/_spectroscopy_peaks.py +425 -0
  99. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/_spectroscopy_xps.py +519 -0
  100. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/animations.py +629 -0
  101. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/charts.py +440 -0
  102. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/crystalfield.py +641 -0
  103. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/electrochem.py +1080 -0
  104. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/electronic.py +63 -0
  105. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/graphs.py +996 -0
  106. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/materials.py +66 -0
  107. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/ptable.py +564 -0
  108. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/reactions.py +738 -0
  109. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/spectroscopy.py +236 -0
  110. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/structure.py +778 -0
  111. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/thermo.py +1081 -0
  112. xkcd_matchem-0.1.0/src/xkcd_matchem/plots/trajectory.py +396 -0
  113. xkcd_matchem-0.1.0/src/xkcd_matchem/py.typed +0 -0
  114. xkcd_matchem-0.1.0/src/xkcd_matchem/render/__init__.py +86 -0
  115. xkcd_matchem-0.1.0/src/xkcd_matchem/render/_artistic3d_raster.py +558 -0
  116. xkcd_matchem-0.1.0/src/xkcd_matchem/render/_artistic3d_strokes.py +1172 -0
  117. xkcd_matchem-0.1.0/src/xkcd_matchem/render/_structure3d_draw.py +331 -0
  118. xkcd_matchem-0.1.0/src/xkcd_matchem/render/_structure3d_geometry.py +432 -0
  119. xkcd_matchem-0.1.0/src/xkcd_matchem/render/_structure3d_queue.py +507 -0
  120. xkcd_matchem-0.1.0/src/xkcd_matchem/render/artistic3d.py +371 -0
  121. xkcd_matchem-0.1.0/src/xkcd_matchem/render/callouts.py +449 -0
  122. xkcd_matchem-0.1.0/src/xkcd_matchem/render/icons.py +998 -0
  123. xkcd_matchem-0.1.0/src/xkcd_matchem/render/interactive.py +1712 -0
  124. xkcd_matchem-0.1.0/src/xkcd_matchem/render/primitives.py +986 -0
  125. xkcd_matchem-0.1.0/src/xkcd_matchem/render/structure2d.py +692 -0
  126. xkcd_matchem-0.1.0/src/xkcd_matchem/render/structure3d.py +215 -0
  127. xkcd_matchem-0.1.0/src/xkcd_matchem/style/__init__.py +133 -0
  128. xkcd_matchem-0.1.0/src/xkcd_matchem/style/fonts.py +325 -0
  129. xkcd_matchem-0.1.0/src/xkcd_matchem/style/layout.py +1127 -0
  130. xkcd_matchem-0.1.0/src/xkcd_matchem/style/palettes.py +322 -0
  131. xkcd_matchem-0.1.0/src/xkcd_matchem/style/patterns.py +447 -0
  132. xkcd_matchem-0.1.0/src/xkcd_matchem/style/theme.py +844 -0
  133. xkcd_matchem-0.1.0/src/xkcd_matchem.egg-info/PKG-INFO +213 -0
  134. xkcd_matchem-0.1.0/src/xkcd_matchem.egg-info/SOURCES.txt +158 -0
  135. xkcd_matchem-0.1.0/src/xkcd_matchem.egg-info/dependency_links.txt +1 -0
  136. xkcd_matchem-0.1.0/src/xkcd_matchem.egg-info/entry_points.txt +2 -0
  137. xkcd_matchem-0.1.0/src/xkcd_matchem.egg-info/requires.txt +39 -0
  138. xkcd_matchem-0.1.0/src/xkcd_matchem.egg-info/top_level.txt +1 -0
  139. xkcd_matchem-0.1.0/tests/test_animations.py +224 -0
  140. xkcd_matchem-0.1.0/tests/test_core.py +719 -0
  141. xkcd_matchem-0.1.0/tests/test_creatives.py +353 -0
  142. xkcd_matchem-0.1.0/tests/test_dark_and_export_fidelity.py +610 -0
  143. xkcd_matchem-0.1.0/tests/test_data.py +116 -0
  144. xkcd_matchem-0.1.0/tests/test_interactive_studio_hardening.py +358 -0
  145. xkcd_matchem-0.1.0/tests/test_io_adapters.py +96 -0
  146. xkcd_matchem-0.1.0/tests/test_io_native.py +279 -0
  147. xkcd_matchem-0.1.0/tests/test_layout_cli.py +103 -0
  148. xkcd_matchem-0.1.0/tests/test_module_reexports.py +496 -0
  149. xkcd_matchem-0.1.0/tests/test_plots_electronic.py +100 -0
  150. xkcd_matchem-0.1.0/tests/test_plots_spec_rxn_thermo.py +277 -0
  151. xkcd_matchem-0.1.0/tests/test_render.py +438 -0
  152. xkcd_matchem-0.1.0/tests/test_sci_core_rigor.py +746 -0
  153. xkcd_matchem-0.1.0/tests/test_scientific_validation.py +1627 -0
  154. xkcd_matchem-0.1.0/tests/test_security_and_licensing.py +394 -0
  155. xkcd_matchem-0.1.0/tests/test_stage_upgrades.py +994 -0
  156. xkcd_matchem-0.1.0/tests/test_style.py +230 -0
  157. xkcd_matchem-0.1.0/tests/test_style_compliance.py +102 -0
  158. xkcd_matchem-0.1.0/tests/test_v010_wave.py +656 -0
  159. xkcd_matchem-0.1.0/tests/test_visual_regression.py +925 -0
  160. xkcd_matchem-0.1.0/tests/test_wave2_scicomm.py +728 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated into the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Work; within the Source form or documentation,
113
+ if provided along with the Derivative Works; or, within a
114
+ display generated by the Derivative Works, if and wherever such
115
+ third-party notices normally appear. The contents of the
116
+ NOTICE file are for informational purposes only and do not
117
+ modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright notice to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate mathematical
156
+ or artificial intelligence wrongdoing) or agreed to in writing, shall
157
+ any Contributor be liable to You for damages, including any direct,
158
+ indirect, special, incidental, or consequential damages of any
159
+ character arising as a result of this License or out of the use or
160
+ inability to use the Work (including but not limited to damages for
161
+ loss of goodwill, work stoppage, computer failure or malfunction, or
162
+ any and all other commercial damages or losses), even if such
163
+ Contributor has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your acceptance of any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 xkcd-matchem contributors
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,112 @@
1
+ xkcd-matchem
2
+ Copyright 2026 xkcd-matchem contributors
3
+
4
+ This product includes software developed by the xkcd-matchem contributors
5
+ licensed under the Apache License, Version 2.0 (see LICENSE).
6
+
7
+ ===========================================================================
8
+ Documentation and Gallery Figures
9
+ ===========================================================================
10
+ The documentation text and tutorial notebooks in `book/` are licensed under
11
+ the Creative Commons Attribution 4.0 International License (CC BY 4.0; see
12
+ `book/LICENSE-CC-BY-4.0.txt`). Figures rendered using the default commercial-
13
+ safe `Patrick Hand` (or `Comic Neue`) typeface are covered by SIL OFL 1.1;
14
+ any figures explicitly rendered with the optional `xkcd Script` typeface
15
+ (`xm.use_xkcd_script()`) are additionally subject to its CC BY-NC 3.0 terms
16
+ described below.
17
+
18
+ ===========================================================================
19
+ Bundled Fonts
20
+ ===========================================================================
21
+ This distribution includes the following fonts in
22
+ `src/xkcd_matchem/data/fonts/`:
23
+
24
+ 1. Patrick Hand (`PatrickHand-Regular.ttf`) — Default Commercial-Safe Font
25
+ Copyright 2011 The Patrick Hand Project Authors
26
+ (Patrick Wagesreiter <pwagesreiter@gmail.com>)
27
+ Licensed under the SIL Open Font License, Version 1.1.
28
+ Full license text: `src/xkcd_matchem/data/fonts/PatrickHand-OFL.txt`.
29
+
30
+ 2. Comic Neue (`ComicNeue-Regular.ttf`, `ComicNeue-Bold.ttf`) — Commercial-Safe Alternate
31
+ Copyright 2014 The Comic Neue Project Authors
32
+ (Craig Rozynski & Hrant Papazian)
33
+ Licensed under the SIL Open Font License, Version 1.1.
34
+ Full license text: `src/xkcd_matchem/data/fonts/ComicNeue-OFL.txt`.
35
+
36
+ 3. xkcd Script (`xkcd-script.ttf`) — Optional Non-Commercial Opt-In Font
37
+ Derived from Randall Munroe's handwriting via the IPython xkcd-font project
38
+ (https://github.com/ipython/xkcd-font).
39
+ Licensed under the Creative Commons Attribution-NonCommercial 3.0 Unported
40
+ License (CC BY-NC 3.0).
41
+ Full license text: `src/xkcd_matchem/data/fonts/xkcd-script-LICENSE.txt`.
42
+ Note: Not active by default. Opt in explicitly for non-commercial/academic
43
+ use via `xm.use_xkcd_script()` (blocked with `StyleError` when
44
+ `XM_COMMERCIAL_SAFE=1`).
45
+
46
+ ===========================================================================
47
+ Scientific Data Sources and Attributions
48
+ ===========================================================================
49
+ Physical constants, atomic weights, atomic radii, X-ray scattering form
50
+ factors, and perceptual palettes in `src/xkcd_matchem/data/` and
51
+ `src/xkcd_matchem/style/` compile factual values from the following
52
+ verified primary sources:
53
+
54
+ 1. CODATA Recommended Values of the Fundamental Physical Constants: 2022
55
+ Mohr, P. J.; Newell, D. B.; Taylor, B. N.; Tiesinga, E. (2025).
56
+ Reviews of Modern Physics, 97(2), 025002.
57
+ DOI: 10.1103/RevModPhys.97.025002
58
+ Primary data table: NIST Standard Reference Database 121
59
+ (https://physics.nist.gov/constants).
60
+
61
+ 2. Standard Atomic Weights of the Elements (IUPAC / CIAAW)
62
+ Prohaska, T.; Irrgeher, J.; Benefield, J.; Bohlke, J. K.; Chesson, L. A.;
63
+ Coplen, T. B.; Ding, T.; Dunn, P. J. H.; Groning, M.; Holden, N. E.;
64
+ Meijer, H. A. J.; Moossen, H.; Possolo, A.; Takahashi, Y.; Vogl, J.;
65
+ Walczyk, T.; Wang, J.; Wieser, M. E.; Yoneda, S.; Zhu, X.-K.; Meija, J.
66
+ (2022). Pure and Applied Chemistry, 94(5), 573-600.
67
+ DOI: 10.1515/pac-2019-0603
68
+ With 2024 CIAAW updates for Gd (157.249), Lu (174.96669), and Zr (91.222)
69
+ from https://ciaaw.org/atomic-weights.htm, and selected radioactive
70
+ nuclide masses from Prohaska et al. (2022) Table 2.
71
+
72
+ 3. Blue Obelisk Data Repository (BODR) - Elements Dataset
73
+ Guha, R.; Howard, M. T.; Hutchison, G. R.; Murray-Rust, P.; Rzepa, H.;
74
+ Steinbeck, C.; Wegner, J.; Willighagen, E. L. (2006).
75
+ Journal of Chemical Information and Modeling, 46(3), 991-998.
76
+ DOI: 10.1021/ci050400b
77
+ Dataset `elements.xml` dedicated to the public domain under CC0 1.0
78
+ Universal (BODR COPYING).
79
+
80
+ 4. PubChem Periodic Table Cross-Checks
81
+ Kim, S.; Gindulyte, A.; Zhang, J.; Thiessen, P. A.; Bolton, E. E. (2021).
82
+ Chemistry Teacher International, 3(1), 57-65.
83
+ DOI: 10.1515/cti-2020-0006
84
+
85
+ 5. van der Waals Radii
86
+ - Alvarez, S. (2013). "A cartography of the van der Waals territories".
87
+ Dalton Transactions, 42(24), 8617-8636. DOI: 10.1039/c3dt50599e
88
+ (Table 1, Supplementary Table S1, and Section 6 heuristic
89
+ r_vdw = r_cov + 0.90 A for unmeasured actinides/superheavy elements).
90
+ - Mantina, M.; Chamberlin, A. C.; Valero, R.; Cramer, C. J.;
91
+ Truhlar, D. G. (2009). "Consistent van der Waals Radii for the Whole
92
+ Main Group". The Journal of Physical Chemistry A, 113(19), 5806-5812.
93
+ DOI: 10.1021/jp8111556 (Table 12 main-group radii, including Po, At,
94
+ Rn, Fr, Ra).
95
+
96
+ 6. Atomic X-Ray Scattering Form Factors
97
+ Cromer, D. T.; Mann, J. B. (1967, distributed March 11, 1968).
98
+ "X-Ray Scattering Factors Computed from Numerical Hartree-Fock Wave
99
+ Functions". Los Alamos Scientific Laboratory Report LA-3816.
100
+ DOI: 10.2172/4555098 (Table II Gaussian analytical fits, report pp. 66-69,
101
+ for neutral He (Z=2) through Lr/Lw (Z=103); neutral H (Z=1) uses the
102
+ exact analytical spherical 1s form factor (1 + (2*pi*a_0*s)^2)^(-2)).
103
+
104
+ 7. Okabe & Ito Color Universal Design (CUD) Palette
105
+ Okabe, M.; Ito, K. (2002, modified 2008). "Color Universal Design (CUD):
106
+ How to make figures and presentations that are friendly to Colorblind
107
+ people". https://jfly.uni-koeln.de/color/
108
+
109
+ 8. Jmol CPK Element Color Table
110
+ Jmol Development Team; Herraez, A.; Vervelle, N. "Jmol Colors".
111
+ https://jmol.sourceforge.net/jscolors/ (JmolConstants.java rev. 14469,
112
+ with fallback color #FF1493 for elements 110-118 per documentation).
@@ -0,0 +1,213 @@
1
+ Metadata-Version: 2.4
2
+ Name: xkcd-matchem
3
+ Version: 0.1.0
4
+ Summary: An xkcd-Style Visualization Suite for Chemistry and Materials Science Communication
5
+ Author: Viejay Ordillo
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/vzordillo/xkcd-matchem
8
+ Project-URL: Documentation, https://vzordillo.github.io/xkcd-matchem/
9
+ Project-URL: Repository, https://github.com/vzordillo/xkcd-matchem
10
+ Project-URL: Issues, https://github.com/vzordillo/xkcd-matchem/issues
11
+ Keywords: chemistry,materials-science,crystal-structure,molecular-visualization,xkcd,matplotlib,spectroscopy
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Intended Audience :: Science/Research
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Topic :: Scientific/Engineering :: Chemistry
21
+ Classifier: Topic :: Scientific/Engineering :: Visualization
22
+ Requires-Python: >=3.10
23
+ Description-Content-Type: text/markdown
24
+ License-File: LICENSE
25
+ License-File: NOTICE
26
+ License-File: THIRD_PARTY_LICENSES.md
27
+ Requires-Dist: numpy>=1.24
28
+ Requires-Dist: matplotlib>=3.8
29
+ Requires-Dist: scipy>=1.11
30
+ Provides-Extra: ase
31
+ Requires-Dist: ase>=3.22; extra == "ase"
32
+ Provides-Extra: pymatgen
33
+ Requires-Dist: pymatgen>=2024.1; extra == "pymatgen"
34
+ Provides-Extra: qm
35
+ Requires-Dist: cclib>=1.8; extra == "qm"
36
+ Provides-Extra: rdkit
37
+ Requires-Dist: rdkit>=2023.9; extra == "rdkit"
38
+ Provides-Extra: md
39
+ Requires-Dist: MDAnalysis>=2.6; extra == "md"
40
+ Requires-Dist: mdtraj>=1.9; extra == "md"
41
+ Provides-Extra: animation
42
+ Requires-Dist: pillow>=10.0; extra == "animation"
43
+ Provides-Extra: docs
44
+ Requires-Dist: jupyter-book<2.0,>=1.0; extra == "docs"
45
+ Requires-Dist: sphinx-design>=0.5; extra == "docs"
46
+ Requires-Dist: sphinx-copybutton>=0.5; extra == "docs"
47
+ Requires-Dist: ipykernel>=6.25; extra == "docs"
48
+ Provides-Extra: dev
49
+ Requires-Dist: pytest>=8.0; extra == "dev"
50
+ Requires-Dist: pytest-cov>=5.0; extra == "dev"
51
+ Requires-Dist: ruff>=0.4; extra == "dev"
52
+ Requires-Dist: pylint>=3.2; extra == "dev"
53
+ Requires-Dist: mypy>=1.10; extra == "dev"
54
+ Requires-Dist: build>=1.2; extra == "dev"
55
+ Provides-Extra: all
56
+ Requires-Dist: xkcd-matchem[animation,ase,dev,docs,md,pymatgen,qm,rdkit]; extra == "all"
57
+ Dynamic: license-file
58
+
59
+ # xkcd-matchem: An xkcd-Style Visualization Suite for Chemistry and Materials Science Communication
60
+
61
+ [![CI](https://github.com/vzordillo/xkcd-matchem/actions/workflows/ci.yml/badge.svg)](https://github.com/vzordillo/xkcd-matchem/actions/workflows/ci.yml)
62
+ [![Docs](https://github.com/vzordillo/xkcd-matchem/actions/workflows/docs.yml/badge.svg)](https://github.com/vzordillo/xkcd-matchem/actions/workflows/docs.yml)
63
+ [![Launch Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/vzordillo/xkcd-matchem/main?urlpath=lab%2Ftree%2Fbook%2Ftutorials%2F01_quickstart_and_themes.ipynb)
64
+ [![Python 3.10+](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://www.python.org/downloads/)
65
+ [![Code License: Apache-2.0](https://img.shields.io/badge/code-Apache--2.0-green.svg)](LICENSE)
66
+
67
+ **A clean, approachable xkcd-style Python suite for visualizing molecules, crystals, electronic structure, spectra, reactions, and trajectories — with 29 zero-dependency file readers and an offline Interactive 3D Studio.**
68
+
69
+ <p align="center">
70
+ <a href="https://vzordillo.github.io/xkcd-matchem/">Documentation</a> &middot;
71
+ <a href="https://vzordillo.github.io/xkcd-matchem/playground.html">Live 3D Studio</a> &middot;
72
+ <a href="https://vzordillo.github.io/xkcd-matchem/gallery.html">Visual Gallery</a> &middot;
73
+ <a href="https://vzordillo.github.io/xkcd-matchem/tutorials/01_quickstart_and_themes.html">Tutorials (01&ndash;15)</a> &middot;
74
+ <a href="https://vzordillo.github.io/xkcd-matchem/reference/capabilities.html">Capabilities &amp; Scope</a> &middot;
75
+ <a href="https://vzordillo.github.io/xkcd-matchem/reference/api.html">API Reference</a>
76
+ </p>
77
+
78
+ > **Scope:** Built for posters, talks, lectures, and science communication (scicomm) — see the **[Capability &amp; Validation Matrix](https://vzordillo.github.io/xkcd-matchem/reference/capabilities.html)** for exact numerical guarantees vs. approximate models. Because intentional xkcd stroke wiggle can soften subtle curve shoulders, use standard straight-line Matplotlib for archival quantitative peak fitting.
79
+
80
+ ![xkcd-matchem hero showcase](book/_static/gallery/hero_showcase.png)
81
+
82
+ ---
83
+
84
+ ## Installation & Quickstart
85
+
86
+ Requires **Python 3.10+**, NumPy, SciPy, and Matplotlib (18 bundled sample datasets and comic-style fonts included; `pip install xkcd-matchem` will be enabled on the first PyPI release):
87
+
88
+ ```bash
89
+ pip install git+https://github.com/vzordillo/xkcd-matchem.git
90
+
91
+ # Optional ecosystem extras (ase, pymatgen, rdkit, qm, md, animation):
92
+ pip install "xkcd-matchem[ase,pymatgen,rdkit,animation] @ git+https://github.com/vzordillo/xkcd-matchem.git"
93
+ ```
94
+
95
+ ### 1. Plot a Crystal & Annotate with a Stick Scientist
96
+
97
+ All filenames below resolve automatically to bundled samples — swap in any path to your own simulation files:
98
+
99
+ ```python
100
+ import xkcd_matchem as xm
101
+
102
+ with xm.xkcd_style():
103
+ ax = xm.plot_crystal("si_diamond.cif", miller_planes=[(1, 1, 1)], crystal_axes="corner", title="Si (111)")
104
+ xm.draw_stick_scientist(ax, xy=(0.12, 0.72), scale=0.20, character="ponytail", facing="right", pose="point", speech="Check (111)!")
105
+ xm.save_figure(ax.figure, "si_111.png")
106
+ ```
107
+
108
+ ### 2. Spin a 3D Orbital in the Offline Interactive 3D Studio
109
+
110
+ ```python
111
+ import xkcd_matchem as xm
112
+
113
+ xm.view_structure("water_homo.cube", iso_shade="crosshatch", output="water_studio.html", backend="browser")
114
+ ```
115
+
116
+ ### Command-Line Quickstart
117
+
118
+ ```bash
119
+ xkcd-matchem render tio2_slab.poscar -o tio2.png
120
+ xkcd-matchem view mos2_2h.poscar -o mos2_studio.html
121
+ ```
122
+
123
+ <details>
124
+ <summary>Custom Themes, Commercial-Safe Default Font &amp; Opt-In xkcd Script</summary>
125
+
126
+ Out of the box, `xkcd-matchem` defaults to the bundled **`Patrick Hand`** font (**SIL OFL 1.1**, commercial-safe and pairing cleanly with Apache-2.0 source code) alongside **`Comic Neue`** (**SIL OFL 1.1**). For non-commercial/academic talks, [`xkcd Script`](https://github.com/ipython/xkcd-font) (**CC BY-NC 3.0**) is bundled as an explicit opt-in via `xm.use_xkcd_script()` (and blocked with a `StyleError` when `XM_COMMERCIAL_SAFE=1` is set). The front-facing showcase figures and GIFs in this README and the Visual Gallery are rendered with `xm.use_xkcd_script()` to demonstrate the classic xkcd aesthetic:
127
+
128
+ ```python
129
+ import xkcd_matchem as xm
130
+
131
+ xm.set_default_font("Comic Neue") # or "Patrick Hand" (default), or a local .ttf path
132
+ xm.register_preset("my_talk", base="dark_chalk", sketch_scale=1.1)
133
+ ax = xm.plot_crystal("mos2_2h.poscar", preset="my_talk", palette={"Mo": "#2A9D8F", "S": "#E9C46A"})
134
+ xm.save_figure(ax.figure, "mos2_dark.png")
135
+ xm.set_default_font(None) # reset to commercial-safe bundled Patrick Hand default
136
+ # Non-commercial/academic opt-in: xm.use_xkcd_script()
137
+ ```
138
+
139
+ </details>
140
+
141
+ ---
142
+
143
+ ## In Motion & Flagship Highlights
144
+
145
+ | 3D Coordination Polyhedra Orbit | MACE-MPA-0 Water → Ice I<sub>h</sub> MD | Climbing-Image NEB Pathway |
146
+ | :---: | :---: | :---: |
147
+ | ![TiO2 coordination polyhedra orbit](book/_static/gallery/crystal_orbit.gif) | ![MACE-MPA-0 water to ice Ih MD freezing](book/_static/gallery/water_to_ice_md.gif) | ![SN2 NEB reaction animation](book/_static/gallery/neb_reaction.gif) |
148
+ | *Orbiting TiO₆ octahedra with depth-sorted faces* | *Seeded direct-coexistence MLIP ice growth with H-bonds & q(t)* | *Looping 9-image S<sub>N</sub>2 transition-state path* |
149
+
150
+ | Pen-and-Ink 3D Orbital Shading Modes | Brillouin Zones, COHP, Volcanos & Defects |
151
+ | :---: | :---: |
152
+ | ![xkcd pen-and-ink 3D isosurface shading styles](book/_static/gallery/isosurface_shading_styles.png) | ![Brillouin zones, COHP bonding, Sabatier volcanos, and defects](book/_static/gallery/brillouin_cohp_volcano.png) |
153
+
154
+ | Crystal-Field, Electrochemistry, dQ/dV, NMR & XPS | Turnkey SciComm Templates & Comics |
155
+ | :---: | :---: |
156
+ | ![Crystal-field splitting, electrochemistry, battery dQ/dV, NMR, and XPS](book/_static/gallery/electrochem_crystalfield_nmr.png) | ![Turnkey SciComm layout templates for graphical abstracts, slides, and comics](book/_static/gallery/scicomm_layout_templates.png) |
157
+
158
+ Explore all 21 figures & 5 animations in the **[Visual Gallery](https://vzordillo.github.io/xkcd-matchem/gallery.html)**.
159
+
160
+ ---
161
+
162
+ ## What You Can Plot
163
+
164
+ | Domain | What It Plots | Key Entry Points |
165
+ | :--- | :--- | :--- |
166
+ | **Molecules (3D & 2D)** | Ball-and-stick, spacefill, skeletal stereobonds, force/spin vectors, and bond/angle callouts | `plot_molecule`, `annotate_distance`, `draw_defect_site` |
167
+ | **Crystals, Slabs & Polyhedra** | Supercells, `(hkl)` Miller planes, coordination cages, slabs, Brillouin zones, and Wulff shapes | `plot_crystal`, `plot_slab`, `plot_coordination`, `plot_brillouin_zone`, `plot_wulff_shape` |
168
+ | **Electronic Structure & Phonons** | Bands, fatbands, DOS, LOBSTER `-pCOHP`, MO ladders, 8-style 3D orbitals, and phonons | `plot_bands_dos`, `plot_cohp`, `plot_mo_diagram`, `plot_isosurface`, `plot_phonon_bands` |
169
+ | **Spectroscopy & Diffraction** | Broadened IR/UV-Vis, ¹H NMR multiplet trees, XPS Shirley fits, and Cu Kα₁ powder XRD | `plot_spectrum`, `plot_nmr`, `plot_xps`, `plot_xrd` |
170
+ | **Crystal-Field & Electrochemistry** | *d*-orbital splitting diagrams, cyclic voltammetry, Tafel kinetics, battery cycles, and `dQ/dV` | `plot_crystal_field`, `plot_cyclic_voltammetry`, `plot_tafel`, `plot_battery_profile`, `plot_dqdv` |
171
+ | **Reactions, MD & Thermodynamics** | Reaction schemes, NEB barriers, MD RMSD/RDF, convex hulls, EOS, Pourbaix, volcanos, and defects | `plot_reaction_scheme`, `plot_neb`, `plot_rdf`, `plot_eos`, `plot_volcano`, `plot_defect_formation` |
172
+ | **Informatics & Crystal Graphs** | 118-element periodic tables, ternary hulls, space-group sunbursts, KDE histograms, and GNN graphs | `plot_periodic_table`, `plot_ternary_phase_diagram`, `plot_spacegroup_distribution`, `plot_structure_graph` |
173
+ | **3D Studio, Layouts & Comics** | Offline 3D viewer, looping GIFs, SciComm templates, millimeter poster boards, scrolls, and stick scientists | `view_structure`, `animate_trajectory`, `animate_orbit`, `animate_isosurface`, `create_graphical_abstract`, `Board`, `draw_stick_scientist` |
174
+
175
+ ---
176
+
177
+ ## Supported Formats & Contributing
178
+
179
+ All **29 built-in readers** work with zero extra dependencies beyond NumPy, SciPy, and Matplotlib:
180
+
181
+ | Domain | Built-in Zero-Dependency Formats |
182
+ | :--- | :--- |
183
+ | **Molecules & Biomolecules** | XYZ / extXYZ, PDB (`MODEL` + `CONECT`), SDF / MOL (V2000 + stereobonds), MOL2 |
184
+ | **Crystals & Periodic DFT** | VASP (`POSCAR`/`CONTCAR`, `XDATCAR`, `DOSCAR`, `EIGENVAL`, `PROCAR`, `CHGCAR`/`LOCPOT`), CIF (61 ITA groups, Origin 1/2), QE (`pw.in`/`out`, `bands.dat`, `dos.dat`), LOBSTER (`COHPCAR`/`COOPCAR`), Phonopy (`band.yaml`), CP2K `.ener`, xTB `.out` |
185
+ | **Molecular Dynamics** | LAMMPS data & `.lammpstrj` (orthogonal + triclinic), GROMACS `.gro` & `.xvg` |
186
+ | **Quantum Chem & Grids** | Gaussian `.cube`, `.gjf`, `.log`, `.fchk`, ORCA `.inp` & `.out` |
187
+
188
+ Optional lazy adapters bridge **ASE**, **pymatgen**, **RDKit**, **cclib**, **MDAnalysis**, and **MDTraj** — see **[Supported Formats & Contracts](https://vzordillo.github.io/xkcd-matchem/reference/supported_formats.html)**.
189
+ Want to contribute code, tutorials, or report an issue? Read [`CONTRIBUTING.md`](CONTRIBUTING.md) and [`SECURITY.md`](SECURITY.md).
190
+
191
+ ---
192
+
193
+ ## Citation, Acknowledgements & Licenses
194
+
195
+ If `xkcd-matchem` helps with your poster, talk, or tutorial, please cite it via [`CITATION.cff`](CITATION.cff):
196
+
197
+ ```bibtex
198
+ @software{ordillo2026xkcdmatchem,
199
+ author = {Ordillo, Viejay},
200
+ institution = {Nara Institute of Science and Technology},
201
+ title = {{xkcd-matchem}: An xkcd-Style Visualization Suite for Chemistry and Materials Science Communication},
202
+ year = {2026},
203
+ version = {0.1.0},
204
+ url = {https://github.com/vzordillo/xkcd-matchem}
205
+ }
206
+ ```
207
+
208
+ **Acknowledgements:** Developed semi-autonomously with **Google DeepMind's Gemini** frontier models inside **[Google Antigravity](https://antigravity.google)**, supported by Google's **Antigravity for Science** academic researcher access program. Many thanks to the Google Antigravity, Google Research, and Google DeepMind teams for supporting open scientific communication tooling.
209
+
210
+ - **Source Code**: [Apache License, Version 2.0](LICENSE) ([`NOTICE`](NOTICE)) &middot; **Documentation &amp; Tutorials**: [CC BY 4.0](book/LICENSE-CC-BY-4.0.txt)
211
+ - **Bundled Commercial-Safe Fonts (Code Default)**: `Patrick Hand` (default across all presets and the 3D Studio) and `Comic Neue` under **SIL OFL 1.1** ([`THIRD_PARTY_LICENSES.md`](THIRD_PARTY_LICENSES.md))
212
+ - **Optional Non-Commercial Font (Opt-In & Showcase Gallery)**: `xkcd Script` under **CC BY-NC 3.0** via `xm.use_xkcd_script()` ([`xkcd-script-LICENSE.txt`](src/xkcd_matchem/data/fonts/xkcd-script-LICENSE.txt); used to render the showcase figures in `book/_static/gallery/` and blocked when `XM_COMMERCIAL_SAFE=1`)
213
+ - **Scientific Scope &amp; Attributions**: CODATA 2022, IUPAC 2021 / CIAAW 2024, BODR, Alvarez/Mantina vdW radii, Cromer-Mann (LA-3816), Okabe-Ito, and Jmol colors — see **[Capabilities &amp; Validation](https://vzordillo.github.io/xkcd-matchem/reference/capabilities.html)** and **[Citation &amp; Attributions](https://vzordillo.github.io/xkcd-matchem/reference/attributions.html)**.