Skip to content

Commit

Permalink
Merge pull request #1697 from BENR0/gh_documentation_issues
Browse files Browse the repository at this point in the history
Solves some Github issues regarding documentation
  • Loading branch information
djhoese committed Jun 1, 2021
2 parents c568088 + cf4d656 commit 0a82ff0
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion doc/source/quickstart.rst
Expand Up @@ -154,7 +154,7 @@ To visualize loaded data in a pop-up window:
>>> global_scene.show(0.6)

Alternatively if working in a Jupyter notebook the scene can be converted to
a `geoviews <http://geo.holoviews.org/index.html>`_ object using the
a `geoviews <https://geoviews.org>`_ object using the
:meth:`~satpy.scene.Scene.to_geoviews` method. The geoviews package is not a
requirement of the base satpy install so in order to use this feature the user
needs to install the geoviews package himself.
Expand Down
12 changes: 6 additions & 6 deletions satpy/resample.py
Expand Up @@ -119,13 +119,13 @@
Store area definitions
----------------------
Area definitions can be added to a custom YAML file (see
`pyresample's documentation <http://pyresample.readthedocs.io/en/stable/geo_def.html#pyresample-utils>`_
for more information)
and loaded using pyresample's utility methods::
Area definitions can be saved to a custom YAML file (see
`pyresample's writing to disk <http://pyresample.readthedocs.io/en/stable/geometry_utils.html#writing-to-disk>`_)
and loaded using pyresample's utility methods
(`pyresample's loading from disk <http://pyresample.readthedocs.io/en/stable/geometry_utils.html#loading-from-disk>`_)::
>>> from pyresample.utils import parse_area_file
>>> my_area = parse_area_file('my_areas.yaml', 'my_area')[0]
>>> from pyresample import load_area
>>> my_area = load_area('my_areas.yaml', 'my_area')
Examples coming soon...
Expand Down
5 changes: 3 additions & 2 deletions satpy/writers/cf_writer.py
Expand Up @@ -31,11 +31,12 @@
>>> scn.save_datasets(writer='cf', datasets=['VIS006', 'IR_108'], filename='seviri_test.nc',
exclude_attrs=['raw_metadata'])
* You can select the netCDF backend using the ``engine`` keyword argument. Default is ``h5netcdf``.
* You can select the netCDF backend using the ``engine`` keyword argument. If `None` if follows
:meth:`~xarray.Dataset.to_netcdf` engine choices with a preference for 'netcdf4'.
* For datasets with area definition you can exclude lat/lon coordinates by setting ``include_lonlats=False``.
* By default the dataset name is prepended to non-dimensional coordinates such as scanline timestamps. This ensures
maximum consistency, i.e. the netCDF variable names are independent of the number/set of datasets to be written.
If a non-dimensional coordinate is identical for
If a non-dimensional coordinate is unique among all datasets and ``pretty=True``, its name will not be modified.
* Some dataset names start with a digit, like AVHRR channels 1, 2, 3a, 3b, 4 and 5. This doesn't comply with CF
https://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/build/ch02s03.html. These channels are prefixed
with `CHANNEL_` by default. This can be controlled with the variable `numeric_name_prefix` to `save_datasets`.
Expand Down

0 comments on commit 0a82ff0

Please sign in to comment.