corrosim 1.0.0__tar.gz

corrosim-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 khadev
+
+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.

corrosim-1.0.0/PKG-INFO

@@ -0,0 +1,258 @@
+Metadata-Version: 2.4
+Name: corrosim
+Version: 1.0.0
+Summary: Professional Corrosion Analysis Platform
+Home-page: https://github.com/khadev/CorroSim
+Author: Khaled Oukil
+Author-email: oukil.khaled@gmail.com
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+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: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyQt6>=6.5.0
+Requires-Dist: matplotlib>=3.7.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: scipy>=1.10.0
+Requires-Dist: openpyxl>=3.1.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+# ⚡ CorroSim - Professional Corrosion Analysis Platform
+
+[![Python](https://img.shields.io/badge/Python-3.8+-blue.svg)](https://www.python.org/)
+[![PyQt6](https://img.shields.io/badge/PyQt-6.0+-green.svg)](https://www.riverbankcomputing.com/software/pyqt/)
+[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Tests](https://img.shields.io/badge/Tests-Passing-brightgreen.svg)](tests/)
+
+A comprehensive desktop application for electrochemical corrosion analysis, featuring Tafel polarization fitting, lifetime prediction, and multi-sample comparison.
+
+## ✨ Features
+
+### 🔬 Tafel Polarization Analysis
+- Automatic detection of current units (A, mA, μA)
+- Proper Tafel region identification (80-200 mV from Ecorr)
+- Verified Butler-Volmer kinetics fitting
+- Real-time visualization with Matplotlib
+- Export plots as PNG or PDF
+
+### 🔮 Lifetime Prediction
+- Linear, Power Law, and Exponential degradation models
+- Confidence band visualization
+- Service life estimation with threshold detection
+- Interactive parameter adjustment
+
+### 📊 Sample Comparison
+- Multi-sample database with SQLite storage
+- Search and filter functionality
+- Color-coded corrosion rate indicators
+- Export to Excel for further analysis
+
+### 📁 Data Import
+- Support for Excel (.xlsx, .xls) and CSV files
+- Automatic column detection
+- Data preview with statistics
+- Unit specification options
+
+### 🎨 Professional UI
+- Modern, responsive interface with PyQt6
+- Custom splash screen with progress indicator
+- Consistent styling with professional color theme
+- Sidebar navigation with active state indicators
+
+## 📸 Screenshots
+
+<div align="center">
+
+### 🖥️ Main Application
+<img src="screenshots/main_window.png" alt="Main Window" width="800"/>
+
+### ⚡ Tafel Analysis
+<img src="screenshots/tafel_tab.png" alt="Tafel Analysis" width="800"/>
+
+### 📁 Data Import
+<img src="screenshots/import_tab.png" alt="Data Import" width="800"/>
+
+### 🔮 Lifetime Prediction
+<img src="screenshots/prediction_tab.png" alt="Prediction" width="800"/>
+
+### 📊 Sample Comparison
+<img src="screenshots/comparison_tab.png" alt="Comparison" width="800"/>
+
+</div>
+
+## 🚀 Installation
+
+### Prerequisites
+- Python 3.8 or higher
+- pip package manager
+
+### Quick Install
+
+
+# Clone the repository
+git clone https://github.com/khadev/corrosim.git
+cd corrosim
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Run the application
+python run.py
+
+
+### Install as Package
+
+
+pip install -e .
+corrosim
+
+
+### Direct Install from GitHub
+
+
+pip install git+https://github.com/khadev/corrosim.git
+corrosim
+
+
+## 📦 Dependencies
+
+txt
+PyQt6>=6.5.0
+matplotlib>=3.7.0
+numpy>=1.24.0
+pandas>=2.0.0
+scipy>=1.10.0
+openpyxl>=3.1.0
+
+
+## 🧪 Running Tests
+
+
+python tests/test_tafel.py
+
+
+Expected output:
+
+✓ Test data generation passed
+✓ All accuracy checks passed!
+
+
+## 📖 Usage Guide
+
+### 1. Import Data
+1. Click **📁 Import** in the sidebar
+2. Browse and select your Excel/CSV file
+3. Click **Load Preview** to verify data
+4. Enter sample name and select test type
+5. Specify current units (or use Auto-detect)
+6. Click **Import to Database**
+
+### 2. Tafel Analysis
+1. Navigate to **⚡ Tafel** tab
+2. Click **Load Data** to retrieve imported data
+3. Verify current units and electrode area
+4. Click **⚡ Run Tafel Analysis**
+5. View results: Ecorr, Icorr, Corrosion Rate, Tafel slopes
+6. Export plot as PNG or PDF
+
+### 3. Lifetime Prediction
+1. Go to **🔮 Prediction** tab
+2. Select degradation model (Linear/Power Law/Exponential)
+3. Set initial corrosion rate and failure threshold
+4. Set analysis period
+5. Click **🔮 Calculate Prediction**
+6. View predicted lifetime and degradation curve
+
+### 4. Compare Samples
+1. Open **📊 Compare** tab
+2. Search and filter samples by name
+3. View all analysis results in sortable table
+4. Color-coded CR values: Green (low), Yellow (medium), Red (high)
+5. Export data to Excel
+
+## 🏗️ Project Structure
+
+
+corrosim/
+├── corrosim/                  # Main package
+│   ├── __init__.py
+│   ├── main.py                # Entry point
+│   ├── app.py                 # Main window
+│   ├── theme.py               # UI styling
+│   ├── database.py            # SQLite database
+│   ├── tafel_engine.py        # Analysis algorithms
+│   ├── splash_screen.py       # Splash screen
+│   ├── tabs/                  # Tab modules
+│   │   ├── import_tab.py
+│   │   ├── tafel_tab.py
+│   │   ├── prediction_tab.py
+│   │   └── comparison_tab.py
+│   └── utils/
+│       └── constants.py       # Physical constants
+├── tests/
+│   └── test_tafel.py          # Validation tests
+├── screenshots/               # Application screenshots
+├── requirements.txt
+├── setup.py
+├── run.py
+├── README.md
+├── LICENSE
+└── .gitignore
+
+
+## 🔬 Algorithm Verification
+
+The Tafel engine has been validated using synthetic Butler-Volmer data:
+
+| Parameter | Expected | Recovered | Error |
+|-----------|----------|-----------|-------|
+| Ecorr | -0.500 V | -0.502 V | 0.4% |
+| Icorr | 10.0 μA/cm² | 9.5 μA/cm² | 5.0% |
+| βa | 120 mV/dec | 118.1 mV/dec | 1.6% |
+| βc | 120 mV/dec | 118.4 mV/dec | 1.3% |
+| R² | — | 0.9997 | — |
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add feature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 👤 Author
+
+**Khaled Oukil**
+- GitHub: [@khadev](https://github.com/khadev)
+- Email: oukil.khaled@gmail.com
+
+## 📚 References
+
+1. Stern, M., & Geary, A. L. (1957). Electrochemical Polarization. *Journal of the Electrochemical Society*, 104(1), 56-63.
+2. Tafel, J. (1905). Über die Polarisation bei kathodischer Wasserstoffentwicklung. *Zeitschrift für Physikalische Chemie*, 50(1), 641-712.
+3. ASTM G102-89(2015) - Standard Practice for Calculation of Corrosion Rates from Electrochemical Measurements.
+
+
+
+**Built with ❤️ for the corrosion science community**

corrosim-1.0.0/README.md

@@ -0,0 +1,223 @@
+
+# ⚡ CorroSim - Professional Corrosion Analysis Platform
+
+[![Python](https://img.shields.io/badge/Python-3.8+-blue.svg)](https://www.python.org/)
+[![PyQt6](https://img.shields.io/badge/PyQt-6.0+-green.svg)](https://www.riverbankcomputing.com/software/pyqt/)
+[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Tests](https://img.shields.io/badge/Tests-Passing-brightgreen.svg)](tests/)
+
+A comprehensive desktop application for electrochemical corrosion analysis, featuring Tafel polarization fitting, lifetime prediction, and multi-sample comparison.
+
+## ✨ Features
+
+### 🔬 Tafel Polarization Analysis
+- Automatic detection of current units (A, mA, μA)
+- Proper Tafel region identification (80-200 mV from Ecorr)
+- Verified Butler-Volmer kinetics fitting
+- Real-time visualization with Matplotlib
+- Export plots as PNG or PDF
+
+### 🔮 Lifetime Prediction
+- Linear, Power Law, and Exponential degradation models
+- Confidence band visualization
+- Service life estimation with threshold detection
+- Interactive parameter adjustment
+
+### 📊 Sample Comparison
+- Multi-sample database with SQLite storage
+- Search and filter functionality
+- Color-coded corrosion rate indicators
+- Export to Excel for further analysis
+
+### 📁 Data Import
+- Support for Excel (.xlsx, .xls) and CSV files
+- Automatic column detection
+- Data preview with statistics
+- Unit specification options
+
+### 🎨 Professional UI
+- Modern, responsive interface with PyQt6
+- Custom splash screen with progress indicator
+- Consistent styling with professional color theme
+- Sidebar navigation with active state indicators
+
+## 📸 Screenshots
+
+<div align="center">
+
+### 🖥️ Main Application
+<img src="screenshots/main_window.png" alt="Main Window" width="800"/>
+
+### ⚡ Tafel Analysis
+<img src="screenshots/tafel_tab.png" alt="Tafel Analysis" width="800"/>
+
+### 📁 Data Import
+<img src="screenshots/import_tab.png" alt="Data Import" width="800"/>
+
+### 🔮 Lifetime Prediction
+<img src="screenshots/prediction_tab.png" alt="Prediction" width="800"/>
+
+### 📊 Sample Comparison
+<img src="screenshots/comparison_tab.png" alt="Comparison" width="800"/>
+
+</div>
+
+## 🚀 Installation
+
+### Prerequisites
+- Python 3.8 or higher
+- pip package manager
+
+### Quick Install
+
+
+# Clone the repository
+git clone https://github.com/khadev/corrosim.git
+cd corrosim
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Run the application
+python run.py
+
+
+### Install as Package
+
+
+pip install -e .
+corrosim
+
+
+### Direct Install from GitHub
+
+
+pip install git+https://github.com/khadev/corrosim.git
+corrosim
+
+
+## 📦 Dependencies
+
+txt
+PyQt6>=6.5.0
+matplotlib>=3.7.0
+numpy>=1.24.0
+pandas>=2.0.0
+scipy>=1.10.0
+openpyxl>=3.1.0
+
+
+## 🧪 Running Tests
+
+
+python tests/test_tafel.py
+
+
+Expected output:
+
+✓ Test data generation passed
+✓ All accuracy checks passed!
+
+
+## 📖 Usage Guide
+
+### 1. Import Data
+1. Click **📁 Import** in the sidebar
+2. Browse and select your Excel/CSV file
+3. Click **Load Preview** to verify data
+4. Enter sample name and select test type
+5. Specify current units (or use Auto-detect)
+6. Click **Import to Database**
+
+### 2. Tafel Analysis
+1. Navigate to **⚡ Tafel** tab
+2. Click **Load Data** to retrieve imported data
+3. Verify current units and electrode area
+4. Click **⚡ Run Tafel Analysis**
+5. View results: Ecorr, Icorr, Corrosion Rate, Tafel slopes
+6. Export plot as PNG or PDF
+
+### 3. Lifetime Prediction
+1. Go to **🔮 Prediction** tab
+2. Select degradation model (Linear/Power Law/Exponential)
+3. Set initial corrosion rate and failure threshold
+4. Set analysis period
+5. Click **🔮 Calculate Prediction**
+6. View predicted lifetime and degradation curve
+
+### 4. Compare Samples
+1. Open **📊 Compare** tab
+2. Search and filter samples by name
+3. View all analysis results in sortable table
+4. Color-coded CR values: Green (low), Yellow (medium), Red (high)
+5. Export data to Excel
+
+## 🏗️ Project Structure
+
+
+corrosim/
+├── corrosim/                  # Main package
+│   ├── __init__.py
+│   ├── main.py                # Entry point
+│   ├── app.py                 # Main window
+│   ├── theme.py               # UI styling
+│   ├── database.py            # SQLite database
+│   ├── tafel_engine.py        # Analysis algorithms
+│   ├── splash_screen.py       # Splash screen
+│   ├── tabs/                  # Tab modules
+│   │   ├── import_tab.py
+│   │   ├── tafel_tab.py
+│   │   ├── prediction_tab.py
+│   │   └── comparison_tab.py
+│   └── utils/
+│       └── constants.py       # Physical constants
+├── tests/
+│   └── test_tafel.py          # Validation tests
+├── screenshots/               # Application screenshots
+├── requirements.txt
+├── setup.py
+├── run.py
+├── README.md
+├── LICENSE
+└── .gitignore
+
+
+## 🔬 Algorithm Verification
+
+The Tafel engine has been validated using synthetic Butler-Volmer data:
+
+| Parameter | Expected | Recovered | Error |
+|-----------|----------|-----------|-------|
+| Ecorr | -0.500 V | -0.502 V | 0.4% |
+| Icorr | 10.0 μA/cm² | 9.5 μA/cm² | 5.0% |
+| βa | 120 mV/dec | 118.1 mV/dec | 1.6% |
+| βc | 120 mV/dec | 118.4 mV/dec | 1.3% |
+| R² | — | 0.9997 | — |
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add feature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 👤 Author
+
+**Khaled Oukil**
+- GitHub: [@khadev](https://github.com/khadev)
+- Email: oukil.khaled@gmail.com
+
+## 📚 References
+
+1. Stern, M., & Geary, A. L. (1957). Electrochemical Polarization. *Journal of the Electrochemical Society*, 104(1), 56-63.
+2. Tafel, J. (1905). Über die Polarisation bei kathodischer Wasserstoffentwicklung. *Zeitschrift für Physikalische Chemie*, 50(1), 641-712.
+3. ASTM G102-89(2015) - Standard Practice for Calculation of Corrosion Rates from Electrochemical Measurements.
+
+
+
+**Built with ❤️ for the corrosion science community**

corrosim-1.0.0/corrosim/__init__.py

@@ -0,0 +1,19 @@
+"""
+CorroSim - Professional Corrosion Analysis Platform
+
+A comprehensive tool for electrochemical corrosion analysis including:
+- Tafel polarization analysis
+- Lifetime prediction
+- Multi-sample comparison
+- Data import/export
+"""
+
+__version__ = "1.0.0"
+__author__ = "Your Name"
+__description__ = "Professional Corrosion Analysis Platform"
+
+from .tafel_engine import TafelEngine
+from .database import Database
+from .theme import Theme
+
+__all__ = ['TafelEngine', 'Database', 'Theme']