SHAnC 0.0.1__py3-none-any.whl

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 (81) hide show
  1. shanc/README.md +24 -0
  2. shanc/__init__.py +37 -0
  3. shanc/__pycache__/__init__.cpython-314.pyc +0 -0
  4. shanc/__pycache__/add_chromophore.cpython-314.pyc +0 -0
  5. shanc/__pycache__/analysis.cpython-314.pyc +0 -0
  6. shanc/__pycache__/cycle_extraction.cpython-314.pyc +0 -0
  7. shanc/__pycache__/distortion.cpython-314.pyc +0 -0
  8. shanc/__pycache__/helix.cpython-314.pyc +0 -0
  9. shanc/__pycache__/helix_object.cpython-314.pyc +0 -0
  10. shanc/__pycache__/import_libraries.cpython-314.pyc +0 -0
  11. shanc/__pycache__/read_write.cpython-314.pyc +0 -0
  12. shanc/add_chromophore.py +1988 -0
  13. shanc/analysis.py +1594 -0
  14. shanc/cycle_extraction.py +556 -0
  15. shanc/demo_system/Analysis_example/Add_chromophore.py +189 -0
  16. shanc/demo_system/Analysis_example/Analyze_surface.py +161 -0
  17. shanc/demo_system/Analysis_example/Extract_cycles.py +101 -0
  18. shanc/demo_system/Analysis_example/README.md +42 -0
  19. shanc/demo_system/Analysis_example/Structure_validation.py +79 -0
  20. shanc/demo_system/Analysis_example/au_pitch_200/README.md +1 -0
  21. shanc/demo_system/Analysis_example/au_pitch_200/au_helix/Au.data +19 -0
  22. shanc/demo_system/Analysis_example/au_pitch_200/au_helix/README.md +1 -0
  23. shanc/demo_system/Analysis_example/au_pitch_200/au_helix/au_dupl_p200.data +55119 -0
  24. shanc/demo_system/Analysis_example/au_pitch_200/au_helix/coordination_metal.svg +303 -0
  25. shanc/demo_system/Analysis_example/au_pitch_200/au_helix/in_template_au.lmp +90 -0
  26. shanc/demo_system/Analysis_example/au_pitch_200/au_helix/in_template_au.out +1998 -0
  27. shanc/demo_system/Analysis_example/au_pitch_200/au_helix/last_timestep.lammpstrj +55113 -0
  28. shanc/demo_system/Analysis_example/au_pitch_200/au_helix/last_timestep.xyz +55106 -0
  29. shanc/demo_system/Analysis_example/au_pitch_200/au_helix/log.lammps +2068 -0
  30. shanc/demo_system/Analysis_example/au_pitch_200/au_helix/rdf_metal.svg +1019 -0
  31. shanc/demo_system/Analysis_example/au_pitch_200/au_twist/Au.data +19 -0
  32. shanc/demo_system/Analysis_example/au_pitch_200/au_twist/README.md +1 -0
  33. shanc/demo_system/Analysis_example/au_pitch_200/au_twist/au_twist_dupl.data +55311 -0
  34. shanc/demo_system/Analysis_example/au_pitch_200/au_twist/in_template_au_twist.lmp +114 -0
  35. shanc/demo_system/Analysis_example/au_pitch_200/au_twist/in_template_au_twist.out +2147 -0
  36. shanc/demo_system/Analysis_example/au_pitch_200/au_twist/last_timestep.lammpstrj +55305 -0
  37. shanc/demo_system/Analysis_example/au_pitch_200/au_twist/log.lammps +2232 -0
  38. shanc/demo_system/Analysis_example/mol_file/1-propanamine.sdf +96 -0
  39. shanc/demo_system/Analysis_example/mol_file/1-propanamine.xyz +15 -0
  40. shanc/demo_system/Analysis_example/mol_file/README.md +1 -0
  41. shanc/demo_system/Analysis_example/mol_file/chromophore.data +306 -0
  42. shanc/demo_system/Analysis_example/mol_file/chromophore.mol +66 -0
  43. shanc/demo_system/Analysis_example/mol_file/chromophore.sdf +46 -0
  44. shanc/demo_system/Analysis_example/mol_file/chromophore.xyz +31 -0
  45. shanc/demo_system/Analysis_example/sio2_pitch_200/README.md +1 -0
  46. shanc/demo_system/Analysis_example/sio2_pitch_200/analysis.svg +1490 -0
  47. shanc/demo_system/Analysis_example/sio2_pitch_200/beta_quartz.data +41 -0
  48. shanc/demo_system/Analysis_example/sio2_pitch_200/cycles.txt +17748 -0
  49. shanc/demo_system/Analysis_example/sio2_pitch_200/in_template.lmp +182 -0
  50. shanc/demo_system/Analysis_example/sio2_pitch_200/last_timestep.lammpstrj +50295 -0
  51. shanc/demo_system/Analysis_example/sio2_pitch_200/lims.png +0 -0
  52. shanc/demo_system/Analysis_example/sio2_pitch_200/quartz_dupl.data +50425 -0
  53. shanc/demo_system/Analysis_example/sio2_pitch_200/quartz_int.data +19504 -0
  54. shanc/demo_system/Create_a_nanohelix_of_silica.py +80 -0
  55. shanc/demo_system/Create_nanohelice_different_materials.py +101 -0
  56. shanc/demo_system/README.md +25 -0
  57. shanc/demo_system/__init__.py +0 -0
  58. shanc/demo_system/cuboid.data +69913 -0
  59. shanc/demo_system/files_lattices/Ag.data +19 -0
  60. shanc/demo_system/files_lattices/Ag.xyz +16 -0
  61. shanc/demo_system/files_lattices/Au.data +19 -0
  62. shanc/demo_system/files_lattices/Au.xyz +16 -0
  63. shanc/demo_system/files_lattices/Cu.data +19 -0
  64. shanc/demo_system/files_lattices/Cu.xyz +16 -0
  65. shanc/demo_system/files_lattices/Model_file/README.md +11 -0
  66. shanc/demo_system/files_lattices/Model_file/beta_quartz.data +41 -0
  67. shanc/demo_system/files_lattices/README.md +15 -0
  68. shanc/demo_system/files_lattices/SiO2.data +28 -0
  69. shanc/demo_system/files_lattices/SiO2.xyz +14 -0
  70. shanc/demo_system/in_template.lmp +182 -0
  71. shanc/demo_system/quartz_dupl.data +50425 -0
  72. shanc/demo_system/quartz_int.data +19504 -0
  73. shanc/distortion.py +900 -0
  74. shanc/helix.py +66 -0
  75. shanc/helix_object.py +237 -0
  76. shanc/read_write.py +1000 -0
  77. shanc-0.0.1.dist-info/METADATA +74 -0
  78. shanc-0.0.1.dist-info/RECORD +81 -0
  79. shanc-0.0.1.dist-info/WHEEL +5 -0
  80. shanc-0.0.1.dist-info/licenses/LICENSE +21 -0
  81. shanc-0.0.1.dist-info/top_level.txt +1 -0
shanc/README.md ADDED
@@ -0,0 +1,24 @@
1
+ # Construction
2
+
3
+ The `Construction` package contains the core utilities for building and analyzing nanohelix systems.
4
+
5
+ ## Modules
6
+
7
+ - `import_libraries.py` — central import file for the scientific dependencies used by the package.
8
+ - `distortion.py` — lattice duplication, helix generation, and transformation utilities.
9
+ - `read_write.py` — functions for reading and writing structure files such as XYZ and LAMMPS data.
10
+ - `analysis.py` — structural analysis routines, bond counting, validation, and radial distribution functions.
11
+ - `add_chromophore.py` — surface extraction and chromophore grafting utilities.
12
+ - `cycle_extraction.py` — ring and cycle extraction helpers with related visualization support.
13
+
14
+ ## Usage
15
+
16
+ Import the package from the repository root and call the provided functions. Example:
17
+
18
+ ```python
19
+ from Construction.distortion import create_syst
20
+ ```
21
+
22
+ ## Purpose
23
+
24
+ This package provides the reusable building blocks for creating silica nanohelix geometries, analyzing their structure, and attaching functional molecules to reactive surface sites.
shanc/__init__.py ADDED
@@ -0,0 +1,37 @@
1
+ """
2
+ Importation of the requiered libraries
3
+ """
4
+
5
+ import pyvista as pv
6
+ import matplotlib.pyplot as plt
7
+ import numpy as np
8
+ from scipy.spatial import KDTree
9
+ from matplotlib.widgets import Slider
10
+ import scipy as sp
11
+ import scipy.spatial.distance as sd
12
+ import scipy.signal as sps
13
+ import matplotlib.ticker as ticker
14
+ import re
15
+ from collections import defaultdict
16
+ import os
17
+ import time
18
+ from pathlib import Path
19
+ from collections import Counter
20
+
21
+ from shanc.helix_object import *
22
+ from shanc.analysis import *
23
+ from shanc.read_write import *
24
+ # import shanc.cycle_extraction
25
+ from shanc.add_chromophore import *
26
+
27
+ # Core numerical and geometry utilities
28
+ # - numpy: array maths and reshaping
29
+ # - scipy.spatial.KDTree: fast neighbour searches for atom pairs
30
+ # - scipy.spatial.distance: distance matrices and pairwise distances
31
+ # - scipy.signal: signal and histogram processing
32
+ # - matplotlib: plotting and interactive widgets
33
+ # - pyvista: 3D structure rendering and isosurfaces
34
+ # - re: parsing text in XYZ/LAMMPS file headers
35
+ # - defaultdict: convenient dictionary defaults for counters and maps
36
+
37
+ __version__ = "0.1.0"
Binary file