Flopy Code
MODFLOW 6
FloPy for MODFLOW 6 allows for the construction of multi-model simulations. In order to construct a MODFLOW 6 simulation using FloPy, first construct a simulation (MFSimulation) object. Then construct the MODFLOW 6 models (Modflowgwf and Modflowgwt) and the packages, like TDIS, that are associated with the simulation. Finally, construct the packages that are associated with each of your models.
MODFLOW 6 Base Classes
FloPy for MODFLOW 6 is object oriented code that uses inheritance. The FloPy classes used to define different types models and packages share common code that is defined in these base classes.
Contents:
- flopy.mf6.mfbase module
ExtFileActionFlopyExceptionMFDataExceptionMFFileMgmtMFFileMgmt.model_relative_pathMFFileMgmt.add_ext_file()MFFileMgmt.copy_files()MFFileMgmt.get_model_path()MFFileMgmt.get_sim_path()MFFileMgmt.get_updated_path()MFFileMgmt.resolve_path()MFFileMgmt.set_last_accessed_model_path()MFFileMgmt.set_last_accessed_path()MFFileMgmt.set_sim_path()MFFileMgmt.strip_model_relative_path()MFFileMgmt.unique_file_name()
MFFilePathMFInvalidTransientBlockHeaderExceptionPackageContainerPackageContainer.package_type_dictPackageContainer.package_name_dictPackageContainer.get_module_val()PackageContainer.get_package()PackageContainer.model_factory()PackageContainer.models_by_typePackageContainer.modflow_modelsPackageContainer.modflow_packagesPackageContainer.package_dictPackageContainer.package_factory()PackageContainer.package_key_dictPackageContainer.package_list()PackageContainer.package_namesPackageContainer.packages_by_abbrPackageContainer.register_package()
PackageContainerTypeReadAsArraysExceptionStructExceptionVerbosityLevel
- flopy.mf6.mfmodel module
MFModelMFModel.nameMFModel.exe_nameMFModel.packagesMFModel.check()MFModel.exenameMFModel.export()MFModel.get_grid_type()MFModel.get_ims_package()MFModel.get_steadystate_list()MFModel.hdryMFModel.hnofloMFModel.inspect_cells()MFModel.is_valid()MFModel.laycbdMFModel.laytypMFModel.load_base()MFModel.load_package()MFModel.match_array_cells()MFModel.model_wsMFModel.modeldiscritMFModel.modelgridMFModel.modeltimeMFModel.namefileMFModel.nperMFModel.outputMFModel.packagelistMFModel.plot()MFModel.register_package()MFModel.remove_package()MFModel.rename_all_packages()MFModel.set_all_data_external()MFModel.set_all_data_internal()MFModel.set_model_relative_path()MFModel.solver_tolsMFModel.update_package_filename()MFModel.verboseMFModel.versionMFModel.write()
- flopy.mf6.mfpackage module
MFBlockMFBlock.block_headersMFBlock.structureMFBlock.pathMFBlock.datasetsMFBlock.datasets_keywordMFBlock.enabledMFBlock.add_dataset()MFBlock.data_factory()MFBlock.header_exists()MFBlock.is_allowed()MFBlock.is_empty()MFBlock.is_valid()MFBlock.load()MFBlock.set_all_data_external()MFBlock.set_all_data_internal()MFBlock.set_model_relative_path()MFBlock.write()
MFBlockHeaderMFBlockHeader.nameMFBlockHeader.variable_stringsMFBlockHeader.commentMFBlockHeader.data_itemsMFBlockHeader.add_data_item()MFBlockHeader.build_header_variables()MFBlockHeader.connect_to_dict()MFBlockHeader.get_comment()MFBlockHeader.get_transient_key()MFBlockHeader.is_same_header()MFBlockHeader.write_footer()MFBlockHeader.write_header()
MFChildPackagesMFPackageMFPackage.blocksMFPackage.pathMFPackage.structureMFPackage.dimensionsMFPackage.build_child_package()MFPackage.build_child_packages_container()MFPackage.build_mfdata()MFPackage.check()MFPackage.create_package_dimensions()MFPackage.data_listMFPackage.export()MFPackage.filenameMFPackage.get_file_path()MFPackage.inspect_cells()MFPackage.is_valid()MFPackage.load()MFPackage.nameMFPackage.outputMFPackage.package_typeMFPackage.parentMFPackage.plot()MFPackage.plottableMFPackage.quoted_filenameMFPackage.remove()MFPackage.set_all_data_external()MFPackage.set_all_data_internal()MFPackage.set_model_relative_path()MFPackage.write()
MODFLOW 6 Simulation
MODFLOW 6 allows you to create simulations that can contain multiple models and packages. The FloPy for MODFLOW 6 simulation classes define functionality that applies to the entire MODFLOW 6 simulation. When using FloPy for MODFLOW 6 the first object you will most likely create is a simulation (MFSimulation) object.
Contents:
- flopy.mf6.modflow.mfsimulation module
MFSimulationMFSimulation.sim_nameMFSimulation.name_fileMFSimulation.check()MFSimulation.delete_output_files()MFSimulation.exchange_filesMFSimulation.get_exchange_file()MFSimulation.get_file()MFSimulation.get_gnc_file()MFSimulation.get_ims_package()MFSimulation.get_model()MFSimulation.get_mvr_file()MFSimulation.get_mvt_file()MFSimulation.get_solution_package()MFSimulation.is_valid()MFSimulation.load()MFSimulation.load_package()MFSimulation.model_dictMFSimulation.model_namesMFSimulation.plot()MFSimulation.register_exchange_file()MFSimulation.register_ims_package()MFSimulation.register_model()MFSimulation.register_package()MFSimulation.register_solution_package()MFSimulation.remove_exchange_file()MFSimulation.remove_model()MFSimulation.remove_package()MFSimulation.rename_all_packages()MFSimulation.rename_model_namefile()MFSimulation.run_simulation()MFSimulation.set_all_data_external()MFSimulation.set_all_data_internal()MFSimulation.set_sim_path()MFSimulation.sim_package_listMFSimulation.sim_pathMFSimulation.update_package_filename()MFSimulation.write_simulation()
MFSimulationDataMFSimulationData.indent_stringMFSimulationData.internal_formattingMFSimulationData.external_formattingMFSimulationData.open_close_formattingMFSimulationData.max_columns_of_dataMFSimulationData.wrap_multidim_arraysMFSimulationData._float_precisionMFSimulationData._float_charactersMFSimulationData.write_headersMFSimulationData.sci_note_upper_thresMFSimulationData.sci_note_lower_thresMFSimulationData.mfpathMFSimulationData.model_dimensionsMFSimulationData.mfdataMFSimulationData.float_charactersMFSimulationData.float_precisionMFSimulationData.lazy_ioMFSimulationData.max_columns_of_dataMFSimulationData.set_sci_note_lower_thres()MFSimulationData.set_sci_note_upper_thres()
SimulationDict
MODFLOW 6 Simulation Packages
MODFLOW 6 simulation packages are the packages that are not necessarily tied to a specific model and can apply to the entire simulation or a group of models in the simulation.
Contents:
MODFLOW 6 Models
MODFLOW 6 supports both groundwater flow (mfgwf.ModflowGwf) and groundwater transport (mfgwt.ModflowGwt) models. FloPy for MODFLOW 6 model objects can be constructed after a FloPy simulation (MFSimulation) object has been constructed.
Contents:
MODFLOW 6 Groundwater Flow Model Packages
MODFLOW 6 groundwater flow models support a number of required and optional packages. Once a MODFLOW 6 groundwater flow model object (mfgwf.ModflowGwf) has been constructed various packages associated with the groundwater flow model can be constructed.
Contents:
- flopy.mf6.modflow.mfgwfapi module
- flopy.mf6.modflow.mfgwfbuy module
- flopy.mf6.modflow.mfgwfchd module
- flopy.mf6.modflow.mfgwfcsub module
ModflowGwfcsubModflowGwfcsub.cg_ske_crModflowGwfcsub.cg_thetaModflowGwfcsub.compaction_coarse_filerecordModflowGwfcsub.compaction_elastic_filerecordModflowGwfcsub.compaction_filerecordModflowGwfcsub.compaction_inelastic_filerecordModflowGwfcsub.compaction_interbed_filerecordModflowGwfcsub.dfnModflowGwfcsub.dfn_file_nameModflowGwfcsub.obs_filerecordModflowGwfcsub.package_abbrModflowGwfcsub.package_convergence_filerecordModflowGwfcsub.packagedataModflowGwfcsub.sgmModflowGwfcsub.sgsModflowGwfcsub.straincg_filerecordModflowGwfcsub.strainib_filerecordModflowGwfcsub.stress_period_dataModflowGwfcsub.ts_filerecordModflowGwfcsub.zdisplacement_filerecord
- flopy.mf6.modflow.mfgwfdis module
- flopy.mf6.modflow.mfgwfdisu module
ModflowGwfdisuModflowGwfdisu.angldegxModflowGwfdisu.areaModflowGwfdisu.botModflowGwfdisu.cell2dModflowGwfdisu.cl12ModflowGwfdisu.dfnModflowGwfdisu.dfn_file_nameModflowGwfdisu.hwvaModflowGwfdisu.iacModflowGwfdisu.idomainModflowGwfdisu.ihcModflowGwfdisu.jaModflowGwfdisu.package_abbrModflowGwfdisu.topModflowGwfdisu.vertices
- flopy.mf6.modflow.mfgwfdisv module
- flopy.mf6.modflow.mfgwfdrn module
- flopy.mf6.modflow.mfgwfevt module
- flopy.mf6.modflow.mfgwfevta module
- flopy.mf6.modflow.mfgwfghb module
- flopy.mf6.modflow.mfgwfgnc module
- flopy.mf6.modflow.mfgwfgwf module
- flopy.mf6.modflow.mfgwfgwt module
- flopy.mf6.modflow.mfgwfhfb module
- flopy.mf6.modflow.mfgwfic module
- flopy.mf6.modflow.mfgwflak module
ModflowGwflakModflowGwflak.auxiliaryModflowGwflak.budget_filerecordModflowGwflak.budgetcsv_filerecordModflowGwflak.connectiondataModflowGwflak.dfnModflowGwflak.dfn_file_nameModflowGwflak.obs_filerecordModflowGwflak.outletsModflowGwflak.package_abbrModflowGwflak.package_convergence_filerecordModflowGwflak.packagedataModflowGwflak.perioddataModflowGwflak.stage_filerecordModflowGwflak.tablesModflowGwflak.ts_filerecord
- flopy.mf6.modflow.mfgwfmaw module
ModflowGwfmawModflowGwfmaw.auxiliaryModflowGwfmaw.budget_filerecordModflowGwfmaw.budgetcsv_filerecordModflowGwfmaw.connectiondataModflowGwfmaw.dfnModflowGwfmaw.dfn_file_nameModflowGwfmaw.head_filerecordModflowGwfmaw.mfrcsv_filerecordModflowGwfmaw.obs_filerecordModflowGwfmaw.package_abbrModflowGwfmaw.packagedataModflowGwfmaw.perioddataModflowGwfmaw.ts_filerecord
- flopy.mf6.modflow.mfgwfmvr module
- flopy.mf6.modflow.mfgwfnam module
- flopy.mf6.modflow.mfgwfnpf module
- flopy.mf6.modflow.mfgwfoc module
- flopy.mf6.modflow.mfgwfrch module
- flopy.mf6.modflow.mfgwfrcha module
- flopy.mf6.modflow.mfgwfriv module
- flopy.mf6.modflow.mfgwfsfr module
ModflowGwfsfrModflowGwfsfr.auxiliaryModflowGwfsfr.budget_filerecordModflowGwfsfr.budgetcsv_filerecordModflowGwfsfr.connectiondataModflowGwfsfr.crosssectionsModflowGwfsfr.dfnModflowGwfsfr.dfn_file_nameModflowGwfsfr.diversionsModflowGwfsfr.obs_filerecordModflowGwfsfr.package_abbrModflowGwfsfr.package_convergence_filerecordModflowGwfsfr.packagedataModflowGwfsfr.perioddataModflowGwfsfr.stage_filerecordModflowGwfsfr.ts_filerecord
- flopy.mf6.modflow.mfgwfsto module
- flopy.mf6.modflow.mfgwfuzf module
ModflowGwfuzfModflowGwfuzf.auxiliaryModflowGwfuzf.budget_filerecordModflowGwfuzf.budgetcsv_filerecordModflowGwfuzf.dfnModflowGwfuzf.dfn_file_nameModflowGwfuzf.obs_filerecordModflowGwfuzf.package_abbrModflowGwfuzf.package_convergence_filerecordModflowGwfuzf.packagedataModflowGwfuzf.perioddataModflowGwfuzf.ts_filerecordModflowGwfuzf.wc_filerecord
- flopy.mf6.modflow.mfgwfvsc module
- flopy.mf6.modflow.mfgwfwel module
MODFLOW 6 Groundwater Transport Model Packages
MODFLOW 6 groundwater transport models support a number of required and optional packages. Once a MODFLOW 6 groundwater transport model object (mfgwt.ModflowGwt) has been constructed various packages associated with the groundwater transport model can be constructed.
Contents:
- flopy.mf6.modflow.mfgwtadv module
- flopy.mf6.modflow.mfgwtapi module
- flopy.mf6.modflow.mfgwtcnc module
- flopy.mf6.modflow.mfgwtdis module
- flopy.mf6.modflow.mfgwtdisu module
ModflowGwtdisuModflowGwtdisu.angldegxModflowGwtdisu.areaModflowGwtdisu.botModflowGwtdisu.cell2dModflowGwtdisu.cl12ModflowGwtdisu.dfnModflowGwtdisu.dfn_file_nameModflowGwtdisu.hwvaModflowGwtdisu.iacModflowGwtdisu.idomainModflowGwtdisu.ihcModflowGwtdisu.jaModflowGwtdisu.package_abbrModflowGwtdisu.topModflowGwtdisu.vertices
- flopy.mf6.modflow.mfgwtdisv module
- flopy.mf6.modflow.mfgwtdsp module
- flopy.mf6.modflow.mfgwtfmi module
- flopy.mf6.modflow.mfgwtgwt module
- flopy.mf6.modflow.mfgwtic module
- flopy.mf6.modflow.mfgwtist module
ModflowGwtistModflowGwtist.budget_filerecordModflowGwtist.budgetcsv_filerecordModflowGwtist.bulk_densityModflowGwtist.cimModflowGwtist.cim_filerecordModflowGwtist.cimprintrecordModflowGwtist.decayModflowGwtist.decay_sorbedModflowGwtist.dfnModflowGwtist.dfn_file_nameModflowGwtist.distcoefModflowGwtist.package_abbrModflowGwtist.thetaimModflowGwtist.zetaim
- flopy.mf6.modflow.mfgwtlkt module
ModflowGwtlktModflowGwtlkt.auxiliaryModflowGwtlkt.budget_filerecordModflowGwtlkt.budgetcsv_filerecordModflowGwtlkt.concentration_filerecordModflowGwtlkt.dfnModflowGwtlkt.dfn_file_nameModflowGwtlkt.lakeperioddataModflowGwtlkt.obs_filerecordModflowGwtlkt.package_abbrModflowGwtlkt.packagedataModflowGwtlkt.ts_filerecord
- flopy.mf6.modflow.mfgwtmst module
- flopy.mf6.modflow.mfgwtmvt module
- flopy.mf6.modflow.mfgwtmwt module
ModflowGwtmwtModflowGwtmwt.auxiliaryModflowGwtmwt.budget_filerecordModflowGwtmwt.budgetcsv_filerecordModflowGwtmwt.concentration_filerecordModflowGwtmwt.dfnModflowGwtmwt.dfn_file_nameModflowGwtmwt.mwtperioddataModflowGwtmwt.obs_filerecordModflowGwtmwt.package_abbrModflowGwtmwt.packagedataModflowGwtmwt.ts_filerecord
- flopy.mf6.modflow.mfgwtnam module
- flopy.mf6.modflow.mfgwtoc module
- flopy.mf6.modflow.mfgwtsft module
ModflowGwtsftModflowGwtsft.auxiliaryModflowGwtsft.budget_filerecordModflowGwtsft.budgetcsv_filerecordModflowGwtsft.concentration_filerecordModflowGwtsft.dfnModflowGwtsft.dfn_file_nameModflowGwtsft.obs_filerecordModflowGwtsft.package_abbrModflowGwtsft.packagedataModflowGwtsft.reachperioddataModflowGwtsft.ts_filerecord
- flopy.mf6.modflow.mfgwtsrc module
- flopy.mf6.modflow.mfgwtssm module
- flopy.mf6.modflow.mfgwtuzt module
ModflowGwtuztModflowGwtuzt.auxiliaryModflowGwtuzt.budget_filerecordModflowGwtuzt.budgetcsv_filerecordModflowGwtuzt.concentration_filerecordModflowGwtuzt.dfnModflowGwtuzt.dfn_file_nameModflowGwtuzt.obs_filerecordModflowGwtuzt.package_abbrModflowGwtuzt.packagedataModflowGwtuzt.ts_filerecordModflowGwtuzt.uztperioddata
MODFLOW 6 Utility Packages
MODFLOW 6 has several utility packages that can be associated with other packages. This includes the obs package, which can be used to output model results specific to its parent package, and the time series and time array series packages, which can be used to provide time series input for other packages.
Contents:
- flopy.mf6.modflow.mfutlats module
- flopy.mf6.modflow.mfutllaktab module
- flopy.mf6.modflow.mfutlobs module
- flopy.mf6.modflow.mfutlsfrtab module
- flopy.mf6.modflow.mfutlspc module
- flopy.mf6.modflow.mfutlspca module
- flopy.mf6.modflow.mfutltas module
- flopy.mf6.modflow.mfutlts module
- flopy.mf6.modflow.mfutltvk module
- flopy.mf6.modflow.mfutltvs module
MODFLOW 6 Utility Functions
MODFLOW 6 has several utility functions that can be used to process MODFLOW 6 results.
Contents:
- flopy.mf6.utils.binaryfile_utils module
- flopy.mf6.utils.binarygrid_util module
MfGrdFileMfGrdFile.angrotMfGrdFile.botMfGrdFile.cell2dMfGrdFile.cellcentersMfGrdFile.delcMfGrdFile.delrMfGrdFile.grid_typeMfGrdFile.iaMfGrdFile.iavertMfGrdFile.idomainMfGrdFile.ivertsMfGrdFile.jaMfGrdFile.javertMfGrdFile.modelgridMfGrdFile.ncellsMfGrdFile.ncolMfGrdFile.ncplMfGrdFile.njaMfGrdFile.nlayMfGrdFile.nodesMfGrdFile.nrowMfGrdFile.shapeMfGrdFile.topMfGrdFile.vertsMfGrdFile.xoriginMfGrdFile.yorigin
- flopy.mf6.utils.mfobservation module
- flopy.mf6.utils.output_util module
- flopy.mf6.utils.postprocessing module
- flopy.mf6.utils.reference module
SpatialReferenceStructuredSpatialReferenceStructuredSpatialReference.xedgeStructuredSpatialReference.yedgeStructuredSpatialReference.xgridStructuredSpatialReference.ygridStructuredSpatialReference.xcenterStructuredSpatialReference.ycenterStructuredSpatialReference.xcentergridStructuredSpatialReference.ycentergridStructuredSpatialReference.attribute_dictStructuredSpatialReference.from_gridspec()StructuredSpatialReference.from_namfile_header()StructuredSpatialReference.get_extent()StructuredSpatialReference.get_grid_lines()StructuredSpatialReference.get_vertices()StructuredSpatialReference.get_xcenter_array()StructuredSpatialReference.get_xedge_array()StructuredSpatialReference.get_ycenter_array()StructuredSpatialReference.get_yedge_array()StructuredSpatialReference.interpolate()StructuredSpatialReference.ncolStructuredSpatialReference.nrowStructuredSpatialReference.reset()StructuredSpatialReference.rotate()StructuredSpatialReference.set_spatialreference()StructuredSpatialReference.write_gridSpec()StructuredSpatialReference.xcenterStructuredSpatialReference.xcentergridStructuredSpatialReference.xedgeStructuredSpatialReference.xgridStructuredSpatialReference.ycenterStructuredSpatialReference.ycentergridStructuredSpatialReference.yedgeStructuredSpatialReference.ygrid
VertexSpatialReferenceVertexSpatialReference.xedgeVertexSpatialReference.yedgeVertexSpatialReference.xgridVertexSpatialReference.ygridVertexSpatialReference.xcenterVertexSpatialReference.ycenterVertexSpatialReference.xcentergridVertexSpatialReference.ycentergridVertexSpatialReference.from_namfile_header()VertexSpatialReference.get_extent()VertexSpatialReference.ncplVertexSpatialReference.rotate()VertexSpatialReference.set_spatialreference()VertexSpatialReference.xarrVertexSpatialReference.xcenter_arrayVertexSpatialReference.xdictVertexSpatialReference.xydictVertexSpatialReference.yarrVertexSpatialReference.ycenter_arrayVertexSpatialReference.ydict
- flopy.mf6.utils.lakpak_utils module
MODFLOW 6 Data
FloPy for MODFLOW 6 data objects (MFDataArray, MFDataList, MFDataScalar) are automatically constructed by FloPy when you construct a package. These data objects provide an interface for getting MODFLOW 6 data in different formats and setting MODFLOW 6 data.
Contents:
- flopy.mf6.data.mfdataarray module
MFArrayMFArray.dataMFArray.data_typeMFArray.dtypeMFArray.get_data()MFArray.get_file_entry()MFArray.get_record()MFArray.has_data()MFArray.load()MFArray.make_layered()MFArray.new_simulation()MFArray.plot()MFArray.plottableMFArray.set_data()MFArray.set_layered_data()MFArray.set_record()MFArray.store_as_external_file()MFArray.store_internal()MFArray.supports_layered()
MFTransientArrayMFTransientArray.add_transient_key()MFTransientArray.data_typeMFTransientArray.get_data()MFTransientArray.get_file_entry()MFTransientArray.get_record()MFTransientArray.has_data()MFTransientArray.load()MFTransientArray.plot()MFTransientArray.remove_transient_key()MFTransientArray.set_data()MFTransientArray.set_record()MFTransientArray.store_as_external_file()MFTransientArray.store_internal()
- flopy.mf6.data.mfdatalist module
MFListMFList.append_data()MFList.append_list_as_record()MFList.data_typeMFList.dtypeMFList.get_data()MFList.get_file_entry()MFList.get_record()MFList.has_data()MFList.load()MFList.new_simulation()MFList.packageMFList.plot()MFList.plottableMFList.search_data()MFList.set_data()MFList.set_record()MFList.store_as_external_file()MFList.store_internal()MFList.to_array()MFList.update_record()
MFMultipleListMFTransientListMFTransientList.add_transient_key()MFTransientList.append_list_as_record()MFTransientList.dataMFTransientList.data_typeMFTransientList.dtypeMFTransientList.get_data()MFTransientList.get_file_entry()MFTransientList.get_record()MFTransientList.has_data()MFTransientList.load()MFTransientList.masked_4D_arraysMFTransientList.masked_4D_arrays_itr()MFTransientList.plot()MFTransientList.remove_transient_key()MFTransientList.set_data()MFTransientList.set_record()MFTransientList.store_as_external_file()MFTransientList.store_internal()MFTransientList.to_array()MFTransientList.update_record()
- flopy.mf6.data.mfdatascalar module
Build MODFLOW 6 Classes
MODFLOW 6 FloPy classes can be rebuild from MODFLOW 6 definition files. This will allow creation of MODFLOW 6 FloPy classes for development versions of MODFLOW 6.
Contents:
- flopy.mf6.utils.createpackages module
- flopy.mf6.utils.generate_classes module
Previous Versions of MODFLOW
MODFLOW Base Classes
Contents:
- flopy.mbase module
BaseModelBaseModel.add_existing_package()BaseModel.add_external()BaseModel.add_output()BaseModel.add_output_file()BaseModel.add_package()BaseModel.add_pop_key_list()BaseModel.change_model_ws()BaseModel.check()BaseModel.exenameBaseModel.export()BaseModel.get_ext_dict_attr()BaseModel.get_name_file_entries()BaseModel.get_output()BaseModel.get_output_attribute()BaseModel.get_package()BaseModel.has_package()BaseModel.hdryBaseModel.hnofloBaseModel.laycbdBaseModel.laytypBaseModel.load_results()BaseModel.model_wsBaseModel.modelgridBaseModel.modeltimeBaseModel.nameBaseModel.namefileBaseModel.next_ext_unit()BaseModel.next_unit()BaseModel.packagelistBaseModel.plot()BaseModel.remove_external()BaseModel.remove_output()BaseModel.remove_package()BaseModel.run_model()BaseModel.set_model_units()BaseModel.set_output_attribute()BaseModel.set_version()BaseModel.to_shapefile()BaseModel.verboseBaseModel.versionBaseModel.write_input()BaseModel.write_name_file()
FileDataFileDataEntryModelInterfaceModelInterface.check()ModelInterface.exenameModelInterface.export()ModelInterface.get_package_list()ModelInterface.hdryModelInterface.hnofloModelInterface.laycbdModelInterface.laytypModelInterface.model_wsModelInterface.modelgridModelInterface.namefileModelInterface.packagelistModelInterface.solver_tolsModelInterface.update_modelgrid()ModelInterface.verboseModelInterface.version
PackageLoadExceptionresolve_exe()run_model()
- flopy.pakbase module
MODFLOW Packages
Contents:
- flopy.modflow.mf module
ModflowModflow.get_ifrefm()Modflow.get_nrow_ncol_nlay_nper()Modflow.load()Modflow.load_results()Modflow.modelgridModflow.modeltimeModflow.ncolModflow.ncplModflow.nlayModflow.nperModflow.nrowModflow.nrow_ncol_nlay_nperModflow.set_ifrefm()Modflow.set_model_units()Modflow.solver_tolsModflow.write_name_file()
ModflowGlobalModflowList
- flopy.modflow.mfaddoutsidefile module
- flopy.modflow.mfag module
- flopy.modflow.mfbas module
- flopy.modflow.mfbcf module
- flopy.modflow.mfbct module
- flopy.modflow.mfchd module
- flopy.modflow.mfde4 module
- flopy.modflow.mfdis module
ModflowDisModflowDis.headingModflowDis.check()ModflowDis.checklayerthickness()ModflowDis.get_cell_volumes()ModflowDis.get_final_totim()ModflowDis.get_kstp_kper_toffset()ModflowDis.get_layer()ModflowDis.get_lrc()ModflowDis.get_node()ModflowDis.get_node_coordinates()ModflowDis.get_rc_from_node_coordinates()ModflowDis.get_totim()ModflowDis.get_totim_from_kper_toffset()ModflowDis.getbotm()ModflowDis.gettop()ModflowDis.load()ModflowDis.write_file()ModflowDis.zcentroids
get_layer()
- flopy.modflow.mfdrn module
- flopy.modflow.mfdrt module
- flopy.modflow.mfevt module
- flopy.modflow.mffhb module
- flopy.modflow.mfflwob module
- flopy.modflow.mfgage module
- flopy.modflow.mfghb module
- flopy.modflow.mfgmg module
- flopy.modflow.mfhfb module
- flopy.modflow.mfhob module
- flopy.modflow.mfhyd module
- flopy.modflow.mflak module
- flopy.modflow.mflmt module
- flopy.modflow.mflpf module
- flopy.modflow.mfmlt module
- flopy.modflow.mfmnw1 module
- flopy.modflow.mfmnw2 module
ItmpErrorMnwModflowMnw2ModflowMnw2.check()ModflowMnw2.export()ModflowMnw2.get_allnode_data()ModflowMnw2.get_default_node_dtype()ModflowMnw2.get_default_spd_dtype()ModflowMnw2.get_empty_node_data()ModflowMnw2.get_empty_stress_period_data()ModflowMnw2.load()ModflowMnw2.make_mnw_objects()ModflowMnw2.make_node_data()ModflowMnw2.make_stress_period_data()ModflowMnw2.write_file()
- flopy.modflow.mfmnwi module
- flopy.modflow.mfnwt module
- flopy.modflow.mfoc module
- flopy.modflow.mfpar module
- flopy.modflow.mfparbc module
- flopy.modflow.mfpbc module
- flopy.modflow.mfpcg module
- flopy.modflow.mfpcgn module
- flopy.modflow.mfpks module
- flopy.modflow.mfpval module
- flopy.modflow.mfrch module
- flopy.modflow.mfriv module
- flopy.modflow.mfsfr2 module
ModflowSfr2ModflowSfr2.outletsModflowSfr2.outsegsModflowSfr2.assign_layers()ModflowSfr2.check()ModflowSfr2.constModflowSfr2.dataset_5ModflowSfr2.deactivate_ibound_above()ModflowSfr2.default_valueModflowSfr2.dfModflowSfr2.export()ModflowSfr2.export_linkages()ModflowSfr2.export_outlets()ModflowSfr2.export_transient_variable()ModflowSfr2.get_default_reach_dtype()ModflowSfr2.get_default_segment_dtype()ModflowSfr2.get_empty_reach_data()ModflowSfr2.get_empty_segment_data()ModflowSfr2.get_outlets()ModflowSfr2.get_slopes()ModflowSfr2.get_upsegs()ModflowSfr2.get_variable_by_stress_period()ModflowSfr2.graphModflowSfr2.len_constModflowSfr2.load()ModflowSfr2.nperModflowSfr2.nsfrparModflowSfr2.nssModflowSfr2.nstrmModflowSfr2.pathsModflowSfr2.plot_path()ModflowSfr2.renumber_segments()ModflowSfr2.repair_outsegs()ModflowSfr2.reset_reaches()ModflowSfr2.set_outreaches()ModflowSfr2.time_constModflowSfr2.write_file()
checkfind_path()
- flopy.modflow.mfsip module
- flopy.modflow.mfsor module
- flopy.modflow.mfstr module
- flopy.modflow.mfsub module
- flopy.modflow.mfswi2 module
- flopy.modflow.mfswr1 module
- flopy.modflow.mfswt module
- flopy.modflow.mfupw module
- flopy.modflow.mfuzf1 module
- flopy.modflow.mfwel module
- flopy.modflow.mfzon module
MT3DMS Packages
Contents:
- flopy.mt3d.mt module
- flopy.mt3d.mtadv module
- flopy.mt3d.mtbtn module
- flopy.mt3d.mtcts module
- flopy.mt3d.mtdsp module
- flopy.mt3d.mtgcg module
- flopy.mt3d.mtlkt module
- flopy.mt3d.mtphc module
- flopy.mt3d.mtrct module
- flopy.mt3d.mtsft module
- flopy.mt3d.mtssm module
- flopy.mt3d.mttob module
- flopy.mt3d.mtuzt module
SEAWAT Packages
Contents:
MODPATH 7 Packages
Contents:
MODPATH 6 Packages
Contents:
Flopy Utilities
Model Utilities (including binary file readers)
Contents:
- flopy.utils.binaryfile module
BinaryHeaderBinaryLayerFileBudgetIndexErrorCellBudgetFileCellBudgetFile.close()CellBudgetFile.get_data()CellBudgetFile.get_indices()CellBudgetFile.get_kstpkper()CellBudgetFile.get_nrecords()CellBudgetFile.get_position()CellBudgetFile.get_record()CellBudgetFile.get_residual()CellBudgetFile.get_times()CellBudgetFile.get_ts()CellBudgetFile.get_unique_package_names()CellBudgetFile.get_unique_record_names()CellBudgetFile.list_records()CellBudgetFile.list_unique_packages()CellBudgetFile.list_unique_records()
HeadFileHeadUFileUcnFilebinaryread()binaryread_struct()get_headfile_precision()join_struct_arrays()write_budget()write_head()
- flopy.utils.check module
checkcheck.append_passed()check.bc_stage_namescheck.get_active()check.get_neighbors()check.isvalid()check.package_check_levelscheck.print_summary()check.property_threshold_valuescheck.remove_passed()check.solver_packagescheck.stress_period_data_values()check.summarize()check.thin_cell_thresholdcheck.values()check.view_summary_array_fields()
fields_view()mf6check
- flopy.utils.compare module
- flopy.utils.crs module
- flopy.utils.cvfdutil module
- flopy.utils.datafile module
- flopy.utils.datautil module
ArrayIndexIterConstIterDatumUtilFileIterMultiListMultiListIterNameIterPathIterPyListUtilPyListUtil.save_array()PyListUtil.array_comp()PyListUtil.clean_numeric()PyListUtil.consistent_delimPyListUtil.delimiter_listPyListUtil.delimiter_usedPyListUtil.first_item()PyListUtil.has_one_item()PyListUtil.is_empty_list()PyListUtil.is_iterable()PyListUtil.line_numPyListUtil.max_multi_dim_list_size()PyListUtil.next_item()PyListUtil.next_list()PyListUtil.numeric_charsPyListUtil.quote_listPyListUtil.reset_delimiter_used()PyListUtil.riv_array_comp()PyListUtil.save_array()PyListUtil.save_array_diff()PyListUtil.split_data_line()
clean_filename()clean_name()find_keyword()max_tuple_abs_size()
- flopy.utils.flopy_io module
- flopy.utils.formattedfile module
- flopy.utils.geometry module
- flopy.utils.geospatial_utils module
- flopy.utils.get_modflow module
- flopy.utils.gridgen module
GridgenGridgen.add_active_domain()Gridgen.add_refinement_features()Gridgen.build()Gridgen.export()Gridgen.get_angldegx()Gridgen.get_area()Gridgen.get_bot()Gridgen.get_cellxy()Gridgen.get_center()Gridgen.get_cl12()Gridgen.get_disu()Gridgen.get_fahl()Gridgen.get_fldr()Gridgen.get_gridprops_disu5()Gridgen.get_gridprops_disu6()Gridgen.get_gridprops_disv()Gridgen.get_gridprops_unstructuredgrid()Gridgen.get_gridprops_vertexgrid()Gridgen.get_hwva()Gridgen.get_iac()Gridgen.get_ihc()Gridgen.get_ivc()Gridgen.get_ja()Gridgen.get_nlay()Gridgen.get_nod_recarray()Gridgen.get_nodelay()Gridgen.get_nodes()Gridgen.get_top()Gridgen.get_vertices()Gridgen.get_verts_iverts()Gridgen.gridarray_to_flopyusg_gridarray()Gridgen.intersect()Gridgen.plot()Gridgen.set_surface_interpolation()
features_to_shapefile()get_ia_from_iac()get_isym()is_symmetrical()ndarray_to_asciigrid()read1d()repair_array_asymmetry()
- flopy.utils.gridintersect module
- flopy.utils.gridutil module
- flopy.utils.lgrutil module
- flopy.utils.mflistfile module
ListBudgetListBudget.get_budget()ListBudget.get_cumulative()ListBudget.get_data()ListBudget.get_dataframes()ListBudget.get_incremental()ListBudget.get_kstpkper()ListBudget.get_model_runtime()ListBudget.get_record_names()ListBudget.get_reduced_pumping()ListBudget.get_times()ListBudget.get_tslens()ListBudget.isvalid()ListBudget.set_budget_key()
Mf6ListBudgetMfListBudgetMfusgListBudgetSwrListBudgetSwtListBudget
- flopy.utils.mfreadnam module
- flopy.utils.modpathfile module
- flopy.utils.mtlistfile module
- flopy.utils.observationfile module
- flopy.utils.optionblock module
OptionBlockOptionBlock.dtypeOptionBlock.load_options()OptionBlock.n_nestedOptionBlock.nestedOptionBlock.optionalOptionBlock.simple_flagOptionBlock.simple_floatOptionBlock.simple_intOptionBlock.simple_strOptionBlock.simple_tabfileOptionBlock.single_line_optionsOptionBlock.update_from_package()OptionBlock.varsOptionBlock.write_options()
OptionUtil
- flopy.utils.parse_version module
- flopy.utils.postprocessing module
- flopy.utils.rasters module
RasterRaster.FLOAT32Raster.FLOAT64Raster.INT16Raster.INT32Raster.INT64Raster.INT8Raster.bandsRaster.boundsRaster.crop()Raster.get_array()Raster.histogram()Raster.load()Raster.nodatavalsRaster.plot()Raster.resample_to_grid()Raster.sample_point()Raster.sample_polygon()Raster.write()Raster.xcentersRaster.ycenters
- flopy.utils.recarray_utils module
- flopy.utils.reference module
- flopy.utils.sfroutputfile module
- flopy.utils.swroutputfile module
- flopy.utils.triangle module
TriangleTriangle.add_hole()Triangle.add_polygon()Triangle.add_region()Triangle.build()Triangle.clean()Triangle.get_attribute_array()Triangle.get_boundary_marker_array()Triangle.get_cell2d()Triangle.get_cell_edge_length()Triangle.get_edge_cells()Triangle.get_vertices()Triangle.get_xcyc()Triangle.label_cells()Triangle.label_vertices()Triangle.plot()Triangle.plot_boundary()Triangle.plot_centroids()Triangle.plot_vertices()
- flopy.utils.util_array module
ArrayFormatArrayFormat.fortranArrayFormat.pyArrayFormat.numpyArrayFormat.nplArrayFormat.widthArrayFormat.decimalArrayFormat.formatArrayFormat.freeArrayFormat.binaryArrayFormat.array_free_formatArrayFormat.binaryArrayFormat.decimalArrayFormat.decode_fortran_descriptor()ArrayFormat.float()ArrayFormat.formatArrayFormat.fortranArrayFormat.freeArrayFormat.get_default_numpy_fmt()ArrayFormat.integer()ArrayFormat.nplArrayFormat.numpyArrayFormat.pyArrayFormat.width
Transient2dTransient2d.transient_2dsTransient2d.arrayTransient2d.build_transient_sequence()Transient2d.data_typeTransient2d.dtypeTransient2d.export()Transient2d.from_4d()Transient2d.get_kper_entry()Transient2d.get_zero_2d()Transient2d.masked4d_array_to_kper_dict()Transient2d.modelTransient2d.nameTransient2d.plot()Transient2d.plottable
Transient3dUtil2dUtil2d.arrayUtil2d.howUtil2d.formatUtil2d.all()Util2d.arrayUtil2d.array2string()Util2d.cnstnt_strUtil2d.data_typeUtil2d.dtypeUtil2d.export()Util2d.filenameUtil2d.formatUtil2d.get_constant_cr()Util2d.get_external_cr()Util2d.get_file_entry()Util2d.get_internal_cr()Util2d.get_openclose_cr()Util2d.get_value()Util2d.howUtil2d.load()Util2d.load_bin()Util2d.load_block()Util2d.load_txt()Util2d.modelUtil2d.model_file_pathUtil2d.nameUtil2d.parse_control_record()Util2d.parse_value()Util2d.plot()Util2d.plottableUtil2d.python_file_pathUtil2d.set_fmtin()Util2d.stringUtil2d.sum()Util2d.unique()Util2d.vtypeUtil2d.write_bin()Util2d.write_txt()
Util3dnew_u2d()read1d()
- flopy.utils.util_list module
MfListMfList.mxactMfList.add_record()MfList.append()MfList.arrayMfList.attribute_by_kper()MfList.binaryMfList.check_kij()MfList.dataMfList.data_typeMfList.dfMfList.drop()MfList.dtypeMfList.export()MfList.fmt_stringMfList.from_4d()MfList.get_dataframe()MfList.get_empty()MfList.get_filename()MfList.get_filenames()MfList.get_indices()MfList.get_itmp()MfList.masked4D_arrays_to_stress_period_data()MfList.masked_4D_arraysMfList.masked_4D_arrays_itr()MfList.mgMfList.modelMfList.mxactMfList.nameMfList.packageMfList.plot()MfList.plottableMfList.to_array()MfList.to_shapefile()MfList.vtypeMfList.write_transient()
- flopy.utils.utils_def module
- flopy.utils.utl_import module
- flopy.utils.voronoi module
- flopy.utils.zonbud module
Plotting Utilities
Contents:
- flopy.plot.crosssection module
PlotCrossSectionPlotCrossSection.contour_array()PlotCrossSection.get_extent()PlotCrossSection.get_grid_line_collection()PlotCrossSection.get_grid_patch_collection()PlotCrossSection.plot_array()PlotCrossSection.plot_bc()PlotCrossSection.plot_endpoint()PlotCrossSection.plot_fill_between()PlotCrossSection.plot_grid()PlotCrossSection.plot_ibound()PlotCrossSection.plot_inactive()PlotCrossSection.plot_pathline()PlotCrossSection.plot_surface()PlotCrossSection.plot_timeseries()PlotCrossSection.plot_vector()PlotCrossSection.polygonsPlotCrossSection.set_zcentergrid()PlotCrossSection.set_zpts()
- flopy.plot.map module
PlotMapViewPlotMapView.contour_array()PlotMapView.extentPlotMapView.plot_array()PlotMapView.plot_bc()PlotMapView.plot_endpoint()PlotMapView.plot_grid()PlotMapView.plot_ibound()PlotMapView.plot_inactive()PlotMapView.plot_pathline()PlotMapView.plot_shapefile()PlotMapView.plot_shapes()PlotMapView.plot_timeseries()PlotMapView.plot_vector()
- flopy.plot.plotutil module
PlotUtilitiesSwiConcentrationUnstructuredPlotUtilitiesadvanced_package_bc_helper()cvfd_to_patch_collection()filter_modpath_by_travel_time()intersect_modpath_with_crosssection()parse_modpath_selection_options()plot_cvfd()plot_shapefile()reproject_modpath_to_crosssection()shapefile_extents()shapefile_get_vertices()shapefile_to_patch_collection()
- flopy.plot.styles module
Export Utilities
Contents:
- flopy.export.longnames module
- flopy.export.metadata module
- flopy.export.netcdf module
LoggerNetCdfNetCdf.add_global_attributes()NetCdf.add_sciencebase_metadata()NetCdf.append()NetCdf.copy()NetCdf.create_group_variable()NetCdf.create_variable()NetCdf.difference()NetCdf.empty_like()NetCdf.get_longnames_from_docstrings()NetCdf.initialize_file()NetCdf.initialize_geometry()NetCdf.initialize_group()NetCdf.nc_crsNetCdf.normalize_name()NetCdf.write()NetCdf.zeros_like()
- flopy.export.shapefile_utils module
- flopy.export.unitsformat module
- flopy.export.utils module
- flopy.export.vtk module
PEST Utilities
Contents:
Discretization Utilities
Contents:
- flopy.discretization.grid module
CachedDataGridGrid.grid_typeGrid.topGrid.botmGrid.idomainGrid.crsGrid.lenuniGrid.xoffsetGrid.yoffsetGrid.angrotGrid.angrot_radiansGrid.xgridGrid.ygridGrid.zgridGrid.xcentersGrid.ycentersGrid.ycentersGrid.xyzgridGrid.xyzcellcentersGrid.get_coords()Grid.intersect()Grid.angrotGrid.angrot_radiansGrid.attribs_from_namfile_header()Grid.botmGrid.cell_thicknessGrid.cross_section_adjust_indicies()Grid.cross_section_lay_ncpl_ncb()Grid.cross_section_nodeskip()Grid.cross_section_set_contour_arrays()Grid.cross_section_verticesGrid.crsGrid.epsgGrid.extentGrid.from_binary_grid_file()Grid.get_coords()Grid.get_lni()Grid.get_local_coords()Grid.get_number_plottable_layers()Grid.get_plottable_layer_array()Grid.get_plottable_layer_shape()Grid.get_xcellcenters_for_layer()Grid.get_xvertices_for_layer()Grid.get_ycellcenters_for_layer()Grid.get_yvertices_for_layer()Grid.grid_linesGrid.grid_typeGrid.idomainGrid.intersect()Grid.is_completeGrid.is_validGrid.ivertsGrid.laycbdGrid.lenuniGrid.load_coord_info()Grid.map_polygonsGrid.ncplGrid.neighbors()Grid.nlayGrid.nnodesGrid.nvertGrid.prjGrid.prjfileGrid.proj4Grid.read_usgs_model_reference_file()Grid.remove_confining_beds()Grid.saturated_thick()Grid.saturated_thickness()Grid.set_coord_info()Grid.shapeGrid.sizeGrid.thickGrid.topGrid.top_botmGrid.unitsGrid.vertsGrid.write_shapefile()Grid.xcellcentersGrid.xoffsetGrid.xverticesGrid.xyzcellcentersGrid.xyzextentGrid.xyzverticesGrid.ycellcentersGrid.yoffsetGrid.yverticesGrid.zcellcentersGrid.zvertices
- flopy.discretization.modeltime module
- flopy.discretization.structuredgrid module
StructuredGridStructuredGrid.get_cell_vertices()StructuredGrid.array_at_faces()StructuredGrid.array_at_verts()StructuredGrid.array_at_verts_basic()StructuredGrid.cross_section_verticesStructuredGrid.delcStructuredGrid.delrStructuredGrid.delzStructuredGrid.extentStructuredGrid.from_binary_grid_file()StructuredGrid.from_gridspec()StructuredGrid.get_cell_vertices()StructuredGrid.get_lrc()StructuredGrid.get_node()StructuredGrid.get_number_plottable_layers()StructuredGrid.get_plottable_layer_array()StructuredGrid.grid_linesStructuredGrid.intersect()StructuredGrid.is_completeStructuredGrid.is_rectilinearStructuredGrid.is_regularStructuredGrid.is_regular_xStructuredGrid.is_regular_xyStructuredGrid.is_regular_xzStructuredGrid.is_regular_yStructuredGrid.is_regular_yzStructuredGrid.is_regular_zStructuredGrid.is_validStructuredGrid.ivertsStructuredGrid.map_polygonsStructuredGrid.ncolStructuredGrid.ncplStructuredGrid.neighbors()StructuredGrid.nlayStructuredGrid.nnodesStructuredGrid.nrowStructuredGrid.nvertStructuredGrid.plot()StructuredGrid.shapeStructuredGrid.top_botmStructuredGrid.top_botm_withnanStructuredGrid.vertsStructuredGrid.xycentersStructuredGrid.xyedgesStructuredGrid.xyzcellcentersStructuredGrid.xyzverticesStructuredGrid.zedgesStructuredGrid.zverts_smooth
array_at_faces_1d()array_at_verts_basic2d()
- flopy.discretization.unstructuredgrid module
UnstructuredGridUnstructuredGrid.get_cell_vertices()UnstructuredGrid.cross_section_adjust_indicies()UnstructuredGrid.cross_section_lay_ncpl_ncb()UnstructuredGrid.cross_section_nodeskip()UnstructuredGrid.cross_section_set_contour_arrays()UnstructuredGrid.cross_section_verticesUnstructuredGrid.extentUnstructuredGrid.from_argus_export()UnstructuredGrid.from_binary_grid_file()UnstructuredGrid.from_gridspec()UnstructuredGrid.get_cell_vertices()UnstructuredGrid.get_layer_node_range()UnstructuredGrid.get_number_plottable_layers()UnstructuredGrid.get_plottable_layer_array()UnstructuredGrid.get_plottable_layer_shape()UnstructuredGrid.get_xcellcenters_for_layer()UnstructuredGrid.get_xvertices_for_layer()UnstructuredGrid.get_ycellcenters_for_layer()UnstructuredGrid.get_yvertices_for_layer()UnstructuredGrid.grid_linesUnstructuredGrid.grid_varies_by_layerUnstructuredGrid.iacUnstructuredGrid.intersect()UnstructuredGrid.is_completeUnstructuredGrid.is_validUnstructuredGrid.ivertsUnstructuredGrid.jaUnstructuredGrid.map_polygonsUnstructuredGrid.ncplUnstructuredGrid.ncpl_from_ihc()UnstructuredGrid.neighbors()UnstructuredGrid.nlayUnstructuredGrid.nnodesUnstructuredGrid.nvertUnstructuredGrid.plot()UnstructuredGrid.set_ncpl()UnstructuredGrid.shapeUnstructuredGrid.top_botmUnstructuredGrid.vertsUnstructuredGrid.xyzcellcentersUnstructuredGrid.xyzvertices
- flopy.discretization.vertexgrid module
VertexGridVertexGrid.get_cell_vertices()VertexGrid.cell1dVertexGrid.cell2dVertexGrid.extentVertexGrid.from_binary_grid_file()VertexGrid.get_cell_vertices()VertexGrid.get_number_plottable_layers()VertexGrid.get_plottable_layer_array()VertexGrid.get_xcellcenters_for_layer()VertexGrid.get_xvertices_for_layer()VertexGrid.get_ycellcenters_for_layer()VertexGrid.get_yvertices_for_layer()VertexGrid.grid_linesVertexGrid.intersect()VertexGrid.is_completeVertexGrid.is_validVertexGrid.ivertsVertexGrid.map_polygonsVertexGrid.ncplVertexGrid.nlayVertexGrid.nnodesVertexGrid.nvertVertexGrid.plot()VertexGrid.shapeVertexGrid.top_botmVertexGrid.vertsVertexGrid.xyzcellcentersVertexGrid.xyzvertices