FatPy 0.1.1

Python implementations of various life algorithms

FatPy

A Python package for fatigue life evaluation of materials.

Features

• Stress-Life - Methods for analyzing fatigue life based on stress data
• Strain-Life - Tools for evaluating fatigue life using strain data
• Energy-Life - Methods for assessing fatigue life based on energy data

Quick Links

• Installation Guide
• Contributing Guide
• Documentation
• API Reference
• Theory Reference
• Code of Conduct

Installation

pip install fatpy

For development installation and more options, see our detailed installation guide.

Documentation

The documentation includes:

• API Reference - Detailed documentation of modules, classes, and functions
• Theory Reference - Mathematical and physical background for implemented methods
• Development Guides - Information for contributors

Building Documentation Locally

# Install development dependencies
pip install -e .

# Build and serve documentation
mkdocs serve

Visit http://127.0.0.1:8000 to view the documentation locally.

Contributing

We welcome contributions and follow Test-Driven Development (TDD) principles. Please see our Contributing Guide for:

• Setting up your development environment
• Test-Driven Development workflow
• Code quality guidelines and standards
• Documentation requirement
• Pull request process

Testing

FatPy uses pytest for testing:

# Run all tests
pytest

# Run with coverage
pytest --cov=src/fatpy

The FABER Project

FatPy is a key initiative of Working Group 6 (WG6) within the FABER (Fatigue Benchmark Repository) project, operating under COST Action CA23109.

License

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

Contact

Jan Vyborny - [e-mail] Project Link: github.com/vybornak2/fatpy