MODFLOW development tools

The modflow-devtools package provides a set of tools for developing and testing MODFLOW 6, FloPy, and related applications.

Introduction

• Installation
  • Installing modflow-devtools from PyPI
  • Installing modflow-devtools from source
  • Using modflow-devtools as a pytest plugin
  • Installing external model repositories

Test fixtures

• Fixtures
  • Keepable temporary directories
  • Loading example models
• Markers
  • Default markers
  • Conditionally skipping tests
  • Aliases
• Snapshot testing
  • Using snapshot fixtures
  • Disable snapshots
  • Caveats & gotchas

Miscellaneous

• Working with definition files
  • TOML migration
• Web utilities
  • Queries
  • Downloads
• LaTeX utilities
• Models API
  • Overview
  • Usage
  • Model Names
  • Local Registries
  • Cache Management
  • Automatic Synchronization
  • Repository Integration
• OS Tags
  • Tag specification
  • Getting tags
  • Converting tags
  • Getting suffixes
• Programs API
  • Overview
  • Usage
  • Program Addressing
  • Platform Support
  • Cache Management
  • Force Semantics
  • Automatic Synchronization
  • Repository Integration
  • Relationship to pymake and get-modflow
• timed
• MFZipFile
  • compressall

External tools

• Testing CI workflows locally
• Generating TOCs
  • Installing Node.js, npm and `doctoc``
  • Using doctoc

Developer docs

• DFNs API Design
  • Background
  • Objective
  • Overview
  • Architecture
  • Schema Versioning
  • Component Hierarchy
  • Backwards Compatibility Strategy
  • Implementation Dependencies
  • Relationship to Models and Programs APIs
  • Cross-API Consistency
  • Design Decisions
• Models API Design
  • Background
  • Objective
  • Motivation
  • Overview
  • Architecture
  • Status and Next Steps
  • Cross-API Consistency
  • Demo & Usage Examples
  • Open Questions / Future Enhancements
• Programs API Design
  • Background
  • Objective
  • Overview
  • Architecture
  • Status and Next Steps
  • Relationship to Models API
  • Relationship to get-modflow
  • Cross-API Consistency
  • Design Decisions