Skip to content

Commit

Permalink
Improve doc-string explaining the use of possible key word arguments
Browse files Browse the repository at this point in the history
Signed-off-by: Adam.Dybbroe <[email protected]>
  • Loading branch information
Adam.Dybbroe committed Nov 27, 2023
1 parent 65f0378 commit 14cdb4c
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions pyspectral/solar.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# -*- coding: utf-8 -*-
#
# Copyright (c) 2013-2022 Pytroll developers
# Copyright (c) 2013-2023 Pytroll developers
#
#
# This program is free software: you can redistribute it and/or modify
Expand Down Expand Up @@ -58,10 +58,16 @@ def __init__(self, filename=TOTAL_IRRADIANCE_SPECTRUM_2000ASTM, **options):
Input:
filename: Filename of the solar irradiance spectrum (default: 2000 ASTM)
dlambda:
Delta wavelength: the step in wavelength defining the resolution on
which to integrate/convolute.
options:
dlambda:
Delta wavelength: the step in wavelength defining the resolution on
which to integrate/convolute.
Default is 0.005 if 'wavespace' is 'wavelength' and 2.0 if 'wavenumber'.
wavespace:
It is possible to specify if the solar irradiance spectrum should
be given in terms of wavelength (default) or in terms of
wavenumber. If the latter is desired 'wavespace' should be set to
'wavenumber'.
"""
self.wavelength = None
Expand Down

0 comments on commit 14cdb4c

Please sign in to comment.