Metadata-Version: 2.4
Name: promaterialpy
Version: 0.1.0
Summary: A curated collection of mechanical, structural, and materials engineering datasets for mechanical-electrical design, computational modeling, and research. Includes standard commercial specifications, international design codes (ANSI, DIN, ISO, GOST), heat treatment metadata, pure element stiffness profiles, and fiber-reinforced composite manufacturing parameters from physics-inspired simulation and industrial databases.
Home-page: https://github.com/Jornulo/promaterialpy
Author: Jorge Rolando Aarón Núñez López
Author-email: Jorge Nunez Lopez <jorgearon1905@gmail.com>
Maintainer-email: Jorge Nunez Lopez <jorgearon1905@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Jorge Núñez López
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Keywords: materials,engineering,mechanical,electrical,structural,materials science,datasets,youngs modulus,elastic parameters,poisson ratio,yield strength,tensile strength,hardness,steel,alloy,composite materials,manufacturing,simulation,standard standards,ansi,din,iso,data science,research
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas>=1.5
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# promaterialpy

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)

The `promaterialpy` package provides a curated collection of mechanical, structural, and materials engineering datasets for mechanical-electrical design, computational modeling, and research. Includes standard commercial specifications, international design codes (ANSI, DIN, ISO, GOST), heat treatment metadata, pure element stiffness profiles, and fiber-reinforced composite manufacturing parameters from physics-inspired simulation and industrial databases.

## Installation
You can install the `promaterialpy` package from PyPI:
```bash
pip install promaterialpy
```

## Usage
```python

import promaterialpy as pmp

# List all available datasets
datasets = pmp.list_datasets()
print(datasets)

# Load a specific dataset
df = pmp.load_dataset('commercial_properties')
print(df.head())

# Describe dataset
df_01 = pmp.describe_dataset('composite_material_strength')
print(df_01)

```

## 📊 Some Available Datasets

| Dataset | Domain | Description | 
|---------|--------|-------------|
| `commercial_normas` | Materials & Standards | Contains detailed specifications, heat treatments, and international standards (ANSI, DIN, ISO, GOST) for standard design materials.| 
| `commercial_properties` | Mechanical Design | Includes fundamental elastic properties (such as Young's modulus $E$, shear modulus $G$, Poisson's ratio, and density) optimized for direct mechanical calculations.| 
| `pure_metals` | Materials Science | A scientific reference dataset recording the Young's modulus (in GPa) for 50 pure metals from the periodic table, providing an elemental baseline of stiffness.| 
| `solar_generation` | Renewable Energy | Hourly time-series from a photovoltaic solar plant tracking solar irradiance (W/m^2), panel temperatures, and active power output (kW).|
| `building_energy` | Thermal Systems | Thermodynamic simulation data tracking the heating and cooling load requirements (kWh/m^2) based on 12 distinct building geometries.|

> Run `promaterialpy.list_datasets()` or `pmp.list_datasets()` (using `pmp` as alias) to see the full list of available datasets.

## Disclaimer

The datasets included in `promaterialpy` are provided strictly for educational, research, and informational purposes. All datasets originate from open-source industrial databases and public research repositories, retaining their original licenses and attributions.

The author of `promaterialpy` makes no warranties, express or implied, regarding the accuracy, completeness, or suitability of any dataset for a particular structural, mechanical, or engineering purpose. Users are solely responsible for ensuring that their simulations, engineering designs, and use of these datasets comply with applicable industry codes, safety standards, and local regulations.

Any findings, calculations, structural failure analyses, or engineering decisions derived from the use of these datasets are the sole responsibility of the user. The author shall not be held liable for any direct, indirect, incidental, or consequential damages (including, but not limited to, mechanical component failures, structural hazards, or property damage) arising from the use or misuse of the datasets included in this library.

For safety-critical engineering, formal structural certifications, or certified manufacturing specifications, always consult a licensed and qualified Professional Engineer.


## License

The `promaterialpy` library is released under the **MIT License**, which allows free use, modification, distribution, and private use, provided that the original copyright notice and permission notice are included in all copies or substantial portions of the software. See the [LICENSE](LICENSE) file for details.
