You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ gsw-xarray: Wrapper for gsw that adds CF attributes
11
11
12
12
gsw-xarray is a wrapper for `gsw python <https://github.com/TEOS-10/GSW-python>`_
13
13
that will add CF attributes to xarray.DataArray outputs.
14
-
It is meant to be a drop in wrapper for the upstram GSW-Python library and will only add these attribtues if the first argument to a fucntion is an xarray.DataArray.
14
+
It is meant to be a drop in wrapper for the upstream GSW-Python library and will only add these attributes if the first argument to a function is an xarray.DataArray.
15
15
16
16
Usage
17
17
-----
@@ -46,7 +46,7 @@ Don't worry about usage with non xarray array objects, just use in all places yo
46
46
.. code:: python
47
47
48
48
sigma0 = gsw.sigma0(id*10, id*0.1+34)
49
-
print(type(sigma0, sigma0)
49
+
print(type(sigma0), sigma0)
50
50
51
51
Outputs
52
52
@@ -68,7 +68,7 @@ Conda
68
68
.....
69
69
70
70
For the moment gsw-xarray is not released in conda-forge, so you'll
71
-
need to instal via pip: activate your conda environment, and then use ``pip install gsw_xarray``.
71
+
need to install via pip: activate your conda environment, and then use ``pip install gsw_xarray``.
72
72
73
73
Pipenv
74
74
......
@@ -82,7 +82,7 @@ Contributor guide
82
82
All contributions, bug reports, bug fixes, documentation improvements,
83
83
enhancements, and ideas are welcome.
84
84
If you notice a bug or are missing a feature, fell free
85
-
to open an issue in the `github issues page <https://github.com/DocOtak/gsw-xarray/issues>`_.
85
+
to open an issue in the `GitHub issues page <https://github.com/DocOtak/gsw-xarray/issues>`_.
86
86
87
87
In order to contribute to gsw-xarray, please fork the repository and
88
88
submit a pull request. A good step by step tutorial for starting with git can be found in the
Copy file name to clipboardExpand all lines: docs/attrs.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,20 +4,20 @@ This rather long list shows all the attributes that will be set on the returned
4
4
5
5
There are some things to be aware of:
6
6
7
-
* Functions which return unitless values will have the ``units`` attribute set to ``"1"`` folloing the CF recomended practice (based on SI).
7
+
* Functions which return unitless values will have the ``units`` attribute set to ``"1"`` following the CF recommended practice (based on SI).
8
8
Rather than omit the ``units`` attribute entirely, we want to explicitly state that something is unitless.
9
9
10
-
* The unit strings were selected to be compatable with both UDUNITS2 (the requrement in CF), and the python pint library.
10
+
* The unit strings were selected to be compatible with both UDUNITS2 (the requirement in CF), and the python pint library.
11
11
12
12
* Not every returned value has a CF standard name, in which case we must not include the standard name attribute.
13
13
As names are added to the CF table, we will attempt to update this list.
14
14
The current standard names were taken from v78 last published on 2021-09-21.
15
15
16
-
Additionally, some standard names are only valid for speciifc input values e.g. z_from_p has geopotential parameters and the normal standard name does not apply if these are not 0.
16
+
Additionally, some standard names are only valid for specific input values e.g. z_from_p has geopotential parameters and the normal standard name does not apply if these are not 0.
17
17
18
18
* We include the OceanSITES ``reference_scale`` attribute for functions that return PSS-78 or ITS-90.
19
19
20
20
* Finally, we did our best to include the correct units and standard name based on the published TEOS-10 documentation.
21
-
If erorrs are noted, please open an issue on github so we can correct these errors.
21
+
If errors are noted, please open an issue on GitHub so we can correct these errors.
0 commit comments