Karim Sabri / ctools

Commit fd9f985e67d0707bcc13b51379e034651bae88a5

Authored by Jürgen Knödlseder
1 parent feef62e1

Update user manual for csfootprint

Inline Side-by-side
Showing 3 changed files with 163 additions and 89 deletions
cscripts/csfootprint.py
  View file @fd9f985
... ... @@ -600,7 +600,7 @@ class csfootprint(ctools.cscript):
600 600 fig.text(0.5, 0.925, subtitle, fontsize=11, ha='center')
601 601  
602 602 # Set plot margins
603   - fig.subplots_adjust(left=0.07, bottom=0.07, right=0.97, top=0.88,
  603 + fig.subplots_adjust(left=0.08, bottom=0.07, right=0.97, top=0.88,
604 604 wspace=0.1, hspace=0.2)
605 605  
606 606 # Divide figure
... ...
doc/source/users/environment.rst
  View file @fd9f985
... ... @@ -71,93 +71,167 @@ display the content of this file using the ``csfootprint`` script:
71 71 Stop time for report (UTC string, JD, MJD or MET in seconds) [NONE]
72 72 Output graphics file (NONE if no graphics should be generated) [NONE]
73 73 ...
74   - 2022-02-20T14:38:29: +===================+
75   - 2022-02-20T14:38:29: | Global statistics |
76   - 2022-02-20T14:38:29: +===================+
77   - 2022-02-20T14:38:29: Creation date .............: 2022-02-19T22:09:05
78   - 2022-02-20T14:38:29: Last statistics update ....: 2022-02-20T14:35:20
79   - 2022-02-20T14:38:29: Statistics date interval ..: 2022-02-18T22:21:56 - 2022-02-20T14:35:17
80   - 2022-02-20T14:38:29: Used date interval ........: 2022-02-18T22:21:56 - 2022-02-20T14:35:17
81   - 2022-02-20T14:38:29: Duration of used interval .: 40.222 hours
82   - 2022-02-20T14:38:29: Total number of ctool runs : 3104
83   - 2022-02-20T14:38:29: Total wall clock time .....: 34.200 minutes
84   - 2022-02-20T14:38:29: Total CPU time ............: 27.543 minutes
85   - 2022-02-20T14:38:29: Average CPU load ..........: 80.5 %
86   - 2022-02-20T14:38:29: Total carbon footprint ....: 1.623 g CO2e
87   - 2022-02-20T14:38:29: Average carbon intensity ..: 3.535 g CO2e / CPU hour
88   - 2022-02-20T14:38:29: Average daily footprint ...: 0.968 g CO2e / day
89   - 2022-02-20T14:38:29: Expected annual footprint .: 353.632 g CO2e / year
90   - 2022-02-20T14:38:29:
91   - 2022-02-20T14:38:29: +==================+
92   - 2022-02-20T14:38:29: | Daily statistics |
93   - 2022-02-20T14:38:29: +==================+
94   - 2022-02-20T14:38:29: === Carbon footprint ===
95   - 2022-02-20T14:38:29: 2022-02-18 ................: 1.336 g CO2e
96   - 2022-02-20T14:38:29: 2022-02-19 ................: 0.010 g CO2e
97   - 2022-02-20T14:38:29: 2022-02-20 ................: 0.277 g CO2e
98   - 2022-02-20T14:38:29: === ctools or cscript calls ===
99   - 2022-02-20T14:38:29: 2022-02-18 ................: 2895
100   - 2022-02-20T14:38:29: 2022-02-19 ................: 80
101   - 2022-02-20T14:38:29: 2022-02-20 ................: 129
102   - 2022-02-20T14:38:29: === Used wall clock time ===
103   - 2022-02-20T14:38:29: 2022-02-18 ................: 25.483 minutes
104   - 2022-02-20T14:38:29: 2022-02-19 ................: 1.033 minutes
105   - 2022-02-20T14:38:29: 2022-02-20 ................: 7.683 minutes
106   - 2022-02-20T14:38:29: === Used CPU time ===
107   - 2022-02-20T14:38:29: 2022-02-18 ................: 22.682 minutes
108   - 2022-02-20T14:38:29: 2022-02-19 ................: 9.895 seconds
109   - 2022-02-20T14:38:29: 2022-02-20 ................: 4.695 minutes
110   - 2022-02-20T14:38:29:
111   - 2022-02-20T14:38:29: +================================+
112   - 2022-02-20T14:38:29: | ctools and cscripts statistics |
113   - 2022-02-20T14:38:29: +================================+
114   - 2022-02-20T14:38:29: === Carbon footprint ===
115   - 2022-02-20T14:38:29: ctlike ....................: 0.318 g CO2e
116   - 2022-02-20T14:38:29: cspull ....................: 0.186 g CO2e
117   - 2022-02-20T14:38:29: csbkgmodel ................: 0.178 g CO2e
118   - 2022-02-20T14:38:29: ctobssim ..................: 0.172 g CO2e
119   - 2022-02-20T14:38:29: ctobssim ..................: 0.087 g CO2e
120   - 2022-02-20T14:38:29: comobsbin .................: 0.081 g CO2e
121   - 2022-02-20T14:38:29: comlixmap .................: 0.069 g CO2e
122   - 2022-02-20T14:38:29: ctulimit ..................: 0.064 g CO2e
123   - 2022-02-20T14:38:29: cstsdist ..................: 0.058 g CO2e
124   - 2022-02-20T14:38:29: ctselect ..................: 0.044 g CO2e
125   - 2022-02-20T14:38:29: ... (list truncated after 10 entries) ...
126   - 2022-02-20T14:38:29: === ctools or cscript calls ===
127   - 2022-02-20T14:38:29: ctobssim ..................: 1795
128   - 2022-02-20T14:38:29: ctlike ....................: 220
129   - 2022-02-20T14:38:29: ctselect ..................: 87
130   - 2022-02-20T14:38:29: csfootprint ...............: 80
131   - 2022-02-20T14:38:29: cscaldb ...................: 79
132   - 2022-02-20T14:38:29: csscs .....................: 55
133   - 2022-02-20T14:38:29: ctulimit ..................: 54
134   - 2022-02-20T14:38:29: ctcubemask ................: 51
135   - 2022-02-20T14:38:29: csphagen ..................: 46
136   - 2022-02-20T14:38:29: ctbin .....................: 31
137   - 2022-02-20T14:38:29: ... (list truncated after 10 entries) ...
138   - 2022-02-20T14:38:29: === Used wall clock time ===
139   - 2022-02-20T14:38:29: ctlike ....................: 5.367 minutes
140   - 2022-02-20T14:38:29: cspull ....................: 3.817 minutes
141   - 2022-02-20T14:38:29: csbkgmodel ................: 3.067 minutes
142   - 2022-02-20T14:38:29: ctobssim ..................: 2.967 minutes
143   - 2022-02-20T14:38:29: csfootprint ...............: 2.300 minutes
144   - 2022-02-20T14:38:29: ctobssim ..................: 1.483 minutes
145   - 2022-02-20T14:38:29: comobsbin .................: 1.367 minutes
146   - 2022-02-20T14:38:29: cstsdist ..................: 1.300 minutes
147   - 2022-02-20T14:38:29: comlixmap .................: 1.183 minutes
148   - 2022-02-20T14:38:29: ctselect ..................: 1.083 minutes
149   - 2022-02-20T14:38:29: ... (list truncated after 10 entries) ...
150   - 2022-02-20T14:38:29: === Used CPU time ===
151   - 2022-02-20T14:38:29: ctlike ....................: 5.392 minutes
152   - 2022-02-20T14:38:29: cspull ....................: 3.157 minutes
153   - 2022-02-20T14:38:29: csbkgmodel ................: 3.029 minutes
154   - 2022-02-20T14:38:29: ctobssim ..................: 2.921 minutes
155   - 2022-02-20T14:38:29: ctobssim ..................: 1.469 minutes
156   - 2022-02-20T14:38:29: comobsbin .................: 1.367 minutes
157   - 2022-02-20T14:38:29: comlixmap .................: 1.169 minutes
158   - 2022-02-20T14:38:29: ctulimit ..................: 1.086 minutes
159   - 2022-02-20T14:38:29: cstsdist ..................: 58.978 seconds
160   - 2022-02-20T14:38:29: ctselect ..................: 45.005 seconds
161   - 2022-02-20T14:38:29: ... (list truncated after 10 entries) ...
  74 + 2022-03-11T15:12:58: +===================+
  75 + 2022-03-11T15:12:58: | Global statistics |
  76 + 2022-03-11T15:12:58: +===================+
  77 + 2022-03-11T15:12:58: Creation date .............: 2022-02-21T10:55:46
  78 + 2022-03-11T15:12:58: Last statistics update ....: 2022-03-11T15:11:43
  79 + 2022-03-11T15:12:58: Statistics date interval ..: 2022-02-21T09:55:58 - 2022-03-11T15:08:00
  80 + 2022-03-11T15:12:58: Used date interval ........: 2022-02-21T09:55:58 - 2022-03-11T15:08:00
  81 + 2022-03-11T15:12:58: Duration of used interval .: 437.2 hours
  82 + 2022-03-11T15:12:58: Total number of ctool runs : 61250
  83 + 2022-03-11T15:12:58: Total wall clock time .....: 9418.0 hours
  84 + 2022-03-11T15:12:58: Total CPU time ............: 9418.2 hours
  85 + 2022-03-11T15:12:58: Average CPU load ..........: 100.0 %
  86 + 2022-03-11T15:12:58: Total carbon footprint ....: 33.3 kg CO2e
  87 + 2022-03-11T15:12:58: due to power consumption .: 12.1 kg CO2e (57.1 g CO2e / kWh)
  88 + 2022-03-11T15:12:58: due to infrastructure ....: 21.2 kg CO2e
  89 + 2022-03-11T15:12:58: Average carbon intensity ..: 3.5 g CO2e / CPU hour
  90 + 2022-03-11T15:12:58: Average daily footprint ...: 1.8 kg CO2e / day
  91 + 2022-03-11T15:12:58: Expected annual footprint .: 667.5 kg CO2e / year
  92 + 2022-03-11T15:12:58:
  93 + 2022-03-11T15:12:58: +==================+
  94 + 2022-03-11T15:12:58: | Daily statistics |
  95 + 2022-03-11T15:12:58: +==================+
  96 + 2022-03-11T15:12:58: === Carbon footprint ===
  97 + 2022-03-11T15:12:58: 2022-02-21 ................: 3.6 g CO2e
  98 + 2022-03-11T15:12:58: 2022-02-22 ................: 239.6 g CO2e
  99 + 2022-03-11T15:12:58: 2022-02-23 ................: 1.4 kg CO2e
  100 + 2022-03-11T15:12:58: 2022-02-24 ................: 2.1 kg CO2e
  101 + 2022-03-11T15:12:58: 2022-02-25 ................: 2.2 kg CO2e
  102 + 2022-03-11T15:12:58: 2022-02-26 ................: 2.6 kg CO2e
  103 + 2022-03-11T15:12:58: 2022-02-27 ................: 2.6 kg CO2e
  104 + 2022-03-11T15:12:58: 2022-02-28 ................: 2.2 kg CO2e
  105 + 2022-03-11T15:12:58: 2022-03-01 ................: 1.9 kg CO2e
  106 + 2022-03-11T15:12:58: 2022-03-02 ................: 1.2 kg CO2e
  107 + 2022-03-11T15:12:58: 2022-03-03 ................: 853.8 g CO2e
  108 + 2022-03-11T15:12:58: 2022-03-04 ................: 723.2 g CO2e
  109 + 2022-03-11T15:12:58: 2022-03-05 ................: 372.5 g CO2e
  110 + 2022-03-11T15:12:58: 2022-03-06 ................: 300.7 g CO2e
  111 + 2022-03-11T15:12:58: 2022-03-08 ................: 1.9 kg CO2e
  112 + 2022-03-11T15:12:58: 2022-03-09 ................: 4.1 kg CO2e
  113 + 2022-03-11T15:12:58: 2022-03-10 ................: 6.0 kg CO2e
  114 + 2022-03-11T15:12:58: 2022-03-11 ................: 2.8 kg CO2e
  115 + 2022-03-11T15:12:58: === ctools or cscript calls ===
  116 + 2022-03-11T15:12:58: 2022-02-21 ................: 52
  117 + 2022-03-11T15:12:58: 2022-02-22 ................: 545
  118 + 2022-03-11T15:12:58: 2022-02-23 ................: 2372
  119 + 2022-03-11T15:12:58: 2022-02-24 ................: 3097
  120 + 2022-03-11T15:12:58: 2022-02-25 ................: 3520
  121 + 2022-03-11T15:12:58: 2022-02-26 ................: 3813
  122 + 2022-03-11T15:12:58: 2022-02-27 ................: 3606
  123 + 2022-03-11T15:12:58: 2022-02-28 ................: 2985
  124 + 2022-03-11T15:12:58: 2022-03-01 ................: 2412
  125 + 2022-03-11T15:12:58: 2022-03-02 ................: 1322
  126 + 2022-03-11T15:12:58: 2022-03-03 ................: 911
  127 + 2022-03-11T15:12:58: 2022-03-04 ................: 747
  128 + 2022-03-11T15:12:58: 2022-03-05 ................: 356
  129 + 2022-03-11T15:12:58: 2022-03-06 ................: 284
  130 + 2022-03-11T15:12:58: 2022-03-08 ................: 5850
  131 + 2022-03-11T15:12:58: 2022-03-09 ................: 11850
  132 + 2022-03-11T15:12:58: 2022-03-10 ................: 13015
  133 + 2022-03-11T15:12:58: 2022-03-11 ................: 4513
  134 + 2022-03-11T15:12:58: === Used wall clock time ===
  135 + 2022-03-11T15:12:58: 2022-02-21 ................: 51.2 minutes
  136 + 2022-03-11T15:12:58: 2022-02-22 ................: 67.8 hours
  137 + 2022-03-11T15:12:58: 2022-02-23 ................: 400.1 hours
  138 + 2022-03-11T15:12:58: 2022-02-24 ................: 584.9 hours
  139 + 2022-03-11T15:12:58: 2022-02-25 ................: 625.2 hours
  140 + 2022-03-11T15:12:58: 2022-02-26 ................: 732.0 hours
  141 + 2022-03-11T15:12:58: 2022-02-27 ................: 723.2 hours
  142 + 2022-03-11T15:12:58: 2022-02-28 ................: 621.0 hours
  143 + 2022-03-11T15:12:58: 2022-03-01 ................: 524.5 hours
  144 + 2022-03-11T15:12:58: 2022-03-02 ................: 329.3 hours
  145 + 2022-03-11T15:12:58: 2022-03-03 ................: 241.6 hours
  146 + 2022-03-11T15:12:58: 2022-03-04 ................: 204.6 hours
  147 + 2022-03-11T15:12:58: 2022-03-05 ................: 105.4 hours
  148 + 2022-03-11T15:12:58: 2022-03-06 ................: 85.1 hours
  149 + 2022-03-11T15:12:58: 2022-03-08 ................: 535.9 hours
  150 + 2022-03-11T15:12:58: 2022-03-09 ................: 1159.5 hours
  151 + 2022-03-11T15:12:58: 2022-03-10 ................: 1693.2 hours
  152 + 2022-03-11T15:12:58: 2022-03-11 ................: 783.9 hours
  153 + 2022-03-11T15:12:58: === Used CPU time ===
  154 + 2022-03-11T15:12:58: 2022-02-21 ................: 1.0 hours
  155 + 2022-03-11T15:12:58: 2022-02-22 ................: 67.8 hours
  156 + 2022-03-11T15:12:58: 2022-02-23 ................: 400.1 hours
  157 + 2022-03-11T15:12:58: 2022-02-24 ................: 584.9 hours
  158 + 2022-03-11T15:12:58: 2022-02-25 ................: 625.2 hours
  159 + 2022-03-11T15:12:58: 2022-02-26 ................: 732.0 hours
  160 + 2022-03-11T15:12:58: 2022-02-27 ................: 723.2 hours
  161 + 2022-03-11T15:12:58: 2022-02-28 ................: 621.0 hours
  162 + 2022-03-11T15:12:58: 2022-03-01 ................: 524.5 hours
  163 + 2022-03-11T15:12:58: 2022-03-02 ................: 329.3 hours
  164 + 2022-03-11T15:12:58: 2022-03-03 ................: 241.6 hours
  165 + 2022-03-11T15:12:58: 2022-03-04 ................: 204.6 hours
  166 + 2022-03-11T15:12:58: 2022-03-05 ................: 105.4 hours
  167 + 2022-03-11T15:12:58: 2022-03-06 ................: 85.1 hours
  168 + 2022-03-11T15:12:58: 2022-03-08 ................: 535.9 hours
  169 + 2022-03-11T15:12:58: 2022-03-09 ................: 1159.5 hours
  170 + 2022-03-11T15:12:58: 2022-03-10 ................: 1693.2 hours
  171 + 2022-03-11T15:12:58: 2022-03-11 ................: 783.9 hours
  172 + 2022-03-11T15:12:58:
  173 + 2022-03-11T15:12:58: +================================+
  174 + 2022-03-11T15:12:58: | ctools and cscripts statistics |
  175 + 2022-03-11T15:12:58: +================================+
  176 + 2022-03-11T15:12:58: === Carbon footprint ===
  177 + 2022-03-11T15:12:58: comobsback ................: 13.5 kg CO2e
  178 + 2022-03-11T15:12:58: comlixfit .................: 8.1 kg CO2e
  179 + 2022-03-11T15:12:58: comobsmodel ...............: 5.2 kg CO2e
  180 + 2022-03-11T15:12:58: comobsres .................: 5.2 kg CO2e
  181 + 2022-03-11T15:12:58: comlixmap .................: 364.9 g CO2e
  182 + 2022-03-11T15:12:58: ctlike ....................: 319.7 g CO2e
  183 + 2022-03-11T15:12:58: cttsmap ...................: 205.8 g CO2e
  184 + 2022-03-11T15:12:58: comobsbin .................: 165.1 g CO2e
  185 + 2022-03-11T15:12:58: csspec ....................: 130.7 g CO2e
  186 + 2022-03-11T15:12:58: comobssim .................: 116.1 g CO2e
  187 + 2022-03-11T15:12:58: ... (list truncated after 10 entries) ...
  188 + 2022-03-11T15:12:58: === ctools or cscript calls ===
  189 + 2022-03-11T15:12:58: comobsbin .................: 15352
  190 + 2022-03-11T15:12:58: comobsmodel ...............: 14856
  191 + 2022-03-11T15:12:58: comobsback ................: 11439
  192 + 2022-03-11T15:12:58: comobsres .................: 11428
  193 + 2022-03-11T15:12:58: comlixfit .................: 3525
  194 + 2022-03-11T15:12:58: comobssim .................: 3458
  195 + 2022-03-11T15:12:58: ctlike ....................: 1048
  196 + 2022-03-11T15:12:58: cscaldb ...................: 63
  197 + 2022-03-11T15:12:58: comobsselect ..............: 20
  198 + 2022-03-11T15:12:58: csfootprint ...............: 17
  199 + 2022-03-11T15:12:58: ... (list truncated after 10 entries) ...
  200 + 2022-03-11T15:12:58: === Used wall clock time ===
  201 + 2022-03-11T15:12:58: comobsback ................: 3810.6 hours
  202 + 2022-03-11T15:12:58: comlixfit .................: 2282.3 hours
  203 + 2022-03-11T15:12:58: comobsmodel ...............: 1480.6 hours
  204 + 2022-03-11T15:12:58: comobsres .................: 1471.7 hours
  205 + 2022-03-11T15:12:58: comlixmap .................: 103.2 hours
  206 + 2022-03-11T15:12:58: ctlike ....................: 90.4 hours
  207 + 2022-03-11T15:12:58: cttsmap ...................: 58.2 hours
  208 + 2022-03-11T15:12:58: comobsbin .................: 46.7 hours
  209 + 2022-03-11T15:12:58: csspec ....................: 37.0 hours
  210 + 2022-03-11T15:12:58: comobssim .................: 32.9 hours
  211 + 2022-03-11T15:12:58: ... (list truncated after 10 entries) ...
  212 + 2022-03-11T15:12:58: === Used CPU time ===
  213 + 2022-03-11T15:12:58: comobsback ................: 3810.6 hours
  214 + 2022-03-11T15:12:58: comlixfit .................: 2282.3 hours
  215 + 2022-03-11T15:12:58: comobsmodel ...............: 1480.7 hours
  216 + 2022-03-11T15:12:58: comobsres .................: 1471.7 hours
  217 + 2022-03-11T15:12:58: comlixmap .................: 103.2 hours
  218 + 2022-03-11T15:12:58: ctlike ....................: 90.4 hours
  219 + 2022-03-11T15:12:58: cttsmap ...................: 58.2 hours
  220 + 2022-03-11T15:12:58: comobsbin .................: 46.7 hours
  221 + 2022-03-11T15:12:58: csspec ....................: 37.0 hours
  222 + 2022-03-11T15:12:58: comobssim .................: 32.9 hours
  223 + 2022-03-11T15:12:58: ... (list truncated after 10 entries) ...
  224 +
  225 +The ``csfootprint`` script optionally generates a graphical representation
  226 +of the carbon footprint if a file name other than ``NONE`` is provided for the
  227 +output graphics file. The ``matplotlib`` Python module is required to produce
  228 +the representation. If the module is not installed the graphical output will
  229 +be skipped. Below is an example of graphics produced by ``csfootprint``:
  230 +
  231 +.. figure:: footprint.png
  232 + :width: 800px
  233 + :align: center
  234 +
  235 + *Carbon footprint statistics generated by csfootprint*
162 236  
163 237  
... ...
doc/source/users/footprint.png 0 → 100644
View file @fd9f985

281 KB