Skip to content

fix: added Nature color scheme #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jlerat merged 1 commit into from
Apr 3, 2025
Merged

fix: added Nature color scheme #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions src/hydrodiy/plot/putils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,19 @@
"lightmint": "#71cc98"
}

# Colours palette recommended by Nature
# See https://www.nature.com/articles/nmeth.1618
COLORS_NATURE = [
"k",
rgb2hex((230./255, 159./255, 0)),
rgb2hex((86./255., 180./255, 233./255)),
rgb2hex((0., 158./255, 115./255)),
rgb2hex((240./255, 228./255, 66./255)),
rgb2hex((0., 114./255, 178./255)),
rgb2hex((213./255, 94./255, 0.)),
rgb2hex((204./255, 121./255., 167./255))
]


def _float(u):
""" Function to convert object to float """
Expand Down Expand Up @@ -284,8 +297,11 @@ def line(ax, vx=0., vy=1., x0=0., y0=0., *args, **kwargs):
return line


def set_mpl(color_theme="black", font_size=18, usetex=False,
color_cycle=mcolors.TABLEAU_COLORS):
def set_mpl(color_theme="black",
font_size=18,
usetex=False,
color_cycle=mcolors.TABLEAU_COLORS,
linewidth=2):
""" Set convenient default matplotlib parameters

Parameters
Expand All @@ -299,6 +315,8 @@ def set_mpl(color_theme="black", font_size=18, usetex=False,
color_cycle : list
List of colors to cycle through.
"""
# Use constrained layout by default
mpl.rc("figure.constrained_layout", use=True)

# Latex mode
mpl.rc("text", usetex=usetex)
Expand All @@ -308,7 +326,8 @@ def set_mpl(color_theme="black", font_size=18, usetex=False,
mpl.rc("text.latex", preamble=preamble)

# Font size
mpl.rc("font", size=font_size)
if font_size is not None:
mpl.rc("font", size=font_size)

# Set color cycle - depends on matplotlib version
if "axes.color_cycle" in mpl.rcParams:
Expand All @@ -325,7 +344,8 @@ def set_mpl(color_theme="black", font_size=18, usetex=False,
mpl.rc("image", cmap="PiYG")

# Ticker line width than default
mpl.rc("lines", linewidth=2)
if linewidth is not None:
mpl.rc("lines", linewidth=linewidth)

# Set contour line style
mpl.rc("contour", negative_linestyle="solid")
Expand Down
11 changes: 8 additions & 3 deletions src/hydrodiy/plot/tests/test_hyplot_putils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
def test_color_sets():
""" Test color sets """
for colname in ["badgood", "terciles", "cblind", "safe", \
"core", "primary", "secondary"]:
"core", "primary", "secondary", "nature"]:
cols = getattr(putils, "COLORS_{}".format(colname.upper()))
if isinstance(cols, str):
cols = [cols]
Expand Down Expand Up @@ -160,11 +160,16 @@ def plot(fp, usetex=False):
plot(fp)

mpl.rcdefaults()
putils.set_mpl(usetex=True)
putils.set_mpl(color_cycle=putils.COLORS_NATURE)
fp = FIMG / "set_mpl4.png"
plot(fp)

mpl.rcdefaults()
putils.set_mpl(usetex=True)
fp = FIMG / "set_mpl5.png"
try:
plot(fp, True)
except (FileNotFoundError, RuntimeError) as err:
except (FileNotFoundError, ValueError, RuntimeError) as err:
message = "Cannot process set_mpl, error = {0}".format(str(err))
print(message)

Expand Down