Welcome to GenUtils Python Documentation

General Python Utilities (GenUtils Python) is a collection of modules providing common functionalities for scientific computing, with particular emphasis on quantum physics simulations and numerical methods. This documentation provides an overview, installation instructions, usage examples, and a detailed API reference for the library.

Contents:

• Introduction
• Getting Started
  • Installation
  • Backend expectations
  • Quick verification
  • Notes on reproducibility
• Design Principles
  • 1. Explicit scientific contracts
  • 2. Backend-aware by default
  • 3. Lazy-loading for import performance
  • 4. Numerical robustness over convenience
  • 5. Minimal, testable interfaces
  • 6. Documentation as API surface
  • Practical workflow
• Installation
  • Prerequisites
  • Install from Source (GitHub)
  • Dependencies
  • Troubleshooting
• Usage
  • 1. Linear Algebra & Solvers
  • 2. Lattice Geometries
  • 3. Physics & Quantum States
  • 4. Random Number Generation
  • 5. Machine Learning (Neural Networks)
  • 6. Common Utilities
• API Reference
  • Algebra Module
  • Common Utilities
  • Lattices Module
  • Mathematics Module
  • Machine Learning Module
  • Physics Module
• Contributing
  • Docstring Guidelines
• License

• Index

• Module Index

• Search Page