flopy.utils package

Submodules

• flopy.utils.binaryfile module
  • BinaryHeader
    • BinaryHeader.create()
    • BinaryHeader.set_dtype()
    • BinaryHeader.set_values()
  • BinaryLayerFile
    • BinaryLayerFile.get_databytes()
    • BinaryLayerFile.get_ts()
  • BudgetIndexError
  • CellBudgetFile
    • CellBudgetFile.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()
  • HeadFile
  • HeadUFile
    • HeadUFile.get_databytes()
    • HeadUFile.get_ts()
  • UcnFile
  • binaryread()
  • binaryread_struct()
  • get_headfile_precision()
  • join_struct_arrays()
  • write_budget()
  • write_head()
• flopy.utils.check module
  • check
    • check.append_passed()
    • check.bc_stage_names
    • check.get_active()
    • check.get_neighbors()
    • check.isvalid()
    • check.package_check_levels
    • check.print_summary()
    • check.property_threshold_values
    • check.remove_passed()
    • check.solver_packages
    • check.stress_period_data_values()
    • check.summarize()
    • check.thin_cell_threshold
    • check.values()
    • check.view_summary_array_fields()
  • fields_view()
  • mf6check
    • mf6check.get_active()
• flopy.utils.compare module
  • compare()
  • compare_budget()
  • compare_concentrations()
  • compare_heads()
  • compare_stages()
  • compare_swrbudget()
  • eval_bud_diff()
• flopy.utils.crs module
  • get_authority_crs()
  • get_crs()
  • get_shapefile_crs()
• flopy.utils.cvfdutil module
  • Point
  • area_of_polygon()
  • centroid_of_polygon()
  • get_disv_gridprops()
  • gridlist_to_disv_gridprops()
  • gridlist_to_verts()
  • isBetween()
  • segment_face()
  • shapefile_to_cvfd()
  • shapefile_to_xcyc()
  • shared_face()
  • to_cvfd()
• flopy.utils.datafile module
  • Header
    • Header.get_dtype()
    • Header.get_names()
    • Header.get_values()
  • LayerFile
    • LayerFile.close()
    • LayerFile.get_alldata()
    • LayerFile.get_data()
    • LayerFile.get_kstpkper()
    • LayerFile.get_times()
    • LayerFile.list_records()
    • LayerFile.plot()
    • LayerFile.to_shapefile()
• flopy.utils.datautil module
  • ArrayIndexIter
  • ConstIter
  • DatumUtil
    • DatumUtil.is_basic_type()
    • DatumUtil.is_float()
    • DatumUtil.is_int()
  • FileIter
    • FileIter.close()
  • MultiList
    • MultiList.build_list()
    • MultiList.elements()
    • MultiList.first_index()
    • MultiList.first_item()
    • MultiList.get_total_size()
    • MultiList.in_shape()
    • MultiList.inc_shape_idx()
    • MultiList.increment_dimension()
    • MultiList.indexes()
    • MultiList.nth_index()
  • MultiListIter
  • NameIter
  • PathIter
  • PyListUtil
    • PyListUtil.save_array()
    • PyListUtil.array_comp()
    • PyListUtil.clean_numeric()
    • PyListUtil.consistent_delim
    • PyListUtil.delimiter_list
    • PyListUtil.delimiter_used
    • PyListUtil.first_item()
    • PyListUtil.has_one_item()
    • PyListUtil.is_empty_list()
    • PyListUtil.is_iterable()
    • PyListUtil.line_num
    • PyListUtil.max_multi_dim_list_size()
    • PyListUtil.next_item()
    • PyListUtil.next_list()
    • PyListUtil.numeric_chars
    • PyListUtil.quote_list
    • PyListUtil.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
  • flux_to_wel()
  • get_next_line()
  • get_ts_sp()
  • get_url_text()
  • line_parse()
  • line_strip()
  • loadtxt()
  • multi_line_strip()
  • pop_item()
  • read_fixed_var()
  • relpath_safe()
  • scrub_login()
  • ulstrd()
  • write_fixed_var()
• flopy.utils.formattedfile module
  • FormattedHeadFile
  • FormattedHeader
    • FormattedHeader.read_header()
  • FormattedLayerFile
    • FormattedLayerFile.close()
    • FormattedLayerFile.get_ts()
  • is_float()
  • is_int()
• flopy.utils.geometry module
  • Collection
    • Collection.bounds
    • Collection.plot()
  • LineString
    • LineString.bounds
    • LineString.has_z
    • LineString.plot()
    • LineString.pyshp_parts
    • LineString.shapeType
    • LineString.type
    • LineString.x
    • LineString.y
    • LineString.z
  • MultiLineString
  • MultiPoint
  • MultiPolygon
  • Point
    • Point.bounds
    • Point.has_z
    • Point.plot()
    • Point.pyshp_parts
    • Point.shapeType
    • Point.type
    • Point.x
    • Point.y
    • Point.z
  • Polygon
    • Polygon.bounds
    • Polygon.get_patch()
    • Polygon.patch
    • Polygon.plot()
    • Polygon.pyshp_parts
    • Polygon.shapeType
    • Polygon.type
  • Shape
    • Shape.from_geojson()
    • Shape.geojson
  • get_polygon_area()
  • get_polygon_centroid()
  • is_clockwise()
  • point_in_polygon()
  • project_point_onto_xc_line()
  • rotate()
  • transform()
• flopy.utils.geospatial_utils module
  • GeoSpatialCollection
    • GeoSpatialCollection.flopy_geometry
    • GeoSpatialCollection.geojson
    • GeoSpatialCollection.points
    • GeoSpatialCollection.shape
    • GeoSpatialCollection.shapely
    • GeoSpatialCollection.shapetype
  • GeoSpatialUtil
    • GeoSpatialUtil.flopy_geometry
    • GeoSpatialUtil.geojson
    • GeoSpatialUtil.points
    • GeoSpatialUtil.shape
    • GeoSpatialUtil.shapely
    • GeoSpatialUtil.shapetype
• flopy.utils.get_modflow module
  • run_main()
• flopy.utils.gridgen module
  • Gridgen
    • Gridgen.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
  • GridIntersect
    • GridIntersect.filter_query_result()
    • GridIntersect.intersect()
    • GridIntersect.intersects()
    • GridIntersect.plot_linestring()
    • GridIntersect.plot_point()
    • GridIntersect.plot_polygon()
    • GridIntersect.query_grid()
    • GridIntersect.sort_gridshapes()
  • ModflowGridIndices
    • ModflowGridIndices.find_position_in_array()
    • ModflowGridIndices.kij_from_nn0()
    • ModflowGridIndices.kij_from_nodenumber()
    • ModflowGridIndices.nn0_from_kij()
    • ModflowGridIndices.nodenumber_from_kij()
  • ignore_shapely2_strtree_warning()
  • ignore_shapely_warnings_for_object_array()
  • parse_shapely_ix_result()
• flopy.utils.gridutil module
  • get_disu_kwargs()
  • get_lni()
  • uniform_flow_field()
• flopy.utils.lgrutil module
  • Lgr
    • Lgr.child
    • Lgr.get_delr_delc()
    • Lgr.get_exchange_data()
    • Lgr.get_idomain()
    • Lgr.get_lower_left()
    • Lgr.get_parent_connections()
    • Lgr.get_parent_indices()
    • Lgr.get_replicated_parent_array()
    • Lgr.get_shape()
    • Lgr.get_top_botm()
    • Lgr.parent
  • SimpleRegularGrid
    • SimpleRegularGrid.get_gridprops_dis6()
    • SimpleRegularGrid.modelgrid
• flopy.utils.mflistfile module
  • ListBudget
    • ListBudget.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()
  • Mf6ListBudget
    • Mf6ListBudget.set_budget_key()
  • MfListBudget
    • MfListBudget.set_budget_key()
  • MfusgListBudget
    • MfusgListBudget.set_budget_key()
  • SwrListBudget
    • SwrListBudget.set_budget_key()
  • SwtListBudget
    • SwtListBudget.set_budget_key()
• flopy.utils.mfreadnam module
  • NamData
    • NamData.filehandle
    • NamData.filename
    • NamData.filetype
    • NamData.package
  • attribs_from_namfile_header()
  • get_entries_from_namefile()
  • get_input_files()
  • get_mf6_blockdata()
  • get_mf6_files()
  • get_mf6_ftypes()
  • get_mf6_mshape()
  • get_mf6_nper()
  • get_sim_name()
  • getfiletypeunit()
  • parsenamefile()
• flopy.utils.modpathfile module
  • EndpointFile
    • EndpointFile.get_alldata()
    • EndpointFile.get_data()
    • EndpointFile.get_destination_endpoint_data()
    • EndpointFile.get_maxid()
    • EndpointFile.get_maxtime()
    • EndpointFile.get_maxtraveltime()
    • EndpointFile.kijnames
    • EndpointFile.write_shapefile()
  • PathlineFile
    • PathlineFile.get_alldata()
    • PathlineFile.get_data()
    • PathlineFile.get_destination_pathline_data()
    • PathlineFile.get_maxid()
    • PathlineFile.get_maxtime()
    • PathlineFile.kijnames
    • PathlineFile.write_shapefile()
  • TimeseriesFile
    • TimeseriesFile.get_alldata()
    • TimeseriesFile.get_data()
    • TimeseriesFile.get_destination_timeseries_data()
    • TimeseriesFile.get_maxid()
    • TimeseriesFile.get_maxtime()
    • TimeseriesFile.kijnames
    • TimeseriesFile.write_shapefile()
• flopy.utils.mtlistfile module
  • MtListBudget
    • MtListBudget.parse()
• flopy.utils.observationfile module
  • CsvFile
    • CsvFile.nobs
    • CsvFile.obsnames
    • CsvFile.read_csv()
  • HydmodObs
  • Mf6Obs
  • ObsFiles
    • ObsFiles.get_data()
    • ObsFiles.get_dataframe()
    • ObsFiles.get_nobs()
    • ObsFiles.get_ntimes()
    • ObsFiles.get_obsnames()
    • ObsFiles.get_times()
  • SwrObs
  • get_reduced_pumping()
  • get_selection()
• flopy.utils.optionblock module
  • OptionBlock
    • OptionBlock.dtype
    • OptionBlock.load_options()
    • OptionBlock.n_nested
    • OptionBlock.nested
    • OptionBlock.optional
    • OptionBlock.simple_flag
    • OptionBlock.simple_float
    • OptionBlock.simple_int
    • OptionBlock.simple_str
    • OptionBlock.simple_tabfile
    • OptionBlock.single_line_options
    • OptionBlock.update_from_package()
    • OptionBlock.vars
    • OptionBlock.write_options()
  • OptionUtil
    • OptionUtil.isfloat()
    • OptionUtil.isint()
    • OptionUtil.isvalid()
• flopy.utils.parse_version module
  • InvalidVersion
  • LegacyVersion
    • LegacyVersion.base_version
    • LegacyVersion.dev
    • LegacyVersion.epoch
    • LegacyVersion.is_devrelease
    • LegacyVersion.is_postrelease
    • LegacyVersion.is_prerelease
    • LegacyVersion.local
    • LegacyVersion.post
    • LegacyVersion.pre
    • LegacyVersion.public
    • LegacyVersion.release
  • Version
    • Version.base_version
    • Version.dev
    • Version.epoch
    • Version.is_devrelease
    • Version.is_postrelease
    • Version.is_prerelease
    • Version.local
    • Version.major
    • Version.micro
    • Version.minor
    • Version.post
    • Version.pre
    • Version.public
    • Version.release
  • parse()
• flopy.utils.postprocessing module
  • get_extended_budget()
  • get_gradients()
  • get_specific_discharge()
  • get_transmissivities()
  • get_water_table()
• flopy.utils.rasters module
  • Raster
    • Raster.FLOAT32
    • Raster.FLOAT64
    • Raster.INT16
    • Raster.INT32
    • Raster.INT64
    • Raster.INT8
    • Raster.bands
    • Raster.bounds
    • Raster.crop()
    • Raster.get_array()
    • Raster.histogram()
    • Raster.load()
    • Raster.nodatavals
    • Raster.plot()
    • Raster.resample_to_grid()
    • Raster.sample_point()
    • Raster.sample_polygon()
    • Raster.write()
    • Raster.xcenters
    • Raster.ycenters
• flopy.utils.recarray_utils module
  • create_empty_recarray()
  • ra_slice()
  • recarray()
• flopy.utils.reference module
  • TemporalReference
    • TemporalReference.defaults
    • TemporalReference.itmuni_text
    • TemporalReference.itmuni_values
    • TemporalReference.model_time_units
• flopy.utils.sfroutputfile module
  • SfrFile
    • SfrFile.df
    • SfrFile.dtypes
    • SfrFile.get_dataframe()
    • SfrFile.get_nstrm()
    • SfrFile.get_results()
    • SfrFile.get_times()
• flopy.utils.swroutputfile module
  • SwrBudget
  • SwrExchange
  • SwrFile
    • SwrFile.get_connectivity()
    • SwrFile.get_data()
    • SwrFile.get_kswrkstpkper()
    • SwrFile.get_nrecords()
    • SwrFile.get_ntimes()
    • SwrFile.get_record_names()
    • SwrFile.get_times()
    • SwrFile.get_ts()
  • SwrFlow
  • SwrStage
  • SwrStructure
• flopy.utils.triangle module
  • Triangle
    • Triangle.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
  • ArrayFormat
    • ArrayFormat.fortran
    • ArrayFormat.py
    • ArrayFormat.numpy
    • ArrayFormat.npl
    • ArrayFormat.width
    • ArrayFormat.decimal
    • ArrayFormat.format
    • ArrayFormat.free
    • ArrayFormat.binary
    • ArrayFormat.array_free_format
    • ArrayFormat.binary
    • ArrayFormat.decimal
    • ArrayFormat.decode_fortran_descriptor()
    • ArrayFormat.float()
    • ArrayFormat.format
    • ArrayFormat.fortran
    • ArrayFormat.free
    • ArrayFormat.get_default_numpy_fmt()
    • ArrayFormat.integer()
    • ArrayFormat.npl
    • ArrayFormat.numpy
    • ArrayFormat.py
    • ArrayFormat.width
  • Transient2d
    • Transient2d.transient_2ds
    • Transient2d.array
    • Transient2d.build_transient_sequence()
    • Transient2d.data_type
    • Transient2d.dtype
    • Transient2d.export()
    • Transient2d.from_4d()
    • Transient2d.get_kper_entry()
    • Transient2d.get_zero_2d()
    • Transient2d.masked4d_array_to_kper_dict()
    • Transient2d.model
    • Transient2d.name
    • Transient2d.plot()
    • Transient2d.plottable
  • Transient3d
    • Transient3d.transient_3ds
    • Transient3d.array
    • Transient3d.build_transient_sequence()
    • Transient3d.data_type
    • Transient3d.dtype
    • Transient3d.get_kper_entry()
    • Transient3d.get_zero_3d()
    • Transient3d.model
    • Transient3d.name
    • Transient3d.plottable
  • Util2d
    • Util2d.array
    • Util2d.how
    • Util2d.format
    • Util2d.all()
    • Util2d.array
    • Util2d.array2string()
    • Util2d.cnstnt_str
    • Util2d.data_type
    • Util2d.dtype
    • Util2d.export()
    • Util2d.filename
    • Util2d.format
    • Util2d.get_constant_cr()
    • Util2d.get_external_cr()
    • Util2d.get_file_entry()
    • Util2d.get_internal_cr()
    • Util2d.get_openclose_cr()
    • Util2d.get_value()
    • Util2d.how
    • Util2d.load()
    • Util2d.load_bin()
    • Util2d.load_block()
    • Util2d.load_txt()
    • Util2d.model
    • Util2d.model_file_path
    • Util2d.name
    • Util2d.parse_control_record()
    • Util2d.parse_value()
    • Util2d.plot()
    • Util2d.plottable
    • Util2d.python_file_path
    • Util2d.set_fmtin()
    • Util2d.string
    • Util2d.sum()
    • Util2d.unique()
    • Util2d.vtype
    • Util2d.write_bin()
    • Util2d.write_txt()
  • Util3d
    • Util3d.array
    • Util3d.array
    • Util3d.build_2d_instances()
    • Util3d.data_type
    • Util3d.dtype
    • Util3d.export()
    • Util3d.get_file_entry()
    • Util3d.get_value()
    • Util3d.load()
    • Util3d.model
    • Util3d.name
    • Util3d.plot()
    • Util3d.plottable
  • new_u2d()
  • read1d()
• flopy.utils.util_list module
  • MfList
    • MfList.mxact
    • MfList.add_record()
    • MfList.append()
    • MfList.array
    • MfList.attribute_by_kper()
    • MfList.binary
    • MfList.check_kij()
    • MfList.data
    • MfList.data_type
    • MfList.df
    • MfList.drop()
    • MfList.dtype
    • MfList.export()
    • MfList.fmt_string
    • MfList.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_arrays
    • MfList.masked_4D_arrays_itr()
    • MfList.mg
    • MfList.model
    • MfList.mxact
    • MfList.name
    • MfList.package
    • MfList.plot()
    • MfList.plottable
    • MfList.to_array()
    • MfList.to_shapefile()
    • MfList.vtype
    • MfList.write_transient()
• flopy.utils.utils_def module
  • FlopyBinaryData
    • FlopyBinaryData.read_integer()
    • FlopyBinaryData.read_real()
    • FlopyBinaryData.read_record()
    • FlopyBinaryData.read_text()
    • FlopyBinaryData.set_float()
  • get_dis()
  • get_open_file_object()
  • get_pak_vals_shape()
  • get_unitnumber_from_ext_unit_dict()
  • get_util2d_shape_for_layer()
  • totim_to_datetime()
  • type_from_iterable()
• flopy.utils.utl_import module
  • get_version()
  • import_optional_dependency()
• flopy.utils.voronoi module
  • VoronoiGrid
    • VoronoiGrid.get_disu5_gridprops()
    • VoronoiGrid.get_disu6_gridprops()
    • VoronoiGrid.get_disv_gridprops()
    • VoronoiGrid.get_gridprops_unstructuredgrid()
    • VoronoiGrid.get_gridprops_vertexgrid()
    • VoronoiGrid.get_patch_collection()
    • VoronoiGrid.plot()
  • get_sorted_vertices()
  • get_valid_faces()
  • point_in_cell()
  • sort_vertices()
  • tri2vor()
• flopy.utils.zonbud module
  • ZBNetOutput
  • ZoneBudget
    • ZoneBudget.copy()
    • ZoneBudget.export()
    • ZoneBudget.get_budget()
    • ZoneBudget.get_dataframes()
    • ZoneBudget.get_model_shape()
    • ZoneBudget.get_record_names()
    • ZoneBudget.get_volumetric_budget()
    • ZoneBudget.read_output()
    • ZoneBudget.read_zone_file()
    • ZoneBudget.to_csv()
    • ZoneBudget.write_zone_file()
  • ZoneBudget6
    • ZoneBudget6.add_package()
    • ZoneBudget6.change_model_name()
    • ZoneBudget6.change_model_ws()
    • ZoneBudget6.export()
    • ZoneBudget6.get_budget()
    • ZoneBudget6.get_dataframes()
    • ZoneBudget6.get_volumetric_budget()
    • ZoneBudget6.load()
    • ZoneBudget6.run_model()
    • ZoneBudget6.write_input()
  • ZoneFile6
    • ZoneFile6.load()
    • ZoneFile6.ncells
    • ZoneFile6.write_input()
  • dataframe_to_netcdf_fmt()
  • sort_tuple()
  • sum_flux_tuples()

Module contents

the main entry point of utils

Notes

Examples