Skip to main content

Analysis utility for structural panels with cutouts

Project description

Panl

Tests Python Version Poetry

Panl is a Python library for analyzing structural panels with cutouts, providing tools for stress analysis, geometric optimization, and design validation.

Features

  • 🔧 Structural panel analysis with cutout support
  • 📊 Stress concentration calculations
  • 🎯 Geometric optimization
  • ✅ Comprehensive testing with pytest
  • 🎨 Code quality enforced with pre-commit hooks

Installation

From PyPI (once published)

pip install panl

For Development

# Clone the repository
git clone https://github.com/Czarified/panl.git
cd panl

# Install Poetry if you haven't already
# Visit: https://python-poetry.org/docs/#installation

# Install dependencies
poetry install

# Install pre-commit hooks
poetry run pre-commit install

Quick Start

import panl

# Your code here
print(f"Panl version: {panl.__version__}")

Development

This project uses several tools to maintain code quality:

  • Poetry: Dependency management
  • Nox: Task automation and testing across Python versions
  • pre-commit: Git hooks for code quality
  • pytest: Testing framework with coverage

Running Tests

# Run tests with coverage
poetry run nox -s tests

# Run tests for specific Python version
poetry run nox -s tests-3.11

Code Quality

# Run all linters
poetry run nox -s lint

# Format code with black
poetry run nox -s black

# Sort imports with isort
poetry run nox -s isort

# Run pre-commit hooks
poetry run nox -s pre-commit

Available Nox Sessions

# List all available sessions
poetry run nox --list

# Run a specific session
poetry run nox -s <session-name>

Requirements

  • Python >= 3.11
  • Poetry for dependency management

Contributing

Contributions are welcome! Please ensure:

  1. All tests pass: poetry run nox -s tests
  2. Code is formatted: poetry run nox -s black
  3. Linting passes: poetry run nox -s lint
  4. Pre-commit hooks pass: poetry run pre-commit run --all-files

License

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

Author

Benjamin Crews - your.email@example.com

This project is an Agentic Experiment by the author, and uses Gemini 3 Flash.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

panl-0.1.0.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

panl-0.1.0-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

Details for the file panl-0.1.0.tar.gz.

File metadata

  • Download URL: panl-0.1.0.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for panl-0.1.0.tar.gz
Algorithm Hash digest
SHA256 01352dd6df04351cb22bb96cde3ddd8e3b030465036ad1a24b321f2f097179f8
MD5 204d74b12ef95597a1aea6f7677c2f72
BLAKE2b-256 7a978e57d96bf7014b058161c74aa8c2c06f37ac9c71558c8eee20fbb0d0204e

See more details on using hashes here.

Provenance

The following attestation bundles were made for panl-0.1.0.tar.gz:

Publisher: release.yml on Czarified/panl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file panl-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: panl-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 19.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for panl-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dc6ebc5b7d938d63df93705fcb80e5db8ac4a2cc0aa4563b9ae8b4418e5e1e71
MD5 870bc31610e8a3ce347cc578fe8e137e
BLAKE2b-256 0b95bf1ff290a570267e5b9382bd46d61e3ade62a9784fd47fbeeb51064cac30

See more details on using hashes here.

Provenance

The following attestation bundles were made for panl-0.1.0-py3-none-any.whl:

Publisher: release.yml on Czarified/panl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page