@@ -259,17 +259,14 @@ def martin_ruiz_spectral_modifier(clearness_index, airmass_absolute,
259
259
airmass_absolute : numeric
260
260
Absolute airmass. Give attention to algorithm used (``kasten1966`` is
261
261
recommended for default parameters of ``monosi``, ``polysi`` and
262
- ``asi``, see reference [1]_).
262
+ ``asi``, see [1]_).
263
263
264
264
cell_type : string, optional
265
265
Specifies material of the cell in order to infer model parameters.
266
266
Allowed types are ``monosi``, ``polysi`` and ``asi``, either lower or
267
267
upper case. If not specified, ``model_parameters`` must be provided.
268
268
269
269
model_parameters : dict-like, optional
270
- In case you computed the model parameters. In case any component is not
271
- specified, result will have a ``np.nan`` value in its
272
- corresponding value.
273
270
Provide either a dict or a ``pd.DataFrame`` as follows:
274
271
275
272
.. code-block:: python
@@ -289,13 +286,16 @@ def martin_ruiz_spectral_modifier(clearness_index, airmass_absolute,
289
286
index=('c', 'a', 'b'))
290
287
291
288
``c``, ``a`` and ``b`` must be scalar.
292
-
289
+ ```suggestion
290
+ If parameters for an irradiance component (`'poa_direct'`,
291
+ `'poa_sky_diffuse'`, or `'poa_ground_diffuse'`) are not
292
+ specified, ``np.nan`` will be returned in the corresponding value.
293
293
Returns
294
294
-------
295
295
Modifiers : pd.DataFrame (iterable input) or dict (scalar input) of numeric
296
296
Mismatch modifiers for direct, sky diffuse and ground diffuse
297
- irradiances, with indexes `` poa_direct`` , `` poa_sky_diffuse` `,
298
- `` poa_ground_diffuse` `.
297
+ irradiances, with indexes `' poa_direct'` , `' poa_sky_diffuse' `,
298
+ `' poa_ground_diffuse' `.
299
299
Each mismatch modifier should be multiplied by its corresponding
300
300
POA component.
301
301
Returns np.nan for a component if provided ``model_parameters`` does
0 commit comments