SCRYiNG-2D 1.1.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.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Andrew L. Hitt
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,57 @@
1
+ Metadata-Version: 2.4
2
+ Name: SCRYiNG_2D
3
+ Version: 1.1.1
4
+ Summary: A lightweight package for 2D crystal growth simulation
5
+ Author-email: "Andrew L. Hitt" <andrew@andrew.us>
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/andrewlhitt/scrying
8
+ Project-URL: Documentation, https://scrying.readthedocs.io/
9
+ Project-URL: Issues, https://github.com/andrewlhitt/scrying/issues
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Operating System :: OS Independent
12
+ Requires-Python: >=3.9
13
+ Description-Content-Type: text/markdown
14
+ License-File: LICENSE
15
+ Requires-Dist: numpy>=1.20.1
16
+ Requires-Dist: scikit-image>=0.19.2
17
+ Provides-Extra: gui
18
+ Requires-Dist: ttkwidgets>=0.13.0; extra == "gui"
19
+ Requires-Dist: matplotlib>=3.5.0; extra == "gui"
20
+ Requires-Dist: tifffile>=2022.3.16; extra == "gui"
21
+ Requires-Dist: array2gif>=1.0.4; extra == "gui"
22
+ Dynamic: license-file
23
+
24
+ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13621902.svg)](https://doi.org/10.5281/zenodo.13621902)
25
+
26
+ `SCRYiNG` (Simulated CRYstal Nucleation and Growth) package is a lightweight Python platform for simulating 2D polycrystalline growth.
27
+
28
+ ## Installation
29
+ SCRYiNG can be installed via:
30
+
31
+ ```bash
32
+ pip install scrying_2d
33
+ ```
34
+
35
+ ## Getting Started
36
+ A variety of simple examples are provided in [this notebook](/examples/example.ipynb).
37
+
38
+ A graphical user interface with most of the core features is also available.
39
+ ```bash
40
+ pip install scrying_2d[gui]
41
+
42
+ scryUI
43
+ ```
44
+
45
+ ## Links
46
+ * Homepage = "https://github.com/andrewlhitt/scrying"
47
+ * Documentation = "https://scrying.readthedocs.io/"
48
+ * Issues = "https://github.com/andrewlhitt/scrying/issues"
49
+
50
+ ## Motivation
51
+ The substantial effects of the growth process on the performance of 2D materials are often complex and difficult to quantify experimentally. While simulation and modeling have proven to be effective techniques, most of the popular methods (e.g. kinetic Monte Carlo, molecular dynamics) are computationally intensive, especially when scaled up from their native atomic scale to the increasingly important microstructural scale.
52
+
53
+ `SCRYiNG` offers a computationally-light alternative to existing materials science simulation technologies through a simple, geometrically derived modeling mechanism. `SCRYiNG`'s high throughput allows it to support research into materials synthesis in a variety of ways, including parametric case studies, predictive machine learning models, real-time digitial twin strategies, and new analytical techniques.
54
+
55
+ `SCRYiNG` is designed to be an accessible option for materials science researchers, even those without substantial coding or simulation backgrounds. The scripting version offers a simple object-oriented framework, and a graphical user interface version with many of the core features facilitates use for those with no programming experience.
56
+
57
+
@@ -0,0 +1,34 @@
1
+ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13621902.svg)](https://doi.org/10.5281/zenodo.13621902)
2
+
3
+ `SCRYiNG` (Simulated CRYstal Nucleation and Growth) package is a lightweight Python platform for simulating 2D polycrystalline growth.
4
+
5
+ ## Installation
6
+ SCRYiNG can be installed via:
7
+
8
+ ```bash
9
+ pip install scrying_2d
10
+ ```
11
+
12
+ ## Getting Started
13
+ A variety of simple examples are provided in [this notebook](/examples/example.ipynb).
14
+
15
+ A graphical user interface with most of the core features is also available.
16
+ ```bash
17
+ pip install scrying_2d[gui]
18
+
19
+ scryUI
20
+ ```
21
+
22
+ ## Links
23
+ * Homepage = "https://github.com/andrewlhitt/scrying"
24
+ * Documentation = "https://scrying.readthedocs.io/"
25
+ * Issues = "https://github.com/andrewlhitt/scrying/issues"
26
+
27
+ ## Motivation
28
+ The substantial effects of the growth process on the performance of 2D materials are often complex and difficult to quantify experimentally. While simulation and modeling have proven to be effective techniques, most of the popular methods (e.g. kinetic Monte Carlo, molecular dynamics) are computationally intensive, especially when scaled up from their native atomic scale to the increasingly important microstructural scale.
29
+
30
+ `SCRYiNG` offers a computationally-light alternative to existing materials science simulation technologies through a simple, geometrically derived modeling mechanism. `SCRYiNG`'s high throughput allows it to support research into materials synthesis in a variety of ways, including parametric case studies, predictive machine learning models, real-time digitial twin strategies, and new analytical techniques.
31
+
32
+ `SCRYiNG` is designed to be an accessible option for materials science researchers, even those without substantial coding or simulation backgrounds. The scripting version offers a simple object-oriented framework, and a graphical user interface version with many of the core features facilitates use for those with no programming experience.
33
+
34
+
@@ -0,0 +1,40 @@
1
+ [build-system]
2
+ requires = ["setuptools >= 77.0.3"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "SCRYiNG_2D"
7
+ version = "1.1.1"
8
+ authors = [
9
+ { name="Andrew L. Hitt", email="andrew@andrew.us" },
10
+ ]
11
+ description = "A lightweight package for 2D crystal growth simulation"
12
+ readme = "README.md"
13
+ requires-python = ">=3.9"
14
+ classifiers = [
15
+ "Programming Language :: Python :: 3",
16
+ "Operating System :: OS Independent",
17
+ ]
18
+ license = "MIT"
19
+ license-files = ["LICEN[CS]E*"]
20
+
21
+ dependencies = [
22
+ "numpy >= 1.20.1",
23
+ "scikit-image >=0.19.2",
24
+ ]
25
+
26
+ [project.optional-dependencies]
27
+ gui = [
28
+ "ttkwidgets >= 0.13.0",
29
+ "matplotlib >= 3.5.0",
30
+ "tifffile >= 2022.3.16",
31
+ "array2gif >= 1.0.4",
32
+ ]
33
+
34
+ [project.scripts]
35
+ scryUI = "scrying_2d.ui:main"
36
+
37
+ [project.urls]
38
+ Homepage = "https://github.com/andrewlhitt/scrying"
39
+ Documentation = "https://scrying.readthedocs.io/"
40
+ Issues = "https://github.com/andrewlhitt/scrying/issues"
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,57 @@
1
+ Metadata-Version: 2.4
2
+ Name: SCRYiNG_2D
3
+ Version: 1.1.1
4
+ Summary: A lightweight package for 2D crystal growth simulation
5
+ Author-email: "Andrew L. Hitt" <andrew@andrew.us>
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/andrewlhitt/scrying
8
+ Project-URL: Documentation, https://scrying.readthedocs.io/
9
+ Project-URL: Issues, https://github.com/andrewlhitt/scrying/issues
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Operating System :: OS Independent
12
+ Requires-Python: >=3.9
13
+ Description-Content-Type: text/markdown
14
+ License-File: LICENSE
15
+ Requires-Dist: numpy>=1.20.1
16
+ Requires-Dist: scikit-image>=0.19.2
17
+ Provides-Extra: gui
18
+ Requires-Dist: ttkwidgets>=0.13.0; extra == "gui"
19
+ Requires-Dist: matplotlib>=3.5.0; extra == "gui"
20
+ Requires-Dist: tifffile>=2022.3.16; extra == "gui"
21
+ Requires-Dist: array2gif>=1.0.4; extra == "gui"
22
+ Dynamic: license-file
23
+
24
+ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13621902.svg)](https://doi.org/10.5281/zenodo.13621902)
25
+
26
+ `SCRYiNG` (Simulated CRYstal Nucleation and Growth) package is a lightweight Python platform for simulating 2D polycrystalline growth.
27
+
28
+ ## Installation
29
+ SCRYiNG can be installed via:
30
+
31
+ ```bash
32
+ pip install scrying_2d
33
+ ```
34
+
35
+ ## Getting Started
36
+ A variety of simple examples are provided in [this notebook](/examples/example.ipynb).
37
+
38
+ A graphical user interface with most of the core features is also available.
39
+ ```bash
40
+ pip install scrying_2d[gui]
41
+
42
+ scryUI
43
+ ```
44
+
45
+ ## Links
46
+ * Homepage = "https://github.com/andrewlhitt/scrying"
47
+ * Documentation = "https://scrying.readthedocs.io/"
48
+ * Issues = "https://github.com/andrewlhitt/scrying/issues"
49
+
50
+ ## Motivation
51
+ The substantial effects of the growth process on the performance of 2D materials are often complex and difficult to quantify experimentally. While simulation and modeling have proven to be effective techniques, most of the popular methods (e.g. kinetic Monte Carlo, molecular dynamics) are computationally intensive, especially when scaled up from their native atomic scale to the increasingly important microstructural scale.
52
+
53
+ `SCRYiNG` offers a computationally-light alternative to existing materials science simulation technologies through a simple, geometrically derived modeling mechanism. `SCRYiNG`'s high throughput allows it to support research into materials synthesis in a variety of ways, including parametric case studies, predictive machine learning models, real-time digitial twin strategies, and new analytical techniques.
54
+
55
+ `SCRYiNG` is designed to be an accessible option for materials science researchers, even those without substantial coding or simulation backgrounds. The scripting version offers a simple object-oriented framework, and a graphical user interface version with many of the core features facilitates use for those with no programming experience.
56
+
57
+
@@ -0,0 +1,12 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ src/SCRYiNG_2D.egg-info/PKG-INFO
5
+ src/SCRYiNG_2D.egg-info/SOURCES.txt
6
+ src/SCRYiNG_2D.egg-info/dependency_links.txt
7
+ src/SCRYiNG_2D.egg-info/entry_points.txt
8
+ src/SCRYiNG_2D.egg-info/requires.txt
9
+ src/SCRYiNG_2D.egg-info/top_level.txt
10
+ src/scrying_2d/__init__.py
11
+ src/scrying_2d/core.py
12
+ src/scrying_2d/ui.py
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ scryUI = scrying_2d.ui:main
@@ -0,0 +1,8 @@
1
+ numpy>=1.20.1
2
+ scikit-image>=0.19.2
3
+
4
+ [gui]
5
+ ttkwidgets>=0.13.0
6
+ matplotlib>=3.5.0
7
+ tifffile>=2022.3.16
8
+ array2gif>=1.0.4
@@ -0,0 +1 @@
1
+ scrying_2d
File without changes