py-crane Documentation

Contents:

• Introduction
  • Getting Started
  • Installation
  • Usage Example
  • Development Setup
    • 1. Install uv
    • 2. Install Python
    • 3. Clone the repository
    • 4. Install dependencies
    • 5. (Optional) Activate the virtual environment
    • 6. Install pre-commit hooks
    • 7. Test that the installation works
  • Meta
  • Contributing
• API Reference
  • py-crane package
    • Modules
      • py_crane.crane
      • py_crane.crane_fmu
      • py_crane.boom
      • py_crane.boom_fmu
      • py_crane.mobile_crane
      • py_crane.enum
• Changelog
  • Unreleased
  • 0.3.0 - 2026-02-02
    • Breaking Change: New package name
  • 0.2.0 - 2026-02-02
    • Added
    • Changed
    • Dependencies
  • 0.1.1 - 2023-12-18
    • Changed
    • Solved
    • Added
    • Dependencies
  • 0.1.0 - 2023-09-27
  • 0.0.1 - 2023-02-21
    • Added
    • Changed
    • Dependencies
    • Fixed
    • Deprecated
    • Removed
• Style Guide
  • References
  • Code Layout
  • Line Breaks
  • String Formatting
  • Naming Conventions
  • Named Arguments
  • Commenting
  • Type hints
  • Docstrings
  • Exceptions
  • Imports
  • Unit-tests
  • And finally: It is a bad idea to use
• LICENSE

Indices and tables

• Index

• Module Index

• Search Page