From 6d112d0fc4e4a0a9b8c2fecad31842b0f514d221 Mon Sep 17 00:00:00 2001
From: Le Roux Erwan <erwan.le-roux@irstea.fr>
Date: Mon, 18 Mar 2019 14:05:27 +0100
Subject: [PATCH] [SCM] display variable unit in the variable name on the plot

---
 experiment/meteo_france_SCM_study/abstract_study.py         | 6 +++++-
 experiment/meteo_france_SCM_study/abstract_variable.py      | 1 +
 .../meteo_france_SCM_study/crocus/crocus_variables.py       | 4 ++--
 experiment/meteo_france_SCM_study/safran/safran_variable.py | 1 +
 4 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/experiment/meteo_france_SCM_study/abstract_study.py b/experiment/meteo_france_SCM_study/abstract_study.py
index 4abb0cf4..a23316fe 100644
--- a/experiment/meteo_france_SCM_study/abstract_study.py
+++ b/experiment/meteo_france_SCM_study/abstract_study.py
@@ -202,7 +202,11 @@ class AbstractStudy(object):
 
     @property
     def variable_name(self):
-        return self.variable_class.NAME
+        return self.variable_class.NAME + ' (in {})'.format(self.variable_unit)
+
+    @property
+    def variable_unit(self):
+        return self.variable_class.UNIT
 
     @property
     def relative_path(self) -> str:
diff --git a/experiment/meteo_france_SCM_study/abstract_variable.py b/experiment/meteo_france_SCM_study/abstract_variable.py
index 31b50bfc..bcd5b1b7 100644
--- a/experiment/meteo_france_SCM_study/abstract_variable.py
+++ b/experiment/meteo_france_SCM_study/abstract_variable.py
@@ -7,6 +7,7 @@ class AbstractVariable(object):
     """
 
     NAME = ''
+    UNIT = ''
 
     def __init__(self, dataset, altitude):
         self.dataset = dataset
diff --git a/experiment/meteo_france_SCM_study/crocus/crocus_variables.py b/experiment/meteo_france_SCM_study/crocus/crocus_variables.py
index 9cdac46d..3bc06074 100644
--- a/experiment/meteo_france_SCM_study/crocus/crocus_variables.py
+++ b/experiment/meteo_france_SCM_study/crocus/crocus_variables.py
@@ -29,16 +29,16 @@ class CrocusVariable(AbstractVariable):
 
 class CrocusSweVariable(CrocusVariable):
     NAME = 'Snow Water Equivalent'
+    UNIT = 'kg/m2 or mm'
 
     def __init__(self, dataset, altitude):
-        # Units are kg m-2
         super().__init__(dataset, altitude, 'SNOWSWE')
 
 
 class CrocusDepthVariable(CrocusVariable):
     NAME = 'Snow Depth'
+    UNIT = 'm'
 
     def __init__(self, dataset, altitude):
-        # Units are m
         super().__init__(dataset, altitude, "SNOWDEPTH")
 
diff --git a/experiment/meteo_france_SCM_study/safran/safran_variable.py b/experiment/meteo_france_SCM_study/safran/safran_variable.py
index 4e3e2e27..87a7a1d7 100644
--- a/experiment/meteo_france_SCM_study/safran/safran_variable.py
+++ b/experiment/meteo_france_SCM_study/safran/safran_variable.py
@@ -22,6 +22,7 @@ class SafranSnowfallVariable(AbstractVariable):
     """
 
     NAME = 'Snowfall'
+    UNIT = 'kg/m2 or mm'
 
     def __init__(self, dataset, altitude, nb_consecutive_days_of_snowfall=1, keyword='Snowf'):
         super().__init__(dataset, altitude)
-- 
GitLab