source: TOOLS/ConsoGENCMIP6/bin/plot_bilan.py @ 2526

Last change on this file since 2526 was 2526, checked in by labetoulle, 7 years ago
  • plot_bilan_jobs.py : add two month delay curve
  • homogenise all plots
  • Property svn:executable set to *
File size: 14.1 KB
Line 
1#!/usr/bin/env python
2# -*- coding: utf-8 -*-
3
4# this must come first
5from __future__ import print_function, unicode_literals, division
6
7# standard library imports
8from argparse import ArgumentParser
9import os
10import os.path
11import datetime as dt
12from dateutil.relativedelta import relativedelta
13import numpy as np
14
15# Application library imports
16from libconso import *
17
18
19########################################
20class DataDict(dict):
21  #---------------------------------------
22  def __init__(self):
23    self = {}
24
25  #---------------------------------------
26  def init_range(self, date_beg, date_end, inc=1):
27    """
28    """
29    delta = date_end - date_beg
30
31    (deb, fin) = (0, delta.days+1)
32
33    dates = (date_beg + dt.timedelta(days=i)
34             for i in xrange(deb, fin, inc))
35
36    for date in dates:
37      self.add_item(date)
38
39  #---------------------------------------
40  def fill_data(self, filein):
41    """
42    """
43    try:
44      data = np.genfromtxt(
45        filein,
46        skip_header=1,
47        converters={
48          0: string_to_date,
49          1: string_to_float,
50          2: string_to_percent,
51          3: string_to_percent,
52          4: string_to_float,
53          5: string_to_float,
54          6: string_to_float,
55          7: string_to_float,
56        },
57        missing_values="nan",
58      )
59    except Exception as rc:
60      print("Empty file {}:\n{}".format(filein, rc))
61      exit(1)
62
63    for date, conso, real_use, theo_use, \
64        run_mean, pen_mean, run_std, pen_std in data:
65      if date in self:
66        self.add_item(
67          date,
68          conso,
69          real_use,
70          theo_use,
71          run_mean,
72          pen_mean,
73          run_std,
74          pen_std,
75        )
76        self[date].fill()
77
78  #---------------------------------------
79  def add_item(self, date, conso=np.nan,
80               real_use=np.nan, theo_use=np.nan,
81               run_mean=np.nan, pen_mean=np.nan,
82               run_std=np.nan, pen_std=np.nan):
83    """
84    """
85    self[date] = Conso(date, conso, real_use, theo_use,
86                       run_mean, pen_mean, run_std, pen_std)
87
88  #---------------------------------------
89  def theo_equation(self):
90    """
91    """
92    (dates, theo_uses) = \
93      zip(*((item.date, item.theo_use)
94            for item in self.get_items_in_full_range()))
95
96    (idx_min, idx_max) = \
97        (np.nanargmin(theo_uses), np.nanargmax(theo_uses))
98
99    x1 = dates[idx_min].timetuple().tm_yday
100    x2 = dates[idx_max].timetuple().tm_yday
101
102    y1 = theo_uses[idx_min]
103    y2 = theo_uses[idx_max]
104
105    m = np.array([[x1, 1.], [x2, 1.]], dtype="float")
106    n = np.array([y1, y2], dtype="float")
107
108    poly_ok = True
109    try:
110      poly_theo = np.poly1d(np.linalg.solve(m, n))
111    except np.linalg.linalg.LinAlgError:
112      poly_ok = False
113
114    if poly_ok:
115      delta = (dates[0] + relativedelta(months=2) - dates[0]).days
116
117      poly_delay = np.poly1d(
118        [poly_theo[1], poly_theo[0] - poly_theo[1] * delta]
119      )
120
121      self.poly_theo = poly_theo
122      self.poly_delay = poly_delay
123
124  #---------------------------------------
125  def get_items_in_range(self, date_beg, date_end, inc=1):
126    """
127    """
128    items = (item for item in self.itervalues()
129                   if item.date >= date_beg and
130                      item.date <= date_end)
131    items = sorted(items, key=lambda item: item.date)
132
133    return items[::inc]
134
135  #---------------------------------------
136  def get_items_in_full_range(self, inc=1):
137    """
138    """
139    items = (item for item in self.itervalues())
140    items = sorted(items, key=lambda item: item.date)
141
142    return items[::inc]
143
144  #---------------------------------------
145  def get_items(self, inc=1):
146    """
147    """
148    items = (item for item in self.itervalues()
149                   if item.isfilled())
150    items = sorted(items, key=lambda item: item.date)
151
152    return items[::inc]
153
154
155class Conso(object):
156  #---------------------------------------
157  def __init__(self, date, conso=np.nan,
158               real_use=np.nan, theo_use=np.nan,
159               run_mean=np.nan, pen_mean=np.nan,
160               run_std=np.nan, pen_std=np.nan):
161    self.date     = date
162    self.conso    = conso
163    self.real_use = real_use
164    self.theo_use = theo_use
165    self.poly_theo = np.poly1d([])
166    self.poly_delay = np.poly1d([])
167    self.run_mean = run_mean
168    self.pen_mean = pen_mean
169    self.run_std  = run_std
170    self.pen_std  = pen_std
171    self.filled   = False
172
173  #---------------------------------------
174  def __repr__(self):
175    return "{:.2f} ({:.2%})".format(self.conso, self.real_use)
176
177  #---------------------------------------
178  def isfilled(self):
179    return self.filled
180
181  #---------------------------------------
182  def fill(self):
183    self.filled = True
184
185
186########################################
187def plot_init():
188  paper_size  = np.array([29.7, 21.0])
189  fig, ax_conso = plt.subplots(figsize=(paper_size/2.54))
190  ax_theo = ax_conso.twinx()
191
192  return fig, ax_conso, ax_theo
193
194
195########################################
196def plot_data(ax_conso, ax_theo, xcoord, dates,
197              consos, theo_uses, real_uses, theo_equs, theo_delay,
198              run_mean, pen_mean, run_std, pen_std):
199  """
200  """
201  line_style = "-"
202  if args.full:
203    line_width = 0.05
204  else:
205    line_width = 0.1
206
207  ax_conso.bar(
208    xcoord, consos, width=1, align="center", color="linen",
209    linewidth=line_width, label="conso (heures)"
210  )
211
212  ax_theo.plot(
213    xcoord, real_uses, line_style,
214    color="forestgreen", linewidth=1, markersize=8,
215    solid_capstyle="round", solid_joinstyle="round",
216    label="conso\nréelle (%)"
217  )
218  ax_theo.plot(
219    xcoord, theo_equs, "--",
220    color="firebrick", linewidth=0.5,
221    solid_capstyle="round", solid_joinstyle="round"
222  )
223  ax_theo.plot(
224    xcoord, theo_uses, line_style,
225    color="firebrick", linewidth=1, markersize=8,
226    solid_capstyle="round", solid_joinstyle="round",
227    label="conso\nthéorique (%)"
228  )
229  ax_theo.plot(
230    xcoord, theo_delay, ":",
231    color="firebrick", linewidth=0.5,
232    solid_capstyle="round", solid_joinstyle="round",
233    label="retard de\ndeux mois (%)"
234  )
235
236
237########################################
238def plot_config(fig, ax_conso, ax_theo, xcoord, dates, title,
239                conso_per_day):
240  """
241  """
242  # ... Config axes ...
243  # -------------------
244  # 1) Range
245  conso_max = np.nanmax(consos)
246  if args.max:
247    ymax = conso_max  # + conso_max*.1
248  else:
249    ymax = 2. * conso_per_day
250
251  if conso_max > ymax:
252    ax_conso.annotate(
253      "{:.2e} heures".format(conso_max),
254      ha="left",
255      va="top",
256      fontsize="xx-small",
257      bbox=dict(boxstyle="round", fc="w", ec="0.5", color="gray",),
258      xy=(np.nanargmax(consos)+1.2, ymax),
259      textcoords="axes fraction",
260      xytext=(0.01, 0.9),
261      arrowprops=dict(
262        arrowstyle="->",
263        shrinkA=0,
264        shrinkB=0,
265        color="gray",
266      ),
267    )
268
269  xmin, xmax = xcoord[0]-1, xcoord[-1]+1
270  ax_conso.set_xlim(xmin, xmax)
271  ax_conso.set_ylim(0., ymax)
272  ax_theo.set_ylim(0., 100)
273
274  # 2) Ticks labels
275  (date_beg, date_end) = (dates[0], dates[-1])
276  date_fmt = "{:%d-%m}"
277
278  if date_end - date_beg > dt.timedelta(weeks=9):
279    maj_xticks = [x for x, d in zip(xcoord, dates)
280                     if d.weekday() == 0]
281    maj_xlabs  = [date_fmt.format(d) for d in dates
282                     if d.weekday() == 0]
283  else:
284    maj_xticks = [x for x, d in zip(xcoord, dates)]
285    maj_xlabs  = [date_fmt.format(d) for d in dates]
286
287  ax_conso.ticklabel_format(axis="y", style="sci", scilimits=(0, 0))
288
289  ax_conso.set_xticks(xcoord, minor=True)
290  ax_conso.set_xticks(maj_xticks, minor=False)
291  ax_conso.set_xticklabels(
292    maj_xlabs, rotation="vertical", size="x-small"
293  )
294
295  yticks = list(ax_conso.get_yticks())
296  yticks.append(conso_per_day)
297  ax_conso.set_yticks(yticks)
298
299  ax_theo.spines["right"].set_color("firebrick")
300  ax_theo.tick_params(colors="firebrick")
301  ax_theo.yaxis.label.set_color("firebrick")
302
303  ax_conso.axhline(y=conso_per_day, color="blue", alpha=0.5,
304                   label="conso journaliÚre\nidéale (heures)")
305
306  for x, d in zip(xcoord, dates):
307    if d.weekday() == 0 and d.hour == 0:
308      ax_conso.axvline(x=x, color="black", alpha=0.5,
309                       linewidth=0.5, linestyle=":")
310
311  # 3) Define axes title
312  for ax, label in (
313    (ax_conso, "heures"),
314    (ax_theo, "%"),
315  ):
316    ax.set_ylabel(label, fontweight="bold")
317    ax.tick_params(axis="y", labelsize="small")
318
319  # 4) Define plot size
320  fig.subplots_adjust(
321    left=0.08,
322    bottom=0.09,
323    right=0.93,
324    top=0.93,
325  )
326
327  # ... Main title and legend ...
328  # -----------------------------
329  fig.suptitle(title, fontweight="bold", size="large")
330  for ax, loc in (
331    (ax_conso, "upper left"),
332    (ax_theo, "upper right"),
333  ):
334    ax.legend(loc=loc, fontsize="x-small", frameon=False)
335
336
337########################################
338def get_arguments():
339  parser = ArgumentParser()
340  parser.add_argument("-v", "--verbose", action="store_true",
341                      help="verbose mode")
342  parser.add_argument("-f", "--full", action="store_true",
343                      help="plot the whole period")
344  parser.add_argument("-i", "--increment", action="store",
345                      type=int, default=1, dest="inc",
346                      help="sampling increment")
347  parser.add_argument("-r", "--range", action="store", nargs=2,
348                      type=string_to_date,
349                      help="date range: ssaa-mm-jj ssaa-mm-jj")
350  parser.add_argument("-m", "--max", action="store_true",
351                      help="plot with y_max = allocation")
352  parser.add_argument("-s", "--show", action="store_true",
353                      help="interactive mode")
354  parser.add_argument("-d", "--dods", action="store_true",
355                      help="copy output on dods")
356
357  return parser.parse_args()
358
359
360########################################
361if __name__ == '__main__':
362
363  # .. Initialization ..
364  # ====================
365  # ... Command line arguments ...
366  # ------------------------------
367  args = get_arguments()
368
369  # ... Turn interactive mode off ...
370  # ---------------------------------
371  if not args.show:
372    import matplotlib
373    matplotlib.use('Agg')
374
375  import matplotlib.pyplot as plt
376  # from matplotlib.backends.backend_pdf import PdfPages
377
378  if not args.show:
379    plt.ioff()
380
381  # ... Files and directories ...
382  # -----------------------------
383  project_name, DIR, OUT = parse_config("bin/config.ini")
384
385  (file_param, file_utheo, file_data) = \
386      get_input_files(DIR["SAVEDATA"],
387                      [OUT["PARAM"], OUT["UTHEO"], OUT["BILAN"]])
388
389  img_name = os.path.splitext(
390               os.path.basename(__file__)
391             )[0].replace("plot_", "")
392
393  today = os.path.basename(file_param).strip(OUT["PARAM"])
394
395  if args.verbose:
396    fmt_str = "{:10s} : {}"
397    print(fmt_str.format("args", args))
398    print(fmt_str.format("today", today))
399    print(fmt_str.format("file_param", file_param))
400    print(fmt_str.format("file_utheo", file_utheo))
401    print(fmt_str.format("file_data", file_data))
402    print(fmt_str.format("img_name", img_name))
403
404  # .. Get project info ..
405  # ======================
406  projet = Project(project_name)
407  projet.fill_data(file_param)
408  projet.get_date_init(file_utheo)
409
410  # .. Fill in data ..
411  # ==================
412  # ... Initialization ...
413  # ----------------------
414  bilan = DataDict()
415  bilan.init_range(projet.date_init, projet.deadline)
416  # ... Extract data from file ...
417  # ------------------------------
418  bilan.fill_data(file_data)
419  # ... Compute theoratical use from known data  ...
420  # ------------------------------------------------
421  bilan.theo_equation()
422
423  # .. Extract data depending on C.L. arguments ..
424  # ==============================================
425  if args.full:
426    selected_items = bilan.get_items_in_full_range(args.inc)
427  elif args.range:
428    selected_items = bilan.get_items_in_range(
429      args.range[0], args.range[1], args.inc
430    )
431  else:
432    selected_items = bilan.get_items(args.inc)
433
434  # .. Compute data to be plotted ..
435  # ================================
436  nb_items = len(selected_items)
437
438  xcoord = np.linspace(1, nb_items, num=nb_items)
439  dates = [item.date for item in selected_items]
440
441  cumul = np.array([item.conso for item in selected_items],
442                        dtype=float)
443  consos = []
444  consos.append(cumul[0])
445  consos[1:nb_items] = cumul[1:nb_items] - cumul[0:nb_items-1]
446  consos = np.array(consos, dtype=float)
447
448  conso_per_day = projet.alloc / projet.days
449
450  theo_uses = np.array(
451    [100.*item.theo_use for item in selected_items],
452    dtype=float
453  )
454  real_uses = np.array(
455    [100.*item.real_use for item in selected_items],
456    dtype=float
457  )
458  theo_equs = np.array(
459    [100. * bilan.poly_theo(date.timetuple().tm_yday)
460      for date in dates],
461    dtype=float
462  )
463  theo_delay = np.array(
464    [100. * bilan.poly_delay(date.timetuple().tm_yday)
465      for date in dates],
466    dtype=float
467  )
468
469  run_mean = np.array([item.run_mean for item in selected_items],
470                       dtype=float)
471  pen_mean = np.array([item.pen_mean for item in selected_items],
472                       dtype=float)
473  run_std  = np.array([item.run_std for item in selected_items],
474                       dtype=float)
475  pen_std  = np.array([item.pen_std for item in selected_items],
476                       dtype=float)
477
478  # .. Plot stuff ..
479  # ================
480  # ... Initialize figure ...
481  # -------------------------
482  (fig, ax_conso, ax_theo) = plot_init()
483
484  # ... Plot data ...
485  # -----------------
486  plot_data(ax_conso, ax_theo, xcoord, dates,
487            consos, theo_uses, real_uses, theo_equs, theo_delay,
488            run_mean, pen_mean, run_std, pen_std)
489
490  # ... Tweak figure ...
491  # --------------------
492  title = "Consommation {}\n({:%d/%m/%Y} - {:%d/%m/%Y})".format(
493    projet.project.upper(),
494    projet.date_init,
495    projet.deadline
496  )
497
498  plot_config(
499    fig, ax_conso, ax_theo, xcoord, dates, title, conso_per_day
500  )
501
502  # ... Save figure ...
503  # -------------------
504  img_in  = os.path.join(DIR["PLOT"], "{}.pdf".format(img_name))
505  img_out = os.path.join(DIR["SAVEPLOT"],
506                         "{}_{}.pdf".format(img_name, today))
507
508  plot_save(img_in, img_out, title, DIR)
509
510  # ... Publish figure on dods ...
511  # ------------------------------
512  if args.dods:
513    if args.verbose:
514      print("Publish figure on dods")
515    dods_cp(img_in, DIR)
516
517  if args.show:
518    plt.show()
519
520  exit(0)
521
Note: See TracBrowser for help on using the repository browser.