Salish Sea MEOPAR Tools
latest
  • SalishSeaTools Package
  • SOGTools Package
  • Salish Sea NEMO Command Processor
  • SalishSeaNowcast 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
  • Marlin – Salish Sea NEMO svn-hg Maintenance Tool
  • 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
Salish Sea MEOPAR Tools
  • Docs »
  • Python Packages Development and Maintenance
  • Edit on Bitbucket

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
Next Previous

© Copyright 2013-2019, Salish Sea MEOPAR Project Contributors and The University of British Columbia Revision 4fb410f75fc0.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.