Commit 49327f52 authored by g-weatherill's avatar g-weatherill
Browse files

Changes GMICE class docstring

parent 37e7b0e2
Pipeline #24428 passed with stage
in 11 minutes and 52 seconds
...@@ -21,6 +21,14 @@ class GMICE(metaclass=abc.ABCMeta): ...@@ -21,6 +21,14 @@ class GMICE(metaclass=abc.ABCMeta):
""" """
Abstract base class for conversion equations between observed ground motion parameters and Abstract base class for conversion equations between observed ground motion parameters and
macroseismic intensity macroseismic intensity
Attributes:
sctx: Site properties as instance of `class`:
openquake.hazardlib.gsim.base.SitesContext
rctx: Rupture properties as instance of `class`:
openquake.hazardlib.gsim.base.RuptureContext
dctx: Distances as instance of `class`:
openquake.hazardlib.gsim.base.DistancesContext
""" """
@property @property
...@@ -49,13 +57,8 @@ class GMICE(metaclass=abc.ABCMeta): ...@@ -49,13 +57,8 @@ class GMICE(metaclass=abc.ABCMeta):
def __init__(self, sctx, rctx, dctx): def __init__(self, sctx, rctx, dctx):
""" """
Args: Constructs the class using the SitesContext, RuptureContext and DistancesContext
sctx: Site properties as instance of `class`: objects
openquake.hazardlib.gsim.base.SitesContext
rctx: Rupture properties as instance of `class`:
openquake.hazardlib.gsim.base.RuptureContext
dctx: Distances as instance of `class`:
openquake.hazardlib.gsim.base.DistancesContext
""" """
self.sctx = SitesContext() self.sctx = SitesContext()
self.dctx = DistancesContext() self.dctx = DistancesContext()
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment