SHAnC 0.0.1__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.
- shanc-0.0.1/.github/workflows/python-publish.yml +107 -0
- shanc-0.0.1/LICENSE +21 -0
- shanc-0.0.1/PKG-INFO +74 -0
- shanc-0.0.1/README.md +34 -0
- shanc-0.0.1/SHAnC.egg-info/PKG-INFO +74 -0
- shanc-0.0.1/SHAnC.egg-info/SOURCES.txt +95 -0
- shanc-0.0.1/SHAnC.egg-info/dependency_links.txt +1 -0
- shanc-0.0.1/SHAnC.egg-info/requires.txt +4 -0
- shanc-0.0.1/SHAnC.egg-info/top_level.txt +1 -0
- shanc-0.0.1/TODO +10 -0
- shanc-0.0.1/doc/Makefile +20 -0
- shanc-0.0.1/doc/_static/css/custom.css +9 -0
- shanc-0.0.1/doc/conf.py +73 -0
- shanc-0.0.1/doc/index.rst +21 -0
- shanc-0.0.1/doc/make.bat +35 -0
- shanc-0.0.1/doc/tuto/installation.rst +2 -0
- shanc-0.0.1/doc/tutorials.rst +41 -0
- shanc-0.0.1/pyproject.toml +28 -0
- shanc-0.0.1/requirements.txt +5 -0
- shanc-0.0.1/setup.cfg +4 -0
- shanc-0.0.1/shanc/README.md +24 -0
- shanc-0.0.1/shanc/__init__.py +37 -0
- shanc-0.0.1/shanc/__pycache__/__init__.cpython-314.pyc +0 -0
- shanc-0.0.1/shanc/__pycache__/add_chromophore.cpython-314.pyc +0 -0
- shanc-0.0.1/shanc/__pycache__/analysis.cpython-314.pyc +0 -0
- shanc-0.0.1/shanc/__pycache__/cycle_extraction.cpython-314.pyc +0 -0
- shanc-0.0.1/shanc/__pycache__/distortion.cpython-314.pyc +0 -0
- shanc-0.0.1/shanc/__pycache__/helix.cpython-314.pyc +0 -0
- shanc-0.0.1/shanc/__pycache__/helix_object.cpython-314.pyc +0 -0
- shanc-0.0.1/shanc/__pycache__/import_libraries.cpython-314.pyc +0 -0
- shanc-0.0.1/shanc/__pycache__/read_write.cpython-314.pyc +0 -0
- shanc-0.0.1/shanc/add_chromophore.py +1988 -0
- shanc-0.0.1/shanc/analysis.py +1594 -0
- shanc-0.0.1/shanc/cycle_extraction.py +556 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/Add_chromophore.py +189 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/Analyze_surface.py +161 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/Extract_cycles.py +101 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/README.md +42 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/Structure_validation.py +79 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/README.md +1 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_helix/Au.data +19 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_helix/README.md +1 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_helix/au_dupl_p200.data +55119 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_helix/coordination_metal.svg +303 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_helix/in_template_au.lmp +90 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_helix/in_template_au.out +1998 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_helix/last_timestep.lammpstrj +55113 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_helix/last_timestep.xyz +55106 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_helix/log.lammps +2068 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_helix/rdf_metal.svg +1019 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_twist/Au.data +19 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_twist/README.md +1 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_twist/au_twist_dupl.data +55311 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_twist/in_template_au_twist.lmp +114 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_twist/in_template_au_twist.out +2147 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_twist/last_timestep.lammpstrj +55305 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/au_pitch_200/au_twist/log.lammps +2232 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/mol_file/1-propanamine.sdf +96 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/mol_file/1-propanamine.xyz +15 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/mol_file/README.md +1 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/mol_file/chromophore.data +306 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/mol_file/chromophore.mol +66 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/mol_file/chromophore.sdf +46 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/mol_file/chromophore.xyz +31 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/sio2_pitch_200/README.md +1 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/sio2_pitch_200/analysis.svg +1490 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/sio2_pitch_200/beta_quartz.data +41 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/sio2_pitch_200/cycles.txt +17748 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/sio2_pitch_200/in_template.lmp +182 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/sio2_pitch_200/last_timestep.lammpstrj +50295 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/sio2_pitch_200/lims.png +0 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/sio2_pitch_200/quartz_dupl.data +50425 -0
- shanc-0.0.1/shanc/demo_system/Analysis_example/sio2_pitch_200/quartz_int.data +19504 -0
- shanc-0.0.1/shanc/demo_system/Create_a_nanohelix_of_silica.py +80 -0
- shanc-0.0.1/shanc/demo_system/Create_nanohelice_different_materials.py +101 -0
- shanc-0.0.1/shanc/demo_system/README.md +25 -0
- shanc-0.0.1/shanc/demo_system/__init__.py +0 -0
- shanc-0.0.1/shanc/demo_system/cuboid.data +69913 -0
- shanc-0.0.1/shanc/demo_system/files_lattices/Ag.data +19 -0
- shanc-0.0.1/shanc/demo_system/files_lattices/Ag.xyz +16 -0
- shanc-0.0.1/shanc/demo_system/files_lattices/Au.data +19 -0
- shanc-0.0.1/shanc/demo_system/files_lattices/Au.xyz +16 -0
- shanc-0.0.1/shanc/demo_system/files_lattices/Cu.data +19 -0
- shanc-0.0.1/shanc/demo_system/files_lattices/Cu.xyz +16 -0
- shanc-0.0.1/shanc/demo_system/files_lattices/Model_file/README.md +11 -0
- shanc-0.0.1/shanc/demo_system/files_lattices/Model_file/beta_quartz.data +41 -0
- shanc-0.0.1/shanc/demo_system/files_lattices/README.md +15 -0
- shanc-0.0.1/shanc/demo_system/files_lattices/SiO2.data +28 -0
- shanc-0.0.1/shanc/demo_system/files_lattices/SiO2.xyz +14 -0
- shanc-0.0.1/shanc/demo_system/in_template.lmp +182 -0
- shanc-0.0.1/shanc/demo_system/quartz_dupl.data +50425 -0
- shanc-0.0.1/shanc/demo_system/quartz_int.data +19504 -0
- shanc-0.0.1/shanc/distortion.py +900 -0
- shanc-0.0.1/shanc/helix.py +66 -0
- shanc-0.0.1/shanc/helix_object.py +237 -0
- shanc-0.0.1/shanc/read_write.py +1000 -0
- shanc-0.0.1/test_shanc.py +40 -0
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
name: Publish Python distribution to PyPI
|
|
2
|
+
on: push
|
|
3
|
+
jobs:
|
|
4
|
+
build:
|
|
5
|
+
name: Build distribution
|
|
6
|
+
runs-on: ubuntu-latest
|
|
7
|
+
steps:
|
|
8
|
+
- uses: actions/checkout@v4
|
|
9
|
+
with:
|
|
10
|
+
persist-credentials: false
|
|
11
|
+
- name: Set up Python
|
|
12
|
+
uses: actions/setup-python@v5
|
|
13
|
+
with:
|
|
14
|
+
python-version: "3.x"
|
|
15
|
+
- name: Install pypa/build
|
|
16
|
+
run: >-
|
|
17
|
+
python3 -m
|
|
18
|
+
pip install
|
|
19
|
+
build
|
|
20
|
+
--user
|
|
21
|
+
- name: Build a binary wheel and a source tarball
|
|
22
|
+
run: python3 -m build
|
|
23
|
+
- name: Store the distribution packages
|
|
24
|
+
uses: actions/upload-artifact@v4
|
|
25
|
+
with:
|
|
26
|
+
name: python-package-distributions
|
|
27
|
+
path: dist/
|
|
28
|
+
publish-to-pypi:
|
|
29
|
+
name: >-
|
|
30
|
+
Publish Python distribution to PyPI
|
|
31
|
+
if: startsWith(github.event.ref, 'refs/tags/v') # only publish to PyPI on tag pushes
|
|
32
|
+
needs:
|
|
33
|
+
- build
|
|
34
|
+
runs-on: ubuntu-latest
|
|
35
|
+
environment:
|
|
36
|
+
name: pypi
|
|
37
|
+
url: https://pypi.org/p/rgmol # Replace <package-name> with your PyPI project name
|
|
38
|
+
permissions:
|
|
39
|
+
id-token: write # IMPORTANT: mandatory for trusted publishing
|
|
40
|
+
steps:
|
|
41
|
+
- name: Download all the dists
|
|
42
|
+
uses: actions/download-artifact@v4
|
|
43
|
+
with:
|
|
44
|
+
name: python-package-distributions
|
|
45
|
+
path: dist/
|
|
46
|
+
- name: Publish distribution to PyPI
|
|
47
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
48
|
+
github-release:
|
|
49
|
+
name: >-
|
|
50
|
+
Sign the Python distribution with Sigstore
|
|
51
|
+
and upload them to GitHub Release
|
|
52
|
+
needs:
|
|
53
|
+
- publish-to-pypi
|
|
54
|
+
runs-on: ubuntu-latest
|
|
55
|
+
permissions:
|
|
56
|
+
contents: write # IMPORTANT: mandatory for making GitHub Releases
|
|
57
|
+
id-token: write # IMPORTANT: mandatory for sigstore
|
|
58
|
+
steps:
|
|
59
|
+
- name: Download all the dists
|
|
60
|
+
uses: actions/download-artifact@v4
|
|
61
|
+
with:
|
|
62
|
+
name: python-package-distributions
|
|
63
|
+
path: dist/
|
|
64
|
+
- name: Sign the dists with Sigstore
|
|
65
|
+
uses: sigstore/gh-action-sigstore-python@v3.0.0
|
|
66
|
+
with:
|
|
67
|
+
inputs: >-
|
|
68
|
+
./dist/*.tar.gz
|
|
69
|
+
./dist/*.whl
|
|
70
|
+
- name: Create GitHub Release
|
|
71
|
+
env:
|
|
72
|
+
GITHUB_TOKEN: ${{ github.token }}
|
|
73
|
+
run: >-
|
|
74
|
+
gh release create
|
|
75
|
+
"$GITHUB_REF_NAME"
|
|
76
|
+
--repo "$GITHUB_REPOSITORY"
|
|
77
|
+
--notes ""
|
|
78
|
+
- name: Upload artifact signatures to GitHub Release
|
|
79
|
+
env:
|
|
80
|
+
GITHUB_TOKEN: ${{ github.token }}
|
|
81
|
+
# Upload to GitHub Release using the `gh` CLI.
|
|
82
|
+
# `dist/` contains the built packages, and the
|
|
83
|
+
# sigstore-produced signatures and certificates.
|
|
84
|
+
run: >-
|
|
85
|
+
gh release upload
|
|
86
|
+
"$GITHUB_REF_NAME" dist/**
|
|
87
|
+
--repo "$GITHUB_REPOSITORY"
|
|
88
|
+
publish-to-testpypi:
|
|
89
|
+
name: Publish Python distribution to TestPyPI
|
|
90
|
+
needs:
|
|
91
|
+
- build
|
|
92
|
+
runs-on: ubuntu-latest
|
|
93
|
+
environment:
|
|
94
|
+
name: testpypi
|
|
95
|
+
url: https://test.pypi.org/p/<package-name>
|
|
96
|
+
permissions:
|
|
97
|
+
id-token: write # IMPORTANT: mandatory for trusted publishing
|
|
98
|
+
steps:
|
|
99
|
+
- name: Download all the dists
|
|
100
|
+
uses: actions/download-artifact@v4
|
|
101
|
+
with:
|
|
102
|
+
name: python-package-distributions
|
|
103
|
+
path: dist/
|
|
104
|
+
- name: Publish distribution to TestPyPI
|
|
105
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
106
|
+
with:
|
|
107
|
+
repository-url: https://test.pypi.org/legacy/
|
shanc-0.0.1/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 re-gr
|
|
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.
|
shanc-0.0.1/PKG-INFO
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: SHAnC
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: SHAnC (Silica Helices Analysis & Construction) is a collection of scripts used to Construct and Analyze Silica Helices.
|
|
5
|
+
Author-email: Rémi Grincourt <remi.grincourt@ens-lyon.fr>, Maewenn Temey <maewenn.temey@ens-lyon.fr>
|
|
6
|
+
License: MIT License
|
|
7
|
+
|
|
8
|
+
Copyright (c) 2026 re-gr
|
|
9
|
+
|
|
10
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
11
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
12
|
+
in the Software without restriction, including without limitation the rights
|
|
13
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
14
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
15
|
+
furnished to do so, subject to the following conditions:
|
|
16
|
+
|
|
17
|
+
The above copyright notice and this permission notice shall be included in all
|
|
18
|
+
copies or substantial portions of the Software.
|
|
19
|
+
|
|
20
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
21
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
22
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
23
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
24
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
25
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
26
|
+
SOFTWARE.
|
|
27
|
+
|
|
28
|
+
Project-URL: Repository, https://github.com/re-gr/shanc
|
|
29
|
+
Keywords: nanohelices,chemistry,materials,helices,construction
|
|
30
|
+
Classifier: Development Status :: 4 - Beta
|
|
31
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
32
|
+
Requires-Python: >=3.9
|
|
33
|
+
Description-Content-Type: text/markdown
|
|
34
|
+
License-File: LICENSE
|
|
35
|
+
Requires-Dist: numpy
|
|
36
|
+
Requires-Dist: scipy
|
|
37
|
+
Requires-Dist: pyvista
|
|
38
|
+
Requires-Dist: matplotlib
|
|
39
|
+
Dynamic: license-file
|
|
40
|
+
|
|
41
|
+
<h1 align="center">
|
|
42
|
+
SHAnC
|
|
43
|
+
</h1>
|
|
44
|
+
|
|
45
|
+
SHAnC (Silica Helices Analysis & Construction) is a collection of scripts used to Construct and Analyze Silica Helices.
|
|
46
|
+
|
|
47
|
+
- **Github :** https://github.com/re-gr/SHAnC
|
|
48
|
+
|
|
49
|
+
## Getting Started
|
|
50
|
+
|
|
51
|
+
- Construction : the scripts that are used to create an helix or a twisted ribbon
|
|
52
|
+
- distorsion.py : create helices and ribbons
|
|
53
|
+
- read\_write.py : read and write files
|
|
54
|
+
- script\_analysis.py : analysis (rdf, saturation ...) of structures
|
|
55
|
+
- script\_cycles.py : cycle analysis of structures (WIP)
|
|
56
|
+
|
|
57
|
+
- Torsion : the scripts are used to twist the cuboids to the proper shape. This method should not be used, but is kept here just in case.
|
|
58
|
+
- distorsion.py : old version of the script in construction that should be compatible with the other script
|
|
59
|
+
- script\_launch.py : script to create the systems and input file for the simulations
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
## Depedencies
|
|
63
|
+
|
|
64
|
+
numpy
|
|
65
|
+
scipy
|
|
66
|
+
matplotlib
|
|
67
|
+
pyvista
|
|
68
|
+
lammps (optional, for torsion only)
|
|
69
|
+
|
|
70
|
+
## Contact
|
|
71
|
+
|
|
72
|
+
Email : [Rg](mailto:remi.grincourt@ens-lyon.fr)
|
|
73
|
+
[mate-pr](mailto:maewenn.temey@ens-lyon.fr)
|
|
74
|
+
|
shanc-0.0.1/README.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
<h1 align="center">
|
|
2
|
+
SHAnC
|
|
3
|
+
</h1>
|
|
4
|
+
|
|
5
|
+
SHAnC (Silica Helices Analysis & Construction) is a collection of scripts used to Construct and Analyze Silica Helices.
|
|
6
|
+
|
|
7
|
+
- **Github :** https://github.com/re-gr/SHAnC
|
|
8
|
+
|
|
9
|
+
## Getting Started
|
|
10
|
+
|
|
11
|
+
- Construction : the scripts that are used to create an helix or a twisted ribbon
|
|
12
|
+
- distorsion.py : create helices and ribbons
|
|
13
|
+
- read\_write.py : read and write files
|
|
14
|
+
- script\_analysis.py : analysis (rdf, saturation ...) of structures
|
|
15
|
+
- script\_cycles.py : cycle analysis of structures (WIP)
|
|
16
|
+
|
|
17
|
+
- Torsion : the scripts are used to twist the cuboids to the proper shape. This method should not be used, but is kept here just in case.
|
|
18
|
+
- distorsion.py : old version of the script in construction that should be compatible with the other script
|
|
19
|
+
- script\_launch.py : script to create the systems and input file for the simulations
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
## Depedencies
|
|
23
|
+
|
|
24
|
+
numpy
|
|
25
|
+
scipy
|
|
26
|
+
matplotlib
|
|
27
|
+
pyvista
|
|
28
|
+
lammps (optional, for torsion only)
|
|
29
|
+
|
|
30
|
+
## Contact
|
|
31
|
+
|
|
32
|
+
Email : [Rg](mailto:remi.grincourt@ens-lyon.fr)
|
|
33
|
+
[mate-pr](mailto:maewenn.temey@ens-lyon.fr)
|
|
34
|
+
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: SHAnC
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: SHAnC (Silica Helices Analysis & Construction) is a collection of scripts used to Construct and Analyze Silica Helices.
|
|
5
|
+
Author-email: Rémi Grincourt <remi.grincourt@ens-lyon.fr>, Maewenn Temey <maewenn.temey@ens-lyon.fr>
|
|
6
|
+
License: MIT License
|
|
7
|
+
|
|
8
|
+
Copyright (c) 2026 re-gr
|
|
9
|
+
|
|
10
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
11
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
12
|
+
in the Software without restriction, including without limitation the rights
|
|
13
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
14
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
15
|
+
furnished to do so, subject to the following conditions:
|
|
16
|
+
|
|
17
|
+
The above copyright notice and this permission notice shall be included in all
|
|
18
|
+
copies or substantial portions of the Software.
|
|
19
|
+
|
|
20
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
21
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
22
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
23
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
24
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
25
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
26
|
+
SOFTWARE.
|
|
27
|
+
|
|
28
|
+
Project-URL: Repository, https://github.com/re-gr/shanc
|
|
29
|
+
Keywords: nanohelices,chemistry,materials,helices,construction
|
|
30
|
+
Classifier: Development Status :: 4 - Beta
|
|
31
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
32
|
+
Requires-Python: >=3.9
|
|
33
|
+
Description-Content-Type: text/markdown
|
|
34
|
+
License-File: LICENSE
|
|
35
|
+
Requires-Dist: numpy
|
|
36
|
+
Requires-Dist: scipy
|
|
37
|
+
Requires-Dist: pyvista
|
|
38
|
+
Requires-Dist: matplotlib
|
|
39
|
+
Dynamic: license-file
|
|
40
|
+
|
|
41
|
+
<h1 align="center">
|
|
42
|
+
SHAnC
|
|
43
|
+
</h1>
|
|
44
|
+
|
|
45
|
+
SHAnC (Silica Helices Analysis & Construction) is a collection of scripts used to Construct and Analyze Silica Helices.
|
|
46
|
+
|
|
47
|
+
- **Github :** https://github.com/re-gr/SHAnC
|
|
48
|
+
|
|
49
|
+
## Getting Started
|
|
50
|
+
|
|
51
|
+
- Construction : the scripts that are used to create an helix or a twisted ribbon
|
|
52
|
+
- distorsion.py : create helices and ribbons
|
|
53
|
+
- read\_write.py : read and write files
|
|
54
|
+
- script\_analysis.py : analysis (rdf, saturation ...) of structures
|
|
55
|
+
- script\_cycles.py : cycle analysis of structures (WIP)
|
|
56
|
+
|
|
57
|
+
- Torsion : the scripts are used to twist the cuboids to the proper shape. This method should not be used, but is kept here just in case.
|
|
58
|
+
- distorsion.py : old version of the script in construction that should be compatible with the other script
|
|
59
|
+
- script\_launch.py : script to create the systems and input file for the simulations
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
## Depedencies
|
|
63
|
+
|
|
64
|
+
numpy
|
|
65
|
+
scipy
|
|
66
|
+
matplotlib
|
|
67
|
+
pyvista
|
|
68
|
+
lammps (optional, for torsion only)
|
|
69
|
+
|
|
70
|
+
## Contact
|
|
71
|
+
|
|
72
|
+
Email : [Rg](mailto:remi.grincourt@ens-lyon.fr)
|
|
73
|
+
[mate-pr](mailto:maewenn.temey@ens-lyon.fr)
|
|
74
|
+
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
LICENSE
|
|
2
|
+
README.md
|
|
3
|
+
TODO
|
|
4
|
+
pyproject.toml
|
|
5
|
+
requirements.txt
|
|
6
|
+
test_shanc.py
|
|
7
|
+
.github/workflows/python-publish.yml
|
|
8
|
+
SHAnC.egg-info/PKG-INFO
|
|
9
|
+
SHAnC.egg-info/SOURCES.txt
|
|
10
|
+
SHAnC.egg-info/dependency_links.txt
|
|
11
|
+
SHAnC.egg-info/requires.txt
|
|
12
|
+
SHAnC.egg-info/top_level.txt
|
|
13
|
+
doc/Makefile
|
|
14
|
+
doc/conf.py
|
|
15
|
+
doc/index.rst
|
|
16
|
+
doc/make.bat
|
|
17
|
+
doc/tutorials.rst
|
|
18
|
+
doc/_static/css/custom.css
|
|
19
|
+
doc/tuto/installation.rst
|
|
20
|
+
shanc/README.md
|
|
21
|
+
shanc/__init__.py
|
|
22
|
+
shanc/add_chromophore.py
|
|
23
|
+
shanc/analysis.py
|
|
24
|
+
shanc/cycle_extraction.py
|
|
25
|
+
shanc/distortion.py
|
|
26
|
+
shanc/helix.py
|
|
27
|
+
shanc/helix_object.py
|
|
28
|
+
shanc/read_write.py
|
|
29
|
+
shanc/__pycache__/__init__.cpython-314.pyc
|
|
30
|
+
shanc/__pycache__/add_chromophore.cpython-314.pyc
|
|
31
|
+
shanc/__pycache__/analysis.cpython-314.pyc
|
|
32
|
+
shanc/__pycache__/cycle_extraction.cpython-314.pyc
|
|
33
|
+
shanc/__pycache__/distortion.cpython-314.pyc
|
|
34
|
+
shanc/__pycache__/helix.cpython-314.pyc
|
|
35
|
+
shanc/__pycache__/helix_object.cpython-314.pyc
|
|
36
|
+
shanc/__pycache__/import_libraries.cpython-314.pyc
|
|
37
|
+
shanc/__pycache__/read_write.cpython-314.pyc
|
|
38
|
+
shanc/demo_system/Create_a_nanohelix_of_silica.py
|
|
39
|
+
shanc/demo_system/Create_nanohelice_different_materials.py
|
|
40
|
+
shanc/demo_system/README.md
|
|
41
|
+
shanc/demo_system/__init__.py
|
|
42
|
+
shanc/demo_system/cuboid.data
|
|
43
|
+
shanc/demo_system/in_template.lmp
|
|
44
|
+
shanc/demo_system/quartz_dupl.data
|
|
45
|
+
shanc/demo_system/quartz_int.data
|
|
46
|
+
shanc/demo_system/Analysis_example/Add_chromophore.py
|
|
47
|
+
shanc/demo_system/Analysis_example/Analyze_surface.py
|
|
48
|
+
shanc/demo_system/Analysis_example/Extract_cycles.py
|
|
49
|
+
shanc/demo_system/Analysis_example/README.md
|
|
50
|
+
shanc/demo_system/Analysis_example/Structure_validation.py
|
|
51
|
+
shanc/demo_system/Analysis_example/au_pitch_200/README.md
|
|
52
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_helix/Au.data
|
|
53
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_helix/README.md
|
|
54
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_helix/au_dupl_p200.data
|
|
55
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_helix/coordination_metal.svg
|
|
56
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_helix/in_template_au.lmp
|
|
57
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_helix/in_template_au.out
|
|
58
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_helix/last_timestep.lammpstrj
|
|
59
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_helix/last_timestep.xyz
|
|
60
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_helix/log.lammps
|
|
61
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_helix/rdf_metal.svg
|
|
62
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_twist/Au.data
|
|
63
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_twist/README.md
|
|
64
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_twist/au_twist_dupl.data
|
|
65
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_twist/in_template_au_twist.lmp
|
|
66
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_twist/in_template_au_twist.out
|
|
67
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_twist/last_timestep.lammpstrj
|
|
68
|
+
shanc/demo_system/Analysis_example/au_pitch_200/au_twist/log.lammps
|
|
69
|
+
shanc/demo_system/Analysis_example/mol_file/1-propanamine.sdf
|
|
70
|
+
shanc/demo_system/Analysis_example/mol_file/1-propanamine.xyz
|
|
71
|
+
shanc/demo_system/Analysis_example/mol_file/README.md
|
|
72
|
+
shanc/demo_system/Analysis_example/mol_file/chromophore.data
|
|
73
|
+
shanc/demo_system/Analysis_example/mol_file/chromophore.mol
|
|
74
|
+
shanc/demo_system/Analysis_example/mol_file/chromophore.sdf
|
|
75
|
+
shanc/demo_system/Analysis_example/mol_file/chromophore.xyz
|
|
76
|
+
shanc/demo_system/Analysis_example/sio2_pitch_200/README.md
|
|
77
|
+
shanc/demo_system/Analysis_example/sio2_pitch_200/analysis.svg
|
|
78
|
+
shanc/demo_system/Analysis_example/sio2_pitch_200/beta_quartz.data
|
|
79
|
+
shanc/demo_system/Analysis_example/sio2_pitch_200/cycles.txt
|
|
80
|
+
shanc/demo_system/Analysis_example/sio2_pitch_200/in_template.lmp
|
|
81
|
+
shanc/demo_system/Analysis_example/sio2_pitch_200/last_timestep.lammpstrj
|
|
82
|
+
shanc/demo_system/Analysis_example/sio2_pitch_200/lims.png
|
|
83
|
+
shanc/demo_system/Analysis_example/sio2_pitch_200/quartz_dupl.data
|
|
84
|
+
shanc/demo_system/Analysis_example/sio2_pitch_200/quartz_int.data
|
|
85
|
+
shanc/demo_system/files_lattices/Ag.data
|
|
86
|
+
shanc/demo_system/files_lattices/Ag.xyz
|
|
87
|
+
shanc/demo_system/files_lattices/Au.data
|
|
88
|
+
shanc/demo_system/files_lattices/Au.xyz
|
|
89
|
+
shanc/demo_system/files_lattices/Cu.data
|
|
90
|
+
shanc/demo_system/files_lattices/Cu.xyz
|
|
91
|
+
shanc/demo_system/files_lattices/README.md
|
|
92
|
+
shanc/demo_system/files_lattices/SiO2.data
|
|
93
|
+
shanc/demo_system/files_lattices/SiO2.xyz
|
|
94
|
+
shanc/demo_system/files_lattices/Model_file/README.md
|
|
95
|
+
shanc/demo_system/files_lattices/Model_file/beta_quartz.data
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
shanc
|
shanc-0.0.1/TODO
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
Change Readme file
|
|
2
|
+
Add more except cases a bit everywhere
|
|
3
|
+
Read_data for more atom style / more flexible
|
|
4
|
+
Add radius / colors support for all functions
|
|
5
|
+
Clean structure be more general, add more flexibility for the type, it should not be only 3 and 4
|
|
6
|
+
Redo the analyze_mult function in the plotting
|
|
7
|
+
Wiki
|
|
8
|
+
Add tests
|
|
9
|
+
Update demo_system
|
|
10
|
+
|
shanc-0.0.1/doc/Makefile
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Minimal makefile for Sphinx documentation
|
|
2
|
+
#
|
|
3
|
+
|
|
4
|
+
# You can set these variables from the command line, and also
|
|
5
|
+
# from the environment for the first two.
|
|
6
|
+
SPHINXOPTS ?=
|
|
7
|
+
SPHINXBUILD ?= sphinx-build
|
|
8
|
+
SOURCEDIR = .
|
|
9
|
+
BUILDDIR = _build
|
|
10
|
+
|
|
11
|
+
# Put it first so that "make" without argument is like "make help".
|
|
12
|
+
help:
|
|
13
|
+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
14
|
+
|
|
15
|
+
.PHONY: help Makefile
|
|
16
|
+
|
|
17
|
+
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
18
|
+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
19
|
+
%: Makefile
|
|
20
|
+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
shanc-0.0.1/doc/conf.py
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Configuration file for the Sphinx documentation builder.
|
|
2
|
+
#
|
|
3
|
+
# For the full list of built-in configuration values, see the documentation:
|
|
4
|
+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
5
|
+
|
|
6
|
+
# -- Project information -----------------------------------------------------
|
|
7
|
+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
8
|
+
|
|
9
|
+
import os
|
|
10
|
+
import sys
|
|
11
|
+
|
|
12
|
+
sys.path.insert(0,os.path.abspath(os.path.join("..")))
|
|
13
|
+
sys.setrecursionlimit(1500)
|
|
14
|
+
|
|
15
|
+
import pyvista
|
|
16
|
+
from pyvista.plotting.utilities.sphinx_gallery import DynamicScraper
|
|
17
|
+
pyvista.BUILDING_GALLERY = True
|
|
18
|
+
pyvista.set_plot_theme("document")
|
|
19
|
+
pyvista.set_error_output_file("errors.txt")
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
os.environ["PYVISTA_BUILDING_GALLERY"] = "true"
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
project = 'SHAnC'
|
|
26
|
+
copyright = '2026, re-gr, mate-pr'
|
|
27
|
+
author = 're-gr, mate-pr'
|
|
28
|
+
release = '0.1'
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
# -- General configuration ---------------------------------------------------
|
|
32
|
+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
extensions = [
|
|
37
|
+
"sphinx.ext.autodoc",
|
|
38
|
+
"sphinx.ext.napoleon",
|
|
39
|
+
"sphinx_copybutton",
|
|
40
|
+
"sphinx.ext.mathjax",
|
|
41
|
+
"pyvista.ext.plot_directive",
|
|
42
|
+
"pyvista.ext.viewer_directive",
|
|
43
|
+
"sphinx_design",
|
|
44
|
+
"sphinxcontrib.asciinema",
|
|
45
|
+
]
|
|
46
|
+
napoleon_custom_sections = [('Returns', 'params_style'), ("Attributes","params_style")]
|
|
47
|
+
|
|
48
|
+
templates_path = ['_templates']
|
|
49
|
+
exclude_patterns = []
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
html_theme = 'pydata_sphinx_theme'
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
napoleon_google_docstring = False
|
|
57
|
+
napoleon_use_param = True
|
|
58
|
+
napoleon_use_ivar = True
|
|
59
|
+
html_show_sourcelink = False
|
|
60
|
+
html_show_copyright = False
|
|
61
|
+
html_theme_options = {
|
|
62
|
+
# ...
|
|
63
|
+
"secondary_sidebar_items": ["edit-this-page", "sourcelink"],
|
|
64
|
+
# ...
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
html_static_path = ['_static']
|
|
70
|
+
|
|
71
|
+
html_css_files = [
|
|
72
|
+
'css/custom.css',
|
|
73
|
+
]
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
.. SHAnC documentation master file, created by
|
|
2
|
+
sphinx-quickstart on Wed Oct 14 16:19:22 2026.
|
|
3
|
+
You can adapt this file completely to your liking, but it should at least
|
|
4
|
+
contain the root `toctree` directive.
|
|
5
|
+
|
|
6
|
+
Welcome to SHAnC documentation
|
|
7
|
+
===============================
|
|
8
|
+
|
|
9
|
+
SHAnC (Silica Helices Analysis & Construction) is a collection of scripts used to Construct and Analyze Silica Helices.
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
.. toctree::
|
|
14
|
+
:maxdepth: 4
|
|
15
|
+
:caption: Tutorials:
|
|
16
|
+
|
|
17
|
+
tutorials
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
shanc-0.0.1/doc/make.bat
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
@ECHO OFF
|
|
2
|
+
|
|
3
|
+
pushd %~dp0
|
|
4
|
+
|
|
5
|
+
REM Command file for Sphinx documentation
|
|
6
|
+
|
|
7
|
+
if "%SPHINXBUILD%" == "" (
|
|
8
|
+
set SPHINXBUILD=sphinx-build
|
|
9
|
+
)
|
|
10
|
+
set SOURCEDIR=.
|
|
11
|
+
set BUILDDIR=_build
|
|
12
|
+
|
|
13
|
+
%SPHINXBUILD% >NUL 2>NUL
|
|
14
|
+
if errorlevel 9009 (
|
|
15
|
+
echo.
|
|
16
|
+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
|
17
|
+
echo.installed, then set the SPHINXBUILD environment variable to point
|
|
18
|
+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
|
19
|
+
echo.may add the Sphinx directory to PATH.
|
|
20
|
+
echo.
|
|
21
|
+
echo.If you don't have Sphinx installed, grab it from
|
|
22
|
+
echo.https://www.sphinx-doc.org/
|
|
23
|
+
exit /b 1
|
|
24
|
+
)
|
|
25
|
+
|
|
26
|
+
if "%1" == "" goto help
|
|
27
|
+
|
|
28
|
+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
29
|
+
goto end
|
|
30
|
+
|
|
31
|
+
:help
|
|
32
|
+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
33
|
+
|
|
34
|
+
:end
|
|
35
|
+
popd
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
Tutorials
|
|
2
|
+
=========
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
Getting Started
|
|
6
|
+
---------------
|
|
7
|
+
|
|
8
|
+
* :doc:`Installation<tuto/installation>`
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
.. toctree::
|
|
12
|
+
:hidden:
|
|
13
|
+
|
|
14
|
+
tuto/installation
|
|
15
|
+
|
|
16
|
+
.. pyvista-plot::
|
|
17
|
+
|
|
18
|
+
import pyvista as pv
|
|
19
|
+
mesh = pv.Sphere()
|
|
20
|
+
mesh.plot()
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
.. pyvista-plot::
|
|
24
|
+
|
|
25
|
+
import shanc
|
|
26
|
+
import numpy as np
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
target_folder = '/home/rg/SHAnC_2/SHAnC/demo_system/Analysis_example/sio2_pitch_200'
|
|
30
|
+
|
|
31
|
+
file = target_folder + "/last_timestep.lammpstrj"
|
|
32
|
+
list_TSTEP, list_NUM_AT, list_BOX, list_ATOMS = c.read_write.read_dump(file,unscale=True)
|
|
33
|
+
|
|
34
|
+
# Analyze data file
|
|
35
|
+
Pos = list_ATOMS[-1][:,2:]
|
|
36
|
+
Types = list_ATOMS[-1][:,1]
|
|
37
|
+
Lims = list_BOX[-1]
|
|
38
|
+
|
|
39
|
+
# Plots and visualisation of the structure
|
|
40
|
+
shanc.analysis.plot_analyze_defects(Pos,Types,periodic=True,Lims=Lims)
|
|
41
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "SHAnC"
|
|
3
|
+
version = "0.0.1"
|
|
4
|
+
authors = [
|
|
5
|
+
{name = "Rémi Grincourt", email = "remi.grincourt@ens-lyon.fr"},
|
|
6
|
+
{name = "Maewenn Temey", email = "maewenn.temey@ens-lyon.fr"},
|
|
7
|
+
]
|
|
8
|
+
description = "SHAnC (Silica Helices Analysis & Construction) is a collection of scripts used to Construct and Analyze Silica Helices."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.9"
|
|
11
|
+
license = {file = "LICENSE"}
|
|
12
|
+
keywords = ["nanohelices","chemistry","materials","helices","construction"]
|
|
13
|
+
classifiers = [
|
|
14
|
+
"Development Status :: 4 - Beta",
|
|
15
|
+
"Programming Language :: Python :: 3.12",
|
|
16
|
+
]
|
|
17
|
+
dependencies = [
|
|
18
|
+
"numpy",
|
|
19
|
+
"scipy",
|
|
20
|
+
"pyvista",
|
|
21
|
+
"matplotlib"
|
|
22
|
+
]
|
|
23
|
+
[project.urls]
|
|
24
|
+
Repository = "https://github.com/re-gr/shanc"
|
|
25
|
+
|
|
26
|
+
[build-system]
|
|
27
|
+
requires = ["setuptools","setuptools-scm"]
|
|
28
|
+
build-backend = "setuptools.build_meta"
|