Skip to content

Commit

Permalink
fix typing of netcdf
Browse files Browse the repository at this point in the history
  • Loading branch information
robertjwilson committed Mar 10, 2021
1 parent 5cb090a commit 53e6769
Show file tree
Hide file tree
Showing 10 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Variable modification
DataSet.set_missing
DataSet.sum_all

NetCDF file attribute modification
netCDF file attribute modification
---------------------

.. autosummary::
Expand Down
4 changes: 2 additions & 2 deletions docs/source/datasets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Datasets
========

nctoolkit works with what it calls datasets. Each dataset is made up of
or more NetCDF files.
or more netCDF files.

Opening datasets
----------------
Expand All @@ -20,7 +20,7 @@ all of the files in a folder called data as a dataset, you could do the followin
data = nc.open_data("data/*.nc")
If you want to use data that can be downloaded from a url, just use
``open_url``. This will download the NetCDF files to a temporary folder,
``open_url``. This will download the netCDF files to a temporary folder,
and it can then be analyzed.


Expand Down
10 changes: 5 additions & 5 deletions docs/source/exporting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nctoolkit can work with data available on local file systems, urls and over thre
Opening single files and ensembles
================

If you want to import a single NetCDF file as a dataset, do the following:
If you want to import a single netCDF file as a dataset, do the following:


.. code:: ipython3
Expand Down Expand Up @@ -59,13 +59,13 @@ If you want to work with data that is available over a thredds server or OPeNDAP
Exporting datasets
================

nctoolkit has a number of built in methods for exporting data to NetCDF, pandas dataframes and xarray datasets.
nctoolkit has a number of built in methods for exporting data to netCDF, pandas dataframes and xarray datasets.

Save as a NetCDF
Save as a netCDF
================

The method ``write_nc`` lets users export a dataset to a NetCDF file. If
you want this to be a zipped NetCDF file use the ``zip`` method before
The method ``write_nc`` lets users export a dataset to a netCDF file. If
you want this to be a zipped netCDF file use the ``zip`` method before
to ``write_nc``. An example of usage is as follows:

.. code:: ipython3
Expand Down
14 changes: 7 additions & 7 deletions docs/source/hacks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,19 @@ you need to set the ``join`` argument to ``False``:
Of course, this method will only if it is possible to calculate the areas the grid cells.


Changing the format of the NetCDF files in a dataset
Changing the format of the netCDF files in a dataset
================

Sometimes you will want to change the format of the files in a dataset. You can do this using the ``format`` method. This let's
you set the format, with the following options:
* NetCDF = "nc1"
* NetCDF version 2 (64-bit offset) = "nc2"/"nc"
* NetCDF4 (HDF5) = "nc4"
* NetCDF4-classi = "nc4c"
* NetCDF version 5 (64-bit data) = "nc5"
* netCDF = "nc1"
* netCDF version 2 (64-bit offset) = "nc2"/"nc"
* netCDF4 (HDF5) = "nc4"
* netCDF4-classi = "nc4c"
* netCDF version 5 (64-bit data) = "nc5"


So, if you want to set the format to NetCDF4, you would do the following:
So, if you want to set the format to netCDF4, you would do the following:

.. code:: ipython3
Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

nctoolkit: Fast and easy analysis of NetCDF data in Python
nctoolkit: Fast and easy analysis of netCDF data in Python
=======================================================

nctoolkit is a comprehensive Python package for analyzing NetCDF data on Linux and macOS.
nctoolkit is a comprehensive Python package for analyzing netCDF data on Linux and macOS.

Core abilities include:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Python dependencies
- `numpy <http://www.numpy.org/>`__ (1.14 or later)
- `pandas <http://pandas.pydata.org/>`__ (0.24 or later)
- `xarray <http://xarray.pydata.org/en/stable/>`__ (0.14 or later)
- `NetCDF4 <https://unidata.github.io/NetCDF4-python/NetCDF4/index.html>`__ (1.53 or later)
- `netCDF4 <https://unidata.github.io/netCDF4-python/netCDF4/index.html>`__ (1.53 or later)
- `hvplot <https://ncplot.readthedocs.io/en/stable/>`__

How to install nctoolkit
Expand Down
4 changes: 2 additions & 2 deletions docs/source/interpolation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ We can then use this new dataset as the target grid in ``regrid``. So
This method will also work using NetCDF files. So, if you wanted you can
also use a path to a NetCDF file as the target grid.
This method will also work using netCDF files. So, if you wanted you can
also use a path to a netCDF file as the target grid.


How to reuse the weights for regridding
Expand Down
2 changes: 1 addition & 1 deletion docs/source/news.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ New methods will be introduced for identifying the first time step will specific
``first_above``, ``first_below``, ``last_above`` and ``last_below``. The thresholds are either single numbers or can come from a gridded dataset
for grid-cell specific thresholds.

Methods to compare a dataset with another dataset or NetCDF file have been added: ``gt`` and ``lt``, which stand for 'greater than' and 'less than'.
Methods to compare a dataset with another dataset or netCDF file have been added: ``gt`` and ``lt``, which stand for 'greater than' and 'less than'.

Users will now be able to recycle the weights calculated when interpolating data. This can enable much faster interpolation of multiple files with the
same grid.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/parallel.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Parallel processing
===================

nctoolkit is written to enable rapid processing and analysis of NetCDF
nctoolkit is written to enable rapid processing and analysis of netCDF
files, and this includes the ability to process in parallel. Two methods
of parallel processing are available. First is the ability to carry out
operations on multi-file datasets in parallel. Second is the ability to
Expand Down
2 changes: 1 addition & 1 deletion docs/source/variables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ If you wanted to multiply everything by 10, you would do this:
data.multiply(10)
These methods will also let you use other datasets or NetCDF files. So, you could add the values in a dataset data2 to a dataset
These methods will also let you use other datasets or netCDF files. So, you could add the values in a dataset data2 to a dataset
called data1 as follows:


Expand Down

0 comments on commit 53e6769

Please sign in to comment.