Skip to content

Commit

Permalink
Fix typos (#37)
Browse files Browse the repository at this point in the history
  • Loading branch information
mwtoews authored Nov 13, 2024
1 parent 2d0223a commit 5bde5f4
Show file tree
Hide file tree
Showing 13 changed files with 52 additions and 52 deletions.
12 changes: 6 additions & 6 deletions docs/helpers.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ <h1 class="title">Module <code>pypestutils.helpers</code></h1>
return {&#34;all_results&#34;:allresults_df,&#34;interpolated_results&#34;:obsdf}

def get_grid_info_from_gridspec(gridspec_fname: str) -&gt; dict:
&#34;&#34;&#34;Read structured grid info from a PEST-style grid specificatin file
&#34;&#34;&#34;Read structured grid info from a PEST-style grid specification file
Parameters
----------
gridspec_fname : str
Expand Down Expand Up @@ -728,7 +728,7 @@ <h1 class="title">Module <code>pypestutils.helpers</code></h1>
the zone array
varioaniso: float or numpy.ndarray
the variogram anisotropy ratio. Either a scalar or array of shape nnodes.
variobearing: flaot or numpy.ndarray
variobearing: float or numpy.ndarray
the variogram anisotropy bearing. Either a scalar or array of shape nnodes
random_seed: int
the random seed. Default is 12345
Expand Down Expand Up @@ -1225,7 +1225,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
<dt><strong><code>varioaniso</code></strong> :&ensp;<code>float</code> or <code>numpy.ndarray</code></dt>
<dd>the variogram anisotropy ratio.
Either a scalar or array of shape nnodes.</dd>
<dt><strong><code>variobearing</code></strong> :&ensp;<code>flaot</code> or <code>numpy.ndarray</code></dt>
<dt><strong><code>variobearing</code></strong> :&ensp;<code>float</code> or <code>numpy.ndarray</code></dt>
<dd>the variogram anisotropy bearing.
Either a scalar or array of shape nnodes</dd>
<dt><strong><code>random_seed</code></strong> :&ensp;<code>int</code></dt>
Expand Down Expand Up @@ -1283,7 +1283,7 @@ <h2 id="returns">Returns</h2>
the zone array
varioaniso: float or numpy.ndarray
the variogram anisotropy ratio. Either a scalar or array of shape nnodes.
variobearing: flaot or numpy.ndarray
variobearing: float or numpy.ndarray
the variogram anisotropy bearing. Either a scalar or array of shape nnodes
random_seed: int
the random seed. Default is 12345
Expand Down Expand Up @@ -1643,7 +1643,7 @@ <h2 id="returns">Returns</h2>
<span>def <span class="ident">get_grid_info_from_gridspec</span></span>(<span>gridspec_fname: str) ‑> dict</span>
</code></dt>
<dd>
<div class="desc"><p>Read structured grid info from a PEST-style grid specificatin file
<div class="desc"><p>Read structured grid info from a PEST-style grid specification file
Parameters</p>
<hr>
<dl>
Expand All @@ -1660,7 +1660,7 @@ <h2 id="returns">Returns</h2>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_grid_info_from_gridspec(gridspec_fname: str) -&gt; dict:
&#34;&#34;&#34;Read structured grid info from a PEST-style grid specificatin file
&#34;&#34;&#34;Read structured grid info from a PEST-style grid specification file
Parameters
----------
gridspec_fname : str
Expand Down
40 changes: 20 additions & 20 deletions docs/pestutilslib.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ <h1 class="title">Module <code>pypestutils.pestutilslib</code></h1>
# self.logger.warning(&#34;cannot call __del__: %s&#34;, err)

def create_char_array(self, init: str | bytes, name: str):
&#34;&#34;&#34;Create c_char Array with a fixed size from dimvar and intial value.
&#34;&#34;&#34;Create c_char Array with a fixed size from dimvar and initial value.

Parameters
----------
Expand Down Expand Up @@ -1121,7 +1121,7 @@ <h1 class="title">Module <code>pypestutils.pestutilslib</code></h1>
krigtype : int, str, or enum.KrigType,
Kriging type, where 0:simple, 1:ordinary.
transtype : int, str, enum.TransType
Tranformation type, where 0 is none and 1 is log.
Transformation type, where 0 is none and 1 is log.
sourceval : array_like
Values at sources, 1D array with shape (npts,).
meanval : float, array_like, optional
Expand Down Expand Up @@ -1434,7 +1434,7 @@ <h1 class="title">Module <code>pypestutils.pestutilslib</code></h1>
factorfiletype : int, str or enum.FactorFileType
Factor file type, where 0:binary, 1:text.
transtype : int, str, enum.TransType
Tranformation type, where 0 is none and 1 is log.
Transformation type, where 0 is none and 1 is log.
lt_target, gt_target : str or bool
Whether to undercut or exceed target, use &#34;Y&#34;/&#34;N&#34; or bool.
sourceval : array_like
Expand Down Expand Up @@ -1516,7 +1516,7 @@ <h1 class="title">Module <code>pypestutils.pestutilslib</code></h1>
znt : int or array_like
Target point zones, integer or 1D array with shape (mpts,).
transtype : int, str, enum.TransType
Tranformation type, where 0 is none and 1 is log.
Transformation type, where 0 is none and 1 is log.
anis : float or array_like
Local anisotropy, float or 1D array with shape (mpts,).
bearing : float or array_like
Expand Down Expand Up @@ -1600,7 +1600,7 @@ <h1 class="title">Module <code>pypestutils.pestutilslib</code></h1>
znt : int or array_like
Target point zones, integer or 1D array with shape (mpts,).
transtype : int, str, enum.TransType
Tranformation type, where 0 is none and 1 is log.
Transformation type, where 0 is none and 1 is log.
ahmax, ahmin, avert : float or array_like
Relative correlation lengths, float or 1D array with shape (mpts,).
bearing, dip, rake : float or array_like
Expand Down Expand Up @@ -1933,7 +1933,7 @@ <h2 id="parameters">Parameters</h2>
# self.logger.warning(&#34;cannot call __del__: %s&#34;, err)

def create_char_array(self, init: str | bytes, name: str):
&#34;&#34;&#34;Create c_char Array with a fixed size from dimvar and intial value.
&#34;&#34;&#34;Create c_char Array with a fixed size from dimvar and initial value.

Parameters
----------
Expand Down Expand Up @@ -2978,7 +2978,7 @@ <h2 id="parameters">Parameters</h2>
krigtype : int, str, or enum.KrigType,
Kriging type, where 0:simple, 1:ordinary.
transtype : int, str, enum.TransType
Tranformation type, where 0 is none and 1 is log.
Transformation type, where 0 is none and 1 is log.
sourceval : array_like
Values at sources, 1D array with shape (npts,).
meanval : float, array_like, optional
Expand Down Expand Up @@ -3291,7 +3291,7 @@ <h2 id="parameters">Parameters</h2>
factorfiletype : int, str or enum.FactorFileType
Factor file type, where 0:binary, 1:text.
transtype : int, str, enum.TransType
Tranformation type, where 0 is none and 1 is log.
Transformation type, where 0 is none and 1 is log.
lt_target, gt_target : str or bool
Whether to undercut or exceed target, use &#34;Y&#34;/&#34;N&#34; or bool.
sourceval : array_like
Expand Down Expand Up @@ -3373,7 +3373,7 @@ <h2 id="parameters">Parameters</h2>
znt : int or array_like
Target point zones, integer or 1D array with shape (mpts,).
transtype : int, str, enum.TransType
Tranformation type, where 0 is none and 1 is log.
Transformation type, where 0 is none and 1 is log.
anis : float or array_like
Local anisotropy, float or 1D array with shape (mpts,).
bearing : float or array_like
Expand Down Expand Up @@ -3457,7 +3457,7 @@ <h2 id="parameters">Parameters</h2>
znt : int or array_like
Target point zones, integer or 1D array with shape (mpts,).
transtype : int, str, enum.TransType
Tranformation type, where 0 is none and 1 is log.
Transformation type, where 0 is none and 1 is log.
ahmax, ahmin, avert : float or array_like
Relative correlation lengths, float or 1D array with shape (mpts,).
bearing, dip, rake : float or array_like
Expand Down Expand Up @@ -4602,7 +4602,7 @@ <h2 id="returns">Returns</h2>
<span>def <span class="ident">create_char_array</span></span>(<span>self, init: str | bytes, name: str)</span>
</code></dt>
<dd>
<div class="desc"><p>Create c_char Array with a fixed size from dimvar and intial value.</p>
<div class="desc"><p>Create c_char Array with a fixed size from dimvar and initial value.</p>
<h2 id="parameters">Parameters</h2>
<dl>
<dt><strong><code>init</code></strong> :&ensp;<code>str</code> or <code>bytes</code></dt>
Expand All @@ -4615,7 +4615,7 @@ <h2 id="parameters">Parameters</h2>
<span>Expand source code</span>
</summary>
<pre><code class="python">def create_char_array(self, init: str | bytes, name: str):
&#34;&#34;&#34;Create c_char Array with a fixed size from dimvar and intial value.
&#34;&#34;&#34;Create c_char Array with a fixed size from dimvar and initial value.

Parameters
----------
Expand Down Expand Up @@ -5865,7 +5865,7 @@ <h2 id="parameters">Parameters</h2>
<dt><strong><code>factorfiletype</code></strong> :&ensp;<code>int, str</code> or <code>enum.FactorFileType</code></dt>
<dd>Factor file type, where 0:binary, 1:text.</dd>
<dt><strong><code>transtype</code></strong> :&ensp;<code>int, str, enum.TransType</code></dt>
<dd>Tranformation type, where 0 is none and 1 is log.</dd>
<dd>Transformation type, where 0 is none and 1 is log.</dd>
<dt><strong><code>lt_target</code></strong>, <strong><code>gt_target</code></strong> :&ensp;<code>str</code> or <code>bool</code></dt>
<dd>Whether to undercut or exceed target, use "Y"/"N" or bool.</dd>
<dt><strong><code>sourceval</code></strong> :&ensp;<code>array_like</code></dt>
Expand Down Expand Up @@ -5906,7 +5906,7 @@ <h2 id="returns">Returns</h2>
factorfiletype : int, str or enum.FactorFileType
Factor file type, where 0:binary, 1:text.
transtype : int, str, enum.TransType
Tranformation type, where 0 is none and 1 is log.
Transformation type, where 0 is none and 1 is log.
lt_target, gt_target : str or bool
Whether to undercut or exceed target, use &#34;Y&#34;/&#34;N&#34; or bool.
sourceval : array_like
Expand Down Expand Up @@ -5976,7 +5976,7 @@ <h2 id="parameters">Parameters</h2>
<dt><strong><code>znt</code></strong> :&ensp;<code>int</code> or <code>array_like</code></dt>
<dd>Target point zones, integer or 1D array with shape (mpts,).</dd>
<dt><strong><code>transtype</code></strong> :&ensp;<code>int, str, enum.TransType</code></dt>
<dd>Tranformation type, where 0 is none and 1 is log.</dd>
<dd>Transformation type, where 0 is none and 1 is log.</dd>
<dt><strong><code>anis</code></strong> :&ensp;<code>float</code> or <code>array_like</code></dt>
<dd>Local anisotropy, float or 1D array with shape (mpts,).</dd>
<dt><strong><code>bearing</code></strong> :&ensp;<code>float</code> or <code>array_like</code></dt>
Expand Down Expand Up @@ -6024,7 +6024,7 @@ <h2 id="returns">Returns</h2>
znt : int or array_like
Target point zones, integer or 1D array with shape (mpts,).
transtype : int, str, enum.TransType
Tranformation type, where 0 is none and 1 is log.
Transformation type, where 0 is none and 1 is log.
anis : float or array_like
Local anisotropy, float or 1D array with shape (mpts,).
bearing : float or array_like
Expand Down Expand Up @@ -6090,7 +6090,7 @@ <h2 id="parameters">Parameters</h2>
<dt><strong><code>znt</code></strong> :&ensp;<code>int</code> or <code>array_like</code></dt>
<dd>Target point zones, integer or 1D array with shape (mpts,).</dd>
<dt><strong><code>transtype</code></strong> :&ensp;<code>int, str, enum.TransType</code></dt>
<dd>Tranformation type, where 0 is none and 1 is log.</dd>
<dd>Transformation type, where 0 is none and 1 is log.</dd>
<dt><strong><code>ahmax</code></strong>, <strong><code>ahmin</code></strong>, <strong><code>avert</code></strong> :&ensp;<code>float</code> or <code>array_like</code></dt>
<dd>Relative correlation lengths, float or 1D array with shape (mpts,).</dd>
<dt><strong><code>bearing</code></strong>, <strong><code>dip</code></strong>, <strong><code>rake</code></strong> :&ensp;<code>float</code> or <code>array_like</code></dt>
Expand Down Expand Up @@ -6144,7 +6144,7 @@ <h2 id="returns">Returns</h2>
znt : int or array_like
Target point zones, integer or 1D array with shape (mpts,).
transtype : int, str, enum.TransType
Tranformation type, where 0 is none and 1 is log.
Transformation type, where 0 is none and 1 is log.
ahmax, ahmin, avert : float or array_like
Relative correlation lengths, float or 1D array with shape (mpts,).
bearing, dip, rake : float or array_like
Expand Down Expand Up @@ -6223,7 +6223,7 @@ <h2 id="parameters">Parameters</h2>
<dt><strong><code>krigtype</code></strong> :&ensp;<code>int, str,</code> or <code>enum.KrigType,</code></dt>
<dd>Kriging type, where 0:simple, 1:ordinary.</dd>
<dt><strong><code>transtype</code></strong> :&ensp;<code>int, str, enum.TransType</code></dt>
<dd>Tranformation type, where 0 is none and 1 is log.</dd>
<dd>Transformation type, where 0 is none and 1 is log.</dd>
<dt><strong><code>sourceval</code></strong> :&ensp;<code>array_like</code></dt>
<dd>Values at sources, 1D array with shape (npts,).</dd>
<dt><strong><code>meanval</code></strong> :&ensp;<code>float, array_like</code>, optional</dt>
Expand Down Expand Up @@ -6269,7 +6269,7 @@ <h2 id="returns">Returns</h2>
krigtype : int, str, or enum.KrigType,
Kriging type, where 0:simple, 1:ordinary.
transtype : int, str, enum.TransType
Tranformation type, where 0 is none and 1 is log.
Transformation type, where 0 is none and 1 is log.
sourceval : array_like
Values at sources, 1D array with shape (npts,).
meanval : float, array_like, optional
Expand Down
4 changes: 2 additions & 2 deletions docs/pestutilslib/fortran_library_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -724,7 +724,7 @@ Specifications of a structured model grid are also provided in a “grid specifi

Function *interp_from_mf6_depvar_file()* reads a dependent-variable file written by MODFLOW 6. For every output time that is recorded in this file, it undertakes spatial interpolation of model-calculated dependent variables to a set of points. Spatial interpolation is implemented using factors that were previously calculated by function *calc_mf6_interp_factors()*.

Arrays used by *interp_from_mf6_depvar_file()* to store spatial interpolation outcomes are useable by function *interp_to_obstime()*. Hence temporal interpolation to observation times can follow spatial interpolation to observation sites.
Arrays used by *interp_from_mf6_depvar_file()* to store spatial interpolation outcomes are usable by function *interp_to_obstime()*. Hence temporal interpolation to observation times can follow spatial interpolation to observation sites.

### Function Call

Expand Down Expand Up @@ -873,7 +873,7 @@ Similarly, the real-world coordinates of a structured-grid MODFLOW-USG model may

Function *interp_to_obstime()* undertakes time-interpolation of quantities that were previously read from simulator output files, and possibly spatially interpolated to a set of user-supplied points. The times to which time-interpolation takes place are normally the times at which field observations were made.

Arrays that store the outcomes of spatial interpolation or boundary flow extraction are useable by function *interp_to_obstime()*.
Arrays that store the outcomes of spatial interpolation or boundary flow extraction are usable by function *interp_to_obstime()*.

### Function Call

Expand Down
2 changes: 1 addition & 1 deletion pestutils/driver11.f90
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ program driver11
446 format(' Enter inv power of distance: ')
read(5,*,err=445) inverse_power

! -- The name of the factor file is aquired.
! -- The name of the factor file is acquired.

write(6,*)
450 write(6,460,advance='no')
Expand Down
2 changes: 1 addition & 1 deletion pestutils/driver8.f90
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ program driver8
240 format(' Enter maxpts, minpts: ')
read(5,*,err=230) maxpts,minpts

! -- The name of the factor file is aquired.
! -- The name of the factor file is acquired.

write(6,*)
250 write(6,260,advance='no')
Expand Down
2 changes: 1 addition & 1 deletion pestutils/driversubs.f90
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ subroutine getfile(ifail,cline,filename,ibeg,iend)
! filename: the name of the file read from the string
! ibeg: character position at which to begin search for filename
! iend: on input - character position at which to end search for filename
! on output - character postion at which filename ends
! on output - character position at which filename ends


integer, intent(out) :: ifail
Expand Down
4 changes: 2 additions & 2 deletions pestutils/funcproc1.f90
Original file line number Diff line number Diff line change
Expand Up @@ -1369,7 +1369,7 @@ integer (kind=c_int) function install_mf6_grid_from_file(gridname,grbfile,
mf6header(3)=adjustl(mf6header(3))
if(mf6header(3)(1:4).ne.'NTXT')then
write(amessage,130) trim(afile1)
130 format('Third header line of file ',a,' expeced to begin with "NTXT".')
130 format('Third header line of file ',a,' expected to begin with "NTXT".')
go to 9890
end if
anum=adjustl(mf6header(3)(5:))
Expand Down Expand Up @@ -3130,7 +3130,7 @@ integer (kind=c_int) function extract_flows_from_cbc_file( &
if((jcell.lt.0).or.(jcell.gt.ncell))then
call utl_num2char(jcell,atemp20)
write(amessage,250) trim(atemp20),trim(afile1)
250 format('Out of range cell number ',a,' enountered when reading flow ', &
250 format('Out of range cell number ',a,' encountered when reading flow ', &
'terms from file ',a,' using IMETH=3 method.')
go to 9890
end if
Expand Down
4 changes: 2 additions & 2 deletions pestutils/funcproc2.f90
Original file line number Diff line number Diff line change
Expand Up @@ -1841,7 +1841,7 @@ integer (kind=c_int) function build_covar_matrix_3d( &
integer(kind=c_int), intent(in) :: vartype ! 1:spher,2:exp,3:gauss,4:pow
real(kind=c_double), intent(in) :: nugget(npts) ! nugget
real(kind=c_double), intent(in) :: sill(npts) ! sill
real(kind=c_double), intent(in) :: ahmax(npts),ahmin(npts),avert(npts) ! variogram "a" valies
real(kind=c_double), intent(in) :: ahmax(npts),ahmin(npts),avert(npts) ! variogram "a" values
real(kind=c_double), intent(in) :: bearing(npts),dip(npts),rake(npts) ! variogram angles
integer(kind=c_int), intent(in) :: ldcovmat ! leading dimension of COVMAT
real(kind=c_double), intent(out) :: covmat(ldcovmat,npts) ! covariance matrix
Expand Down Expand Up @@ -2795,7 +2795,7 @@ integer (kind=c_int) function interpolate_blend_using_file( &
go to 9890

9400 write(amessage,9410) trim(afiletype),trim(facfile)
9410 format('Out-of-range array index encounted while reading ',a,' factor file ',a,'.')
9410 format('Out-of-range array index encountered while reading ',a,' factor file ',a,'.')
go to 9890

9890 interpolate_blend_using_file=1
Expand Down
6 changes: 3 additions & 3 deletions pestutils/lapack1.F
Original file line number Diff line number Diff line change
Expand Up @@ -10481,7 +10481,7 @@ SUBROUTINE DLASRT( ID, N, D, INFO )
* ..
* .. Executable Statements ..
*
* Test the input paramters.
* Test the input parameters.
*
INFO = 0
DIR = -1
Expand Down Expand Up @@ -14608,7 +14608,7 @@ SUBROUTINE DTRMV ( UPLO, TRANS, DIAG, N, A, LDA, X, INCX )
* ( 1 + ( n - 1 )*abs( INCX ) ).
* Before entry, the incremented array X must contain the n
* element vector x. On exit, X is overwritten with the
* tranformed vector x.
* transformed vector x.
*
* INCX - INTEGER.
* On entry, INCX specifies the increment for the elements of
Expand Down Expand Up @@ -15432,7 +15432,7 @@ INTEGER FUNCTION IEEECK( ISPEC, ZERO, ONE )
* =========
*
* ISPEC (input) INTEGER
* Specifies whether to test just for inifinity arithmetic
* Specifies whether to test just for infinity arithmetic
* or whether to test for infinity and NaN arithmetic.
* = 0: Verify infinity arithmetic only.
* = 1: Verify infinity and NaN arithmetic.
Expand Down
Loading

0 comments on commit 5bde5f4

Please sign in to comment.