PyGamLab 0.2.2

A scientific Python library with constants, unit convertors, formulas, and data analysis tools.

PyGamLab

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.

---

📌 Overview

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).

• Author: Ali Pilehvar Meibody
• Supervisor: Prof. Malek Naderi
• Affiliation: GAMLab, Amirkabir University of Technology (AUT)

---

📦 Modules

PyGAMLab is composed of four core modules, each focused on a specific area of scientific computation:

🔹 Constants.py

This module includes a comprehensive set of scientific constants used in physics, chemistry, and engineering.

Examples:

• Planck's constant
• Boltzmann constant
• Speed of light
• Universal gas constant
• Density of Metals
• Tm of Metals
• And many more...

---

🔹 Convertors.py

Contains unit conversion functions that follow the format:
FirstUnit_To_SecondUnit()

Examples:

• Kelvin_To_Celsius(k)
• Celsius_To_Kelvin(c)
• Meter_To_Foot(m)
• ...and many more standard conversions used in science and engineering.

---

🔹 Functions.py

This module provides a wide collection of scientific formulas and functional tools commonly used in engineering applications.

Examples:

• Thermodynamics equations
• Mechanical stress and strain calculations
• Fluid dynamics formulas
• General utility functions

---

🔹 Data_Analysis.py

Provides tools for working with data, either from a file path or directly from a DataFrame.

Features include:

• Reading and preprocessing datasets
• Performing scientific calculations
• Creating visualizations (e.g., line plots, scatter plots, histograms)

---

📦 Requirements

To use PyGamLab, make sure you have the following Python packages installed:

• numpy
• pandas
• scipy
• matplotlib
• seaborn
• scikit-learn

You can install all dependencies using:

pip install numpy pandas scipy matplotlib seaborn scikit-learn

---

🚀 Installation

To install PyGAMLab via pip:

pip install pygamlab

or

git clone https://github.com/APMaii/pygamlab.git

---

📖 Usage Example

import PyGamLab


import PyGamLab.Constants as gamcn
import PyGamLab.Convertos as gamcv
import PyGamLab.Functions as gamfunc
import PyGamLab.Data_Analysis as gamdat



#--------------Constants-----------------------

print(gamcn.melting_point_of_Cu)
print(gamcn.melting_point_of_Al)
print(gamcn.Fe_Tm_Alpha)
print(gamcn.Fe_Tm_Gama)

print(gamcn.Boltzmann_Constant)
print(gamcn.Faraday_Constant)


#----------Converters------------------------

print(gamcv.Kelvin_to_Celcius(300))           # Convert 300 K to °C
print(gamcv.Coulomb_To_Electron_volt(1))      # Convert 1 Coulomb to eV
print(gamcv.Angstrom_To_Milimeter(1))         # Convert 1 Å to mm
print(gamcv.Bar_To_Pascal(1))                 # Convert 1 bar to Pascal

#-----------Functions------------------------

# Gibb's Free Energy: G = H0 - T*S0
H0 = 100  # Enthalpy in kJ/mol
T = 298   # Temperature in Kelvin
S0 = 0.2  # Entropy in kJ/mol·K
print(gamfunc.Gibs_free_energy(H0, T, S0))


# Electrical Resistance: R = V / I
voltage = 10         # in Volts
current = 2          # in Amperes
print(gamfunc.Electrical_Resistance(voltage, current))

# Hall-Petch Relationship: σ = σ0 + k / √d
d_grain = 0.01       # Grain diameter in mm
sigma0 = 150         # Friction stress in MPa
k = 0.5              # Strengthening coefficient in MPa·mm^0.5
print(gamfunc.Hall_Petch(d_grain, sigma0, k))

#-----------Data_Analysis--------------------
import pandas as pd

df= pd.read_csv('/users/apm/....../data.csv')
gamdat.Stress_Strain1(df, 'PLOT')
my_uts=gamdat.Stress_Strain1(df, 'UTS')


data=pd.read_csv('/users/apm/....../data.csv')
my_max=gamdat.Xrd_Analysis(data,'max intensity')
gamdat.Xrd_Analysis(data,'scatter plot')
gamdat.Xrd_Analysis(data,'line graph')

---

📚 Documentation

For detailed documentation, please visit the official PyGamLab Documentation.

---

Structure

pygamlab/
├── __init__.py
├── Constants.py
├── Convertors.py
├── Functions.py
├── Data_Analysis.py
└── contributers.md

---

🤝 Contributing

Contributions are welcome! Here's how to get started:

Fork the repository. Create your feature branch

git checkout -b feature/my-feature

Commit your changes

git commit -am 'Add some feature'

Push to the branch

git push origin feature/my-feature

Create a new Pull Request. Please make sure to update tests as appropriate and follow PEP8 guidelines.

---

📄 License

This project is licensed under the MIT License — see the LICENSE.txt file for details

---

🙏 Acknowledgements

This project is part of the scientific research activities at GAMLab (Generalized Applied Mechanics Laboratory) at Amirkabir University of Technology (AUT).

Special thanks to:

• Prof. Malek Naderi – For his guidance, mentorship, and continuous support.
• Ali Pilehvar Meibody – Main developer and author of PyGamLab.
• GAMLab Research Group – For providing a collaborative and innovative environment.
• Hossein Behjoo – For his guidance in taking the AI courses and his creative work in the development of the logo.

We would also like to thank all the students who participated in the GAMLab AI course and contributed to the growth and feedback of this project. Their names are proudly listed in the contributors.md file.

This project was made possible thanks to the powerful Python open-source ecosystem:
NumPy, SciPy, Pandas, Matplotlib, Seaborn, Scikit-learn, and many more.

---