Skip to content

Commit

Permalink
remove experimental soiling warnings from plotting
Browse files Browse the repository at this point in the history
  • Loading branch information
martin-springer committed Nov 8, 2024
1 parent dc46cf6 commit 8492873
Showing 1 changed file with 6 additions and 38 deletions.
44 changes: 6 additions & 38 deletions rdtools/plotting.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,15 +133,10 @@ def soiling_monte_carlo_plot(soiling_info, normalized_yield, point_alpha=0.5,
profile_alpha=0.05, ymin=None, ymax=None,
profiles=None, point_color=None,
profile_color='C1'):
'''
"""
Create figure to visualize Monte Carlo of soiling profiles used in the SRR
analysis.
.. warning::
The soiling module is currently experimental. The API, results,
and default behaviors may change in future releases (including MINOR
and PATCH releases) as the code matures.
Parameters
----------
soiling_info : dict
Expand All @@ -168,13 +163,7 @@ def soiling_monte_carlo_plot(soiling_info, normalized_yield, point_alpha=0.5,
Returns
-------
fig : matplotlib.figure.Figure
'''
warnings.warn(
'The soiling module is currently experimental. The API, results, '
'and default behaviors may change in future releases (including MINOR '
'and PATCH releases) as the code matures.'
)

"""
fig, ax = plt.subplots()
renormalized = normalized_yield / soiling_info['renormalizing_factor']
ax.plot(renormalized.index, renormalized, 'o', alpha=point_alpha,
Expand All @@ -197,14 +186,9 @@ def soiling_monte_carlo_plot(soiling_info, normalized_yield, point_alpha=0.5,
def soiling_interval_plot(soiling_info, normalized_yield, point_alpha=0.5,
profile_alpha=1, ymin=None, ymax=None,
point_color=None, profile_color=None):
'''
"""
Create figure to visualize valid soiling profiles used in the SRR analysis.
.. warning::
The soiling module is currently experimental. The API, results,
and default behaviors may change in future releases (including MINOR
and PATCH releases) as the code matures.
Parameters
----------
soiling_info : dict
Expand All @@ -228,13 +212,7 @@ def soiling_interval_plot(soiling_info, normalized_yield, point_alpha=0.5,
Returns
-------
fig : matplotlib.figure.Figure
'''
warnings.warn(
'The soiling module is currently experimental. The API, results, '
'and default behaviors may change in future releases (including MINOR '
'and PATCH releases) as the code matures.'
)

"""
sratio = soiling_info['soiling_ratio_perfect_clean']
fig, ax = plt.subplots()
renormalized = normalized_yield / soiling_info['renormalizing_factor']
Expand All @@ -249,14 +227,9 @@ def soiling_interval_plot(soiling_info, normalized_yield, point_alpha=0.5,


def soiling_rate_histogram(soiling_info, bins=None):
'''
"""
Create histogram of soiling rates found in the SRR analysis.
.. warning::
The soiling module is currently experimental. The API, results,
and default behaviors may change in future releases (including MINOR
and PATCH releases) as the code matures.
Parameters
----------
soiling_info : dict
Expand All @@ -268,12 +241,7 @@ def soiling_rate_histogram(soiling_info, bins=None):
Returns
-------
fig : matplotlib.figure.Figure
'''
warnings.warn(
'The soiling module is currently experimental. The API, results, '
'and default behaviors may change in future releases (including MINOR '
'and PATCH releases) as the code matures.'
)
"""

soiling_summary = soiling_info['soiling_interval_summary']
fig, ax = plt.subplots()
Expand Down

0 comments on commit 8492873

Please sign in to comment.