Patterns is a collection of common patterns in scientific software that are worth learning. These try to highlight best practices for specific situations, and may cover common tools related to that pattern.

If you want to put data in a package and load it, see Including data files.

If you would like to use backport packages, see Backports.

If you are wondering about public API, see Exports.

• Scientific Python Development Guide
• Tutorials
  • Intro to development
  • Inline documentation
  • Packaging
  • Test
  • Writing documentation
• Topical Guides
  • Testing
  • Coverage
  • Documentation
  • Packaging
    • Simple packaging
    • Compiled packaging
  • Style and static checks
  • Static type checking
  • GitHub Actions
    • GitHub Actions: Introduction
    • GitHub Actions: Pure Python projects
    • GitHub Actions: Compiled projects
  • Security
  • Agentic AI
  • Task runners
• Principles
  • Process recommendations
  • Design recommendations
  • Testing recommendations
• Patterns
  • Exports
  • Backports
  • Including data files
• Repo-Review