PyGamLab 1.0.0__tar.gz → 1.2.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 (41) hide show
  1. {pygamlab-1.0.0 → pygamlab-1.2.0}/PKG-INFO +93 -21
  2. {pygamlab-1.0.0 → pygamlab-1.2.0}/PyGamLab/Constants.py +608 -1
  3. pygamlab-1.0.0/PyGamLab/Convertors.py → pygamlab-1.2.0/PyGamLab/Converters.py +431 -32
  4. pygamlab-1.2.0/PyGamLab/Data_Analysis.py +6424 -0
  5. {pygamlab-1.0.0 → pygamlab-1.2.0}/PyGamLab/Functions.py +45 -97
  6. {pygamlab-1.0.0 → pygamlab-1.2.0}/PyGamLab/__init__.py +1 -1
  7. pygamlab-1.2.0/PyGamLab/structures/GAM_architectures/GAM_Graphene.py +462 -0
  8. pygamlab-1.2.0/PyGamLab/structures/GAM_architectures/GAM_nano_particles.py +837 -0
  9. pygamlab-1.2.0/PyGamLab/structures/GAM_architectures/GAM_nanotubes.py +895 -0
  10. pygamlab-1.2.0/PyGamLab/structures/GAM_architectures/GAM_phosphorene.py +450 -0
  11. pygamlab-1.2.0/PyGamLab/structures/GAM_architectures/GAM_sillicene.py +434 -0
  12. pygamlab-1.2.0/PyGamLab/structures/GAM_architectures/__init__.py +16 -0
  13. pygamlab-1.2.0/PyGamLab/structures/Generators/__init__.py +16 -0
  14. pygamlab-1.2.0/PyGamLab/structures/Generators/auto_bulk.py +470 -0
  15. pygamlab-1.2.0/PyGamLab/structures/Generators/one_d.py +1262 -0
  16. pygamlab-1.2.0/PyGamLab/structures/Generators/two_d.py +1254 -0
  17. pygamlab-1.2.0/PyGamLab/structures/Generators/zero_d.py +606 -0
  18. pygamlab-1.2.0/PyGamLab/structures/Primatom/__init__.py +10 -0
  19. pygamlab-1.2.0/PyGamLab/structures/Primatom/gam_atom.py +756 -0
  20. pygamlab-1.2.0/PyGamLab/structures/Primatom/gam_bond.py +570 -0
  21. pygamlab-1.2.0/PyGamLab/structures/Primatom/gam_molecule.py +731 -0
  22. pygamlab-1.2.0/PyGamLab/structures/__init__.py +33 -0
  23. pygamlab-1.2.0/PyGamLab/structures/gamvis/__init__.py +9 -0
  24. pygamlab-1.2.0/PyGamLab/structures/gamvis/gamvis.py +865 -0
  25. pygamlab-1.2.0/PyGamLab/structures/gamvis/gamvis_engine.py +895 -0
  26. pygamlab-1.2.0/PyGamLab/structures/io/__init__.py +9 -0
  27. pygamlab-1.2.0/PyGamLab/structures/io/checker.py +226 -0
  28. pygamlab-1.2.0/PyGamLab/structures/io/conversions.py +510 -0
  29. pygamlab-1.2.0/PyGamLab/structures/io/export.py +440 -0
  30. pygamlab-1.2.0/PyGamLab/structures/io/read.py +718 -0
  31. {pygamlab-1.0.0 → pygamlab-1.2.0}/PyGamLab.egg-info/PKG-INFO +93 -21
  32. pygamlab-1.2.0/PyGamLab.egg-info/SOURCES.txt +37 -0
  33. {pygamlab-1.0.0 → pygamlab-1.2.0}/PyGamLab.egg-info/requires.txt +5 -0
  34. {pygamlab-1.0.0 → pygamlab-1.2.0}/README.md +87 -20
  35. {pygamlab-1.0.0 → pygamlab-1.2.0}/pyproject.toml +7 -2
  36. {pygamlab-1.0.0 → pygamlab-1.2.0}/setup.py +4 -3
  37. pygamlab-1.0.0/PyGamLab/Data_Analysis.py +0 -3754
  38. pygamlab-1.0.0/PyGamLab.egg-info/SOURCES.txt +0 -13
  39. {pygamlab-1.0.0 → pygamlab-1.2.0}/PyGamLab.egg-info/dependency_links.txt +0 -0
  40. {pygamlab-1.0.0 → pygamlab-1.2.0}/PyGamLab.egg-info/top_level.txt +0 -0
  41. {pygamlab-1.0.0 → pygamlab-1.2.0}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: PyGamLab
3
- Version: 1.0.0
3
+ Version: 1.2.0
4
4
  Summary: A scientific Python library with constants, unit convertors, formulas, and data analysis tools.
5
5
  Home-page: https://github.com/APMaii/pygamlab/tree/main
6
6
  Author: Ali Pilehvar Meibody
@@ -21,6 +21,11 @@ Requires-Dist: scipy
21
21
  Requires-Dist: matplotlib
22
22
  Requires-Dist: seaborn
23
23
  Requires-Dist: scikit-learn
24
+ Requires-Dist: json
25
+ Requires-Dist: scipy
26
+ Requires-Dist: ase
27
+ Requires-Dist: plotly
28
+ Requires-Dist: PyQt5
24
29
  Dynamic: author
25
30
  Dynamic: home-page
26
31
  Dynamic: requires-python
@@ -30,15 +35,13 @@ Dynamic: requires-python
30
35
 
31
36
 
32
37
  <p align="center">
33
- <img src="https://raw.githubusercontent.com/APMaii/pygamlab/refs/heads/main/pics/pygamlab_main_logo.png" alt="PyGamLab Logo" width="450"/>
38
+ <img src="https://github.com/APMaii/pygamlab/blob/main/pics/python_logo_final.png" alt="PyGamLab Logo" width="450"/>
34
39
  </p>
35
40
 
36
41
 
37
42
 
38
43
 
39
- <p align="center">
40
- <i>PyGamLab is a scientific Python library developed for researchers, engineers, and students who need access to fundamental constants, conversion tools, engineering formulas, and data analysis utilities. The package is designed with simplicity, clarity, and usability in mind.</i>
41
- </p>
44
+ <p align="center"> <i>PyGamLab is a scientific Python library developed for researchers, engineers, and students who need access to powerful tools for nanostructure generation, alloy design, material data exploration, and AI-driven analysis. The package is designed with simplicity, clarity, and usability in mind.</i> </p>
42
45
 
43
46
 
44
47
  ---
@@ -47,15 +50,88 @@ Dynamic: requires-python
47
50
 
48
51
  **PyGAMLab** stands for *Python GAMLAb tools*, a collection of scientific tools and functions developed at the **GAMLab (Graphene and Advanced Material Laboratory)** by **Ali Pilehvar Meibody** under the supervision of **Prof. Malek Naderi** at **Amirkabir University of Technology (AUT)**.
49
52
 
50
- - **Author:** Ali Pilehvar Meibody
51
- - **Supervisor:** Prof. Malek Naderi
53
+ - **Main Author:** Ali Pilehvar Meibody
54
+ - **Supervisor:** Prof. Malek Naderi
55
+ - **Co Author:** Danial Nekoonam
56
+ - **Contributor** Shokoofeh Karimi
52
57
  - **Affiliation:** GAMLab, Amirkabir University of Technology (AUT)
53
58
 
54
59
  ---
55
60
 
56
- ## 📦 Modules
61
+ ## 📦 Modules
62
+
63
+ **PyGAMLab** is composed of several core scientific modules, each designed to address a specific domain of materials modeling, nanoscience, and data-driven discovery.
64
+
65
+ ---
66
+
67
+ ### 🧱 `Structure`
68
+
69
+ The **Structure** module is the foundation of PyGAMLab, providing advanced tools to **generate, manipulate, and analyze nanoscale and bulk materials**.
70
+
71
+ **Key Features:**
72
+ - Generate **0D (clusters, nanoparticles)**, **1D (nanowires, nanotubes)**, and **2D (nanosheets, thin films)** structures, as well as **bulk crystals**.
73
+ - Automated builders for **nanoclusters, nanotubes, and supercells**.
74
+ - Perform geometric operations such as **rotation, translation, scaling, merging, slicing**, and **symmetry analysis**.
75
+ - Comprehensive **I/O support**: read, write, and convert structures in formats like `.cif`, `.xyz`, `.pdb`, `.vasp`, `.json`, and more.
76
+ - Direct integration with the **ASE (Atomic Simulation Environment)** via built-in converters.
77
+
78
+ ---
79
+
80
+ ### 🎨 `GAMVis` (GAM Visualizer)
81
+
82
+ **GAMVis** is the internal visualization engine of PyGAMLab — an interactive and high-performance visualizer for atomic and molecular structures.
83
+
84
+ **Capabilities:**
85
+ - Real-time 2D and 3D visualization of **molecules, nanostructures, and crystal lattices**.
86
+ - Graphical representation of **bonds, surfaces, and charge distributions**.
87
+ - Export of rendered structures and animations.
88
+ - Ideal for publication-quality figures and teaching demonstrations.
89
+
90
+ ---
91
+ ### 🤖 `Nano_AI`
92
+
93
+ **Nano_AI** integrates machine learning into materials research, providing tools for **automatic model training**, **fine-tuning**, and **prediction**.
94
+
95
+ **Highlights:**
96
+ - Automated ML workflows for regression, classification, and clustering.
97
+ - Access to over **120 pre-trained machine learning models** trained on nanomaterials datasets.
98
+ - Easy fine-tuning and inference on user-provided data.
99
+ - Includes property predictors for band gap, formation energy, hardness, and more.
100
+ - Built-in tools for data splitting, validation, and model evaluation.
101
+
102
+
103
+ ---
104
+
105
+ ### 🧬 `DB_Explorer`
106
+
107
+ The **DB_Explorer** module provides seamless access to multiple **materials databases**, allowing users to retrieve both structural and property data from leading open repositories.
108
+
109
+ **Supported Databases:**
110
+ - **Materials Project (MP)**
111
+ - **AFLOW**
112
+ - **JARVIS**
113
+ - **Crystallography Open Database (COD)**
114
+
115
+ **Available Data:**
116
+ - Mechanical, electronic, and thermodynamic properties
117
+ - Structural and crystallographic information
118
+ - Chemical composition and symmetry details
119
+
120
+ A universal parent class, **`GAM_Explorer`**, synchronizes and unifies data from all sources, enabling consistent data retrieval and cross-database comparison.
121
+
122
+ ---
123
+
124
+ ### 📊 `Data_Analysis`
125
+
126
+ The **Data_Analysis** module offers advanced tools for **data preprocessing, analysis, and scientific visualization**.
127
+
128
+ **Main Features:**
129
+ - Read and preprocess data from files or DataFrames.
130
+ - Perform filtering, normalization, and feature extraction.
131
+ - Generate publication-ready graphs (line, scatter, histogram, heatmap, etc.).
132
+ - Support for **68+ experimental analysis tools**, including NMR, XPS, XRD, UV-Vis, and Raman spectroscopy.
133
+ - Includes scientific constants, unit converters, and mathematical utilities for laboratory and computational work.
57
134
 
58
- PyGAMLab is composed of **four core modules**, each focused on a specific area of scientific computation:
59
135
 
60
136
  ### 🔹 ` Constants.py`
61
137
  This module includes a comprehensive set of scientific constants used in physics, chemistry, and engineering.
@@ -92,17 +168,6 @@ Examples:
92
168
  - Fluid dynamics formulas
93
169
  - General utility functions
94
170
 
95
- ---
96
-
97
- ### 🔹 `Data_Analysis.py`
98
- Provides tools for working with data, either from a **file path** or directly from a **DataFrame**.
99
-
100
- Features include:
101
- - Reading and preprocessing datasets
102
- - Performing scientific calculations
103
- - Creating visualizations (e.g., line plots, scatter plots, histograms)
104
-
105
-
106
171
 
107
172
  ---
108
173
 
@@ -116,11 +181,16 @@ To use **PyGamLab**, make sure you have the following Python packages installed:
116
181
  - `matplotlib`
117
182
  - `seaborn`
118
183
  - `scikit-learn`
184
+ - `json`
185
+ - `scipy`
186
+ - `ase`
187
+ - `plotly`
188
+ - `PyQt5`
119
189
 
120
190
  You can install all dependencies using:
121
191
 
122
192
  ```bash
123
- pip install numpy pandas scipy matplotlib seaborn scikit-learn
193
+ pip install numpy pandas scipy matplotlib seaborn scikit-learn json scipy ase plotly PyQt5
124
194
  ```
125
195
 
126
196
 
@@ -273,6 +343,8 @@ Special thanks to:
273
343
 
274
344
  - **Prof. Malek Naderi** – For his guidance, mentorship, and continuous support.
275
345
  - **Ali Pilehvar Meibody** – Main developer and author of PyGamLab.
346
+ - **Danial Nekoonam** – Co-Author of PyGamLab.
347
+ - **Shokoofeh Karimi** - For her Contribution of verify and testing most functions
276
348
  - **GAMLab Research Group** – For providing a collaborative and innovative environment.
277
349
  - **Hossein Behjoo** – For his guidance in taking the AI courses and his creative work in the development of the logo.
278
350