flopy.mf6.utils.generate_classes module

cli_main()[source]

Command-line interface for generate_classes().

generate_classes(owner='MODFLOW-ORG', repo='modflow6', ref=None, dfnpath=None, verbose=False, developmode=True)[source]

Generate Python classes for MODFLOW 6 using definition files fetched from the MODFLOW 6 repository or available on the local filesystem.

Parameters:

  • owner (str, default "MODFLOW-ORG") – Owner of the MODFLOW 6 repository to use to update the definition files and generate the MODFLOW 6 classes.

  • repo (str, default "modflow6") – Name of the MODFLOW 6 repository to use to update the definition.

  • ref (str, default "master") – Branch name, tag, or commit hash to use to update the definition.

  • dfnpath (str) – Path to a definition file folder that will be used to generate the MODFLOW 6 classes. Default is none, which means that the branch will be used instead. dfnpath will take precedence over branch if dfnpath is specified.

  • backup (bool, default True) – Keep a backup of the definition files in dfn_backup with a date and timestamp from when the definition files were replaced.

  • verbose (bool, default False) – If True, print information about the code generation process.

  • developmode (bool, default True) – If True, include all variables, including developmode variables. If False, omit developmode variables from generated modules.