PMMoTo
  • User Guide
  • Developer Guide
    • Installation for Development
    • Managing Python Versions
    • Testing
    • Tox-Based Testing
    • Building the Documentation
    • Contributing to PMMoTo
    • Creating and Uploading Releases to PyPI
    • Linux Testing with Docker
    • Code of Conduct
    • Benchmarking
  • References

API Reference

  • pmmoto
PMMoTo
  • Developer Guide
  • View page source

Developer Guide

This section is intended for developers and contributors who want to work on PMMoTo itself. It covers setting up a development environment, running tests and benchmarks, contributing code, and preparing releases. These pages assume some familiarity with Python development tools and are not required for typical users of the library.

Developer Guide

  • Installation for Development
  • Managing Python Versions
    • Why pyenv?
    • macOS (OS X)
    • Linux
    • Project Configuration
    • Next Steps
  • Testing
    • Single-Python Workflow
    • Tox Workflow (Recommended)
  • Tox-Based Testing
    • Overview
    • Test Matrix
    • Running Tox
    • Running Individual Environments
    • Unit and MPI Tests
    • Coverage Analysis
    • Linting and Formatting
    • Static Type Checking
    • Documentation Coverage
    • Python Version Management
    • Continuous Integration
  • Building the Documentation
    • Prerequisites
    • Local Documentation Build
    • Output Location
    • Updating Documentation
    • Notes for Contributors
  • Contributing to PMMoTo
    • Getting Started
    • Making Changes
    • Testing and Quality Checks
    • Submitting Your Contribution
    • Code of Conduct
  • Creating and Uploading Releases to PyPI
    • Prerequisites
    • Versioning
    • Updating the Version
    • Creating a Release
    • What the Workflow Does
    • Workflow Trigger
    • Publishing to PyPI
    • Verifying the Release
    • Notes
  • Linux Testing with Docker
    • Why Docker Is Used
    • Building the Docker Image
    • Running the Docker Container
    • Accessing the Container
    • Stopping and Cleaning Up
    • Notes
  • Code of Conduct
  • Benchmarking
    • Overview
    • Usage
    • Running Benchmarks
    • Interpreting Results
    • Future Improvements
    • Conclusion
Previous Next

© Copyright 2025, Timothy M. Weigand.

Built with Sphinx using a theme provided by Read the Docs.