Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(typos): fixed a variety of typos throughout project #2160

Merged
merged 1 commit into from
Apr 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions autotest/regression/test_modflow.py
Original file line number Diff line number Diff line change
Expand Up @@ -394,14 +394,14 @@ def test_mf2005_lake(function_tmpdir, namfile, mf2005_test_path):

fn0 = join(ws, Path(namfile).name)

# write free format files - wont run without resetting to free format - evt external file issue
# write free format files - won't run without resetting to free format - evt external file issue
m.free_format_input = True

# rewrite files
model_ws2 = join(ws, "external")
m.change_model_ws(
model_ws2, reset_external=True
) # l1b2k_bath wont run without this
) # l1b2k_bath won't run without this
m.write_input()

success, buff = m.run_model()
Expand Down
2 changes: 1 addition & 1 deletion autotest/regression/test_swi2.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ def test_mf2005swi2(function_tmpdir, swi_path, namfile):
model_ws2 = os.path.join(ws, "flopy")
m.change_model_ws(
model_ws2, reset_external=True
) # l1b2k_bath wont run without this
) # l1b2k_bath won't run without this
m.write_input()

success, buff = m.run_model()
Expand Down
2 changes: 1 addition & 1 deletion autotest/test_lake_connections.py
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ def test_lake(function_tmpdir, example_data_path):
lakes.shape = idomain.shape
gwf.dis.idomain = np.where(lakes > -1, 1, idomain)

# convert to Newton-Raphson fomulation and update the linear accelerator
# convert to Newton-Raphson formulation and update the linear accelerator
gwf.name_file.newtonoptions = "NEWTON UNDER_RELAXATION"
sim.ims.linear_acceleration = "BICGSTAB"

Expand Down
2 changes: 1 addition & 1 deletion autotest/test_model_splitter.py
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ def test_control_records(function_tmpdir):

if spd_ls2["filename"] is None or not spd_ls2["binary"]:
raise AssertionError(
"External binary file input not being preseved for MFList"
"External binary file input not being preserved for MFList"
)


Expand Down
2 changes: 1 addition & 1 deletion autotest/test_modflow.py
Original file line number Diff line number Diff line change
Expand Up @@ -1047,7 +1047,7 @@ def test_oc_check():

ModflowDis(m)
oc.stress_period_data = {(0, 0): ["save head", "save budget"]}
chk = oc.check() # check passsed
chk = oc.check() # check passed
assert len(chk.summary_array) == 0, len(chk.summary_array)

oc.stress_period_data = {(0, 0): ["save"]}
Expand Down
2 changes: 1 addition & 1 deletion autotest/test_particledata.py
Original file line number Diff line number Diff line change
Expand Up @@ -674,7 +674,7 @@ def test_nodeparticledata_to_prp_disv_defaults(
mp7_rpts.sort()

# convert particle data to prt format, flatten (remove cell ID tuples),
# remove irpt as it is not gauranteed to match, and sort
# remove irpt as it is not guaranteed to match, and sort
prt_rpts = flatten(list(pdat.to_prp(grid)))
prt_rpts = [r[1:] for r in prt_rpts] #
prt_rpts.sort()
Expand Down
2 changes: 1 addition & 1 deletion autotest/test_specific_discharge.py
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ def basic_check(Qx_ext, Qy_ext, Qz_ext):


def local_balance_check(Qx_ext, Qy_ext, Qz_ext, hdsfile=None, model=None):
# calculate water blance at every cell
# calculate water balance at every cell
local_balance = (
Qx_ext[:, :, :-1]
- Qx_ext[:, :, 1:]
Expand Down
6 changes: 3 additions & 3 deletions flopy/discretization/grid.py
Original file line number Diff line number Diff line change
Expand Up @@ -803,7 +803,7 @@ def cross_section_nodeskip(self, nlay, xypts):

def cross_section_adjust_indicies(self, k, cbcnt):
"""
Method to get adjusted indicies by layer and confining bed
Method to get adjusted indices by layer and confining bed
for PlotCrossSection plotting

Parameters
Expand All @@ -826,8 +826,8 @@ def cross_section_set_contour_arrays(
self, plotarray, xcenters, head, elev, projpts
):
"""
Method to set countour array centers for rare instances where
matplotlib contouring is prefered over trimesh plotting
Method to set contour array centers for rare instances where
matplotlib contouring is preferred over trimesh plotting

Parameters
----------
Expand Down
8 changes: 4 additions & 4 deletions flopy/discretization/unstructuredgrid.py
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ def xyzcellcenters(self):
@property
def xyzvertices(self):
"""
Method to get model grid verticies
Method to get model grid vertices

Returns:
list of dimension ncpl by nvertices
Expand Down Expand Up @@ -442,7 +442,7 @@ def cross_section_nodeskip(self, nlay, xypts):

def cross_section_adjust_indicies(self, k, cbcnt):
"""
Method to get adjusted indicies by layer and confining bed
Method to get adjusted indices by layer and confining bed
for PlotCrossSection plotting

Parameters
Expand All @@ -463,8 +463,8 @@ def cross_section_set_contour_arrays(
self, plotarray, xcenters, head, elev, projpts
):
"""
Method to set countour array centers for rare instances where
matplotlib contouring is prefered over trimesh plotting
Method to set contour array centers for rare instances where
matplotlib contouring is preferred over trimesh plotting

Parameters
----------
Expand Down
20 changes: 10 additions & 10 deletions flopy/export/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -596,7 +596,7 @@ def model_export(
output format flag. 'vtk' will export to vtk
**kwargs : keyword arguments
modelgrid: flopy.discretization.Grid
user supplied modelgrid object which will supercede the built
user supplied modelgrid object which will supersede the built
in modelgrid object
crs : pyproj.CRS, int, str, optional if `prjfile` is specified
Coordinate reference system (CRS) for the model grid
Expand Down Expand Up @@ -687,9 +687,9 @@ def package_export(
package to export
fmt : str
output format flag. 'vtk' will export to vtk
** kwargs : keword arguments
** kwargs : keyword arguments
modelgrid: flopy.discretization.Grid
user supplied modelgrid object which will supercede the built
user supplied modelgrid object which will supersede the built
in modelgrid object
crs : pyproj.CRS, int, str, optional if `prjfile` is specified
Coordinate reference system (CRS) for the model grid
Expand Down Expand Up @@ -873,7 +873,7 @@ def mflist_export(f: Union[str, os.PathLike, NetCdf], mfl, **kwargs):
mfl : MfList instance
**kwargs : keyword arguments
modelgrid : flopy.discretization.Grid
model grid instance which will supercede the flopy.model.modelgrid
model grid instance which will supersede the flopy.model.modelgrid
crs : pyproj.CRS, int, str, optional if `prjfile` is specified
Coordinate reference system (CRS) for the model grid
(must be projected; geographic CRS are not supported).
Expand Down Expand Up @@ -1034,7 +1034,7 @@ def transient2d_export(f: Union[str, os.PathLike], t2d, fmt=None, **kwargs):
min_valid : minimum valid value
max_valid : maximum valid value
modelgrid : flopy.discretization.Grid
model grid instance which will supercede the flopy.model.modelgrid
model grid instance which will supersede the flopy.model.modelgrid
if fmt is set to 'vtk', parameters of Vtk initializer

"""
Expand Down Expand Up @@ -1194,7 +1194,7 @@ def array3d_export(f: Union[str, os.PathLike], u3d, fmt=None, **kwargs):
min_valid : minimum valid value
max_valid : maximum valid value
modelgrid : flopy.discretization.Grid
model grid instance which will supercede the flopy.model.modelgrid
model grid instance which will supersede the flopy.model.modelgrid
if fmt is set to 'vtk', parameters of Vtk initializer

"""
Expand Down Expand Up @@ -1372,7 +1372,7 @@ def array2d_export(
min_valid : minimum valid value
max_valid : maximum valid value
modelgrid : flopy.discretization.Grid
model grid instance which will supercede the flopy.model.modelgrid
model grid instance which will supersede the flopy.model.modelgrid
if fmt is set to 'vtk', parameters of Vtk initializer

"""
Expand Down Expand Up @@ -1525,9 +1525,9 @@ def export_array(
model grid
filename : str or PathLike
Path of output file. Export format is determined by
file extention.
file extension.
'.asc' Arc Ascii grid
'.tif' GeoTIFF (requries rasterio package)
'.tif' GeoTIFF (requires rasterio package)
'.shp' Shapefile
a : 2D numpy.ndarray
Array to export
Expand Down Expand Up @@ -1924,7 +1924,7 @@ def export_array_contours(
modelgrid : flopy.discretization.Grid object
model grid object
filename : str or PathLike
Path of output file with '.shp' extention.
Path of output file with '.shp' extension.
a : 2D numpy array
Array to contour
fieldname : str
Expand Down
16 changes: 8 additions & 8 deletions flopy/export/vtk.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,11 @@ class Vtk:
modelgrid : flopy.discretization.Grid object
any flopy modelgrid object, example. VertexGrid
vertical_exageration : float
floating point value to scale vertical exageration of the vtk points
floating point value to scale vertical exaggeration of the vtk points
default is 1.
binary : bool
flag that indicates if Vtk will write a binary or text file. Binary
is prefered as paraview has a bug (8/4/2021) where is cannot represent
is preferred as paraview has a bug (8/4/2021) where is cannot represent
NaN values from ASCII (non xml) files. In this case no-data values
are set to 1e+30.
xml : bool
Expand All @@ -121,7 +121,7 @@ class Vtk:
boolean flag to interpolate vertex elevations based on shared cell
elevations. Default is False.
point_scalars : bool
boolen flag to write interpolated data at each point based "shared
boolean flag to write interpolated data at each point based "shared
vertices".

"""
Expand Down Expand Up @@ -184,7 +184,7 @@ def __init__(

self.nvpl = nvpl

# method to accomodate DISU grids, do not use modelgrid.ncpl!
# method to accommodate DISU grids, do not use modelgrid.ncpl!
self.ncpl = len(self.iverts)
if self.nnodes == len(self.iverts):
self.nlay = 1
Expand Down Expand Up @@ -521,7 +521,7 @@ def _build_hfbs(self, pkg):
mf6 = False
hfb_data = pkg.hfb_data
else:
# asssume that there is no transient hfb data for now
# assume that there is no transient hfb data for now
hfb_data = pkg.stress_period_data.array[0]
mf6 = True

Expand Down Expand Up @@ -792,7 +792,7 @@ def add_transient_array(self, d, name=None, masked_values=None):
if self.__transient_output_data:
raise AssertionError(
"Transient arrays cannot be mixed with transient output, "
"Please create a seperate vtk object for transient package "
"Please create a separate vtk object for transient package "
"data"
)

Expand Down Expand Up @@ -1206,7 +1206,7 @@ def add_heads(self, hds, kstpkper=None, masked_values=None):
if not self.__transient_output_data and self.__transient_data:
raise AssertionError(
"Head data cannot be mixed with transient package data, "
"Please create a seperate vtk object for transient head data"
"Please create a separate vtk object for transient head data"
)

if kstpkper is None:
Expand Down Expand Up @@ -1256,7 +1256,7 @@ def add_cell_budget(
if not self.__transient_output_data and self.__transient_data:
raise AssertionError(
"Binary data cannot be mixed with transient package data, "
"Please create a seperate vtk object for transient head data"
"Please create a separate vtk object for transient head data"
)

records = cbc.get_unique_record_names(decode=True)
Expand Down
2 changes: 1 addition & 1 deletion flopy/mf6/data/mfdatautil.py
Original file line number Diff line number Diff line change
Expand Up @@ -966,7 +966,7 @@ def dtype(
"Data dimensions can not be determined for "
"{}. Data structure may be jagged or may contain "
"a keystring. Data type information is therefore "
"dependant on the data and can not be retreived "
"dependent on the data and can not be retrieved "
"prior to the data being loaded"
".".format(data_storage.data_dimensions.structure.name)
)
Expand Down
2 changes: 1 addition & 1 deletion flopy/mf6/data/mfstructure.py
Original file line number Diff line number Diff line change
Expand Up @@ -2070,7 +2070,7 @@ def get_all_recarrays(self):

class MFInputFileStructure:
"""
MODFLOW Input File Stucture class. Loads file
MODFLOW Input File Structure class. Loads file
structure information for individual input file
types.

Expand Down
2 changes: 1 addition & 1 deletion flopy/mf6/mfmodel.py
Original file line number Diff line number Diff line change
Expand Up @@ -697,7 +697,7 @@ def export(self, f, **kwargs):
or dictionary of ....
**kwargs : keyword arguments
modelgrid: flopy.discretization.Grid
User supplied modelgrid object which will supercede the built
User supplied modelgrid object which will supersede the built
in modelgrid object
if fmt is set to 'vtk', parameters of Vtk initializer

Expand Down
2 changes: 1 addition & 1 deletion flopy/mf6/mfpackage.py
Original file line number Diff line number Diff line change
Expand Up @@ -1591,7 +1591,7 @@ def _write_block(self, fd, block_header, ext_file_action):
fd.write("\n")

def is_allowed(self):
"""Determine if block is valid based on the values of dependant
"""Determine if block is valid based on the values of dependent
MODFLOW variables."""
if self.structure.variable_dependant_path:
# fill in empty part of the path with the current path
Expand Down
2 changes: 1 addition & 1 deletion flopy/mf6/utils/binaryfile_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ def _querybinarydata_unstructured(self, key):
return data

def _get_binary_file_object(self, path, bintype, key):
# simple method that trys to open the binary file object using Flopy
# simple method that tries to open the binary file object using Flopy
if bintype == "CBC":
try:
return bf.CellBudgetFile(path, precision="double")
Expand Down
2 changes: 1 addition & 1 deletion flopy/mf6/utils/createpackages.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
"parent package type", MFPackage, MFModel, and MFSimulation. If a package
supports multiple types of parents (for example, it can be either in the model
namefile or in a package, like the obs package), include all the types
supported, seperating each type with a / (MFPackage/MFModel).
supported, separating each type with a / (MFPackage/MFModel).

To create a new type of model choose a unique three letter model abbreviation
("gwf", "gwt", ...). Create a name file dfn with the naming convention
Expand Down
6 changes: 3 additions & 3 deletions flopy/mf6/utils/mfobservation.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class MFObservation:
-------
mfdict: (dict) the sim.simulation_dict.mfdict object for the flopy project
path: (object) the path object detailing model names and paths
key: (tuple, stings) user supplied dictionary key to request observation
key: (tuple, strings) user supplied dictionary key to request observation
utility data

Returns:
Expand Down Expand Up @@ -55,7 +55,7 @@ class Observations:

Input:
------
fi = (sting) name of the observation binary output file
fi = (string) name of the observation binary output file

Methods:
--------
Expand Down Expand Up @@ -197,7 +197,7 @@ def get_dataframe(

Parameters
----------
keys: (string) sting of dictionary/observation keys separated by comma.
keys: (string) string of dictionary/observation keys separated by comma.
(optional)
idx: (int) time index location (optional)
totim: (float) simulation time (optional)
Expand Down
4 changes: 2 additions & 2 deletions flopy/mf6/utils/model_splitter.py
Original file line number Diff line number Diff line change
Expand Up @@ -2663,7 +2663,7 @@ def _new_node_to_cellid(self, model, new_node, layers, idx):

def _remap_adv_tag(self, mkey, recarray, item, mapper):
"""
Method to remap advanced package ids such as SFR's ifno varaible
Method to remap advanced package ids such as SFR's ifno variable

Parameters
----------
Expand Down Expand Up @@ -3310,5 +3310,5 @@ def split_model(self, array):

# todo: development notes:
# Then set up checks for model splitting
# (ex. doesnt parallel a fault, doesnt cut through a lake,
# (ex. doesn't parallel a fault, doesn't cut through a lake,
# active cells in modelgrid...)
2 changes: 1 addition & 1 deletion flopy/mf6/utils/output_util.py
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ def __zonebudget(self, izone):

def __budgetcsv(self):
"""
Convience method to open and return a budget csv object
Convenience method to open and return a budget csv object

Returns
-------
Expand Down
2 changes: 1 addition & 1 deletion flopy/mfusg/mfusgcln.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Contains the MfUsgCln class. Note that the user can
access the MfUsgCln class as `flopy.mfusg.MfUsgCln`.

Compatible with USG-Transport Version 1.7.0. which can be downloade from
Compatible with USG-Transport Version 1.7.0. which can be download from
https://www.gsi-net.com/en/software/free-software/modflow-usg.html

Additional information for this MODFLOW package can be found at the `Online
Expand Down
2 changes: 1 addition & 1 deletion flopy/mfusg/mfusgdisu.py
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ class MfUsgDisU(Package):
expanded if CLN or GNC nodes exist in a simulation.
(default is None. cl1 and cl2 must be specified, or cl12 must be
specified)
fahl : float or arry of floats
fahl : float or array of floats
Area of the interface Anm between nodes n and m.
(default is None. fahl must be specified.)
perlen : float or array of floats (nper)
Expand Down
2 changes: 1 addition & 1 deletion flopy/mfusg/mfusggnc.py
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ def get_default_dtype(numalphaj, iflalphan):

@staticmethod
def get_empty(numgnc=0, numalphaj=1, iflalphan=0):
"""Returns empty GNC recarray of defualt dtype."""
"""Returns empty GNC recarray of default dtype."""
# get an empty recarray that corresponds to dtype
dtype = MfUsgGnc.get_default_dtype(numalphaj, iflalphan)
return create_empty_recarray(numgnc, dtype, default_value=-1.0e10)
Expand Down
Loading
Loading