Skip to content

Commit

Permalink
Update docstring of from_raster_xarray
Browse files Browse the repository at this point in the history
  • Loading branch information
peanutfun committed Aug 4, 2022
1 parent 7a9ea42 commit b2eea56
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions climada/hazard/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -407,10 +407,13 @@ def from_raster_xarray(
* Intensity and fraction data must be three-dimensional data that is interpreted
with the coordinates given by ``coordinate_vars`` (or the default). All other
data must be given in time coordinates only.
* To avoid confusion in the call signature, all parameters are keyword-only
arguments, except ``data``.
* To avoid confusion in the call signature, several parameters are keyword-only
arguments.
* The attributes ``Hazard.tag.haz_type`` and ``Hazard.unit`` currently cannot be
read from the Dataset. Use the method parameters to set these attributes.
* This method does not read coordinate system metadata and uses the default WGS
84 coordinate system exclusively. To set a custom coordinate system, modify
the ``Hazard.centroids.geometry`` attribute of the returned object.
* This method **does not** read lazily. Single data arrays must fit into memory.
Parameters
Expand Down

0 comments on commit b2eea56

Please sign in to comment.