SalishSeaCast Tools
  • Changes That Break Backward Compatibility
  • SalishSeaTools Package
  • SOGTools Package
  • netCDF4 Files Creation and Conventions
  • Building ERDDAP Datasets
  • Visualisation of NEMO/GEM/Observations using XArray
  • Bathymetry Notebooks and Tools
  • Initial Conditions and Forcing Notebooks and Tools
  • Live Ocean Boundary Conditions Tools
  • Python Packages Development and Maintenance
    • Guidelines and Best Practices for Writing Library Code
    • Mercurial Named Branches
    • Importing Files from Another Mercurial Repo
  • NEMOGCM Tools
  • Legacy Documentation
SalishSeaCast Tools
  • Python Packages Development and Maintenance
  • View page source

Python Packages Development and Maintenance

This section describes how the Python packages in the tools repo are developed. There are also notes here on package maintenance topics such as:

  • Guidelines and Best Practices for Writing Library Code

  • Importing Files from Another Mercurial Repo to form the basis of a new package.

Contents:

  • Guidelines and Best Practices for Writing Library Code
    • Python 3
    • Standard Copyright Header Block
    • Imports
    • Public and Private Objects
    • Automatic Module Documentation Generation
    • Return SimpleNamespace from Functions
    • Module-Specific Best Practices
  • Mercurial Named Branches
  • Importing Files from Another Mercurial Repo
Previous Next

© Copyright 2013 – present, SalishSeaCast Project Contributors and The University of British Columbia. Last updated on Jun 21, 2025.

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