Skip to content

Commit

Permalink
iss #381 updated examples in dosctring
Browse files Browse the repository at this point in the history
  • Loading branch information
BiancaMorandi committed May 17, 2023
1 parent 6edb0b2 commit b8ef08c
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions brightwind/analyse/plot.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,16 +80,16 @@ def __init__(self):
This color list is used primarily in line and scatter plots.
4) The color sequence used for defining the color_map variable is as below. This variable is a
color map having a linear color pattern from the first color to the last color of the _color_map_colors list.
self._color_map_colors = [self.primary_95, # lightest primary
color map having a linear color pattern from the first color to the last color of the color_map_colors list.
self.color_map_colors = [self.primary_95, # lightest primary
self.primary, # primary
self.primary_10] # darkest primary
This color map is used in the wind rose plot and also the 12x24 heat map plot from a shear by time of day.
5) The color sequence used for defining the color_map_cyclical variable is as below. This variable is a
color map having a cyclical color pattern from/to the first color of the _color_map_cyclical_colors.
self._color_map_cyclical_colors = [self.secondary, self.fifth, self.primary, self.tertiary, self.secondary]
color map having a cyclical color pattern from/to the first color of the color_map_cyclical_colors.
self.color_map_cyclical_colors = [self.secondary, self.fifth, self.primary, self.tertiary, self.secondary]
This sequence of colors is for plots where the pattern is cyclical such as a seasons. This is also used in
12x24 plot from a shear by time of day.
Expand Down Expand Up @@ -118,16 +118,16 @@ def __init__(self):
# The colors used for defining the color_map can also be reset by using the example code below:
bw.analyse.plot.COLOR_PALETTE.set_color_map_colors = ['#ccfffc', # lightest primary
'#00b4aa', # vert-dark
'#008079'] # darkest primary
bw.analyse.plot.COLOR_PALETTE.color_map_colors = ['#ccfffc', # lightest primary
'#00b4aa', # vert-dark
'#008079'] # darkest primary
# The colors used for defining the color_map_cyclical can also be reset by using the example code below:
bw.analyse.plot.COLOR_PALETTE.set_color_map_cyclical = ['#ccfffc', # lightest primary
'#00b4aa', # vert-dark
'#008079', # darkest primary
'#ccfffc'] # lightest primary
bw.analyse.plot.COLOR_PALETTE.color_map_cyclical_colors = ['#ccfffc', # lightest primary
'#00b4aa', # vert-dark
'#008079', # darkest primary
'#ccfffc'] # lightest primary
# The hex color value corresponding to an input color adjusted by a percentage lightness (e.g 0.5 %)
# can be derived as below:
Expand Down

0 comments on commit b8ef08c

Please sign in to comment.