forked from oie-mines-paristech/lca_algebraic
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbase_utils.html
320 lines (283 loc) · 14.3 KB
/
base_utils.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.7.4" />
<title>lca_algebraic.base_utils API documentation</title>
<meta name="description" content="" />
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>lca_algebraic.base_utils</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">from sys import stderr
import sys
from typing import Union
import brightway2 as bw
from bw2data.backends.peewee import Activity, ExchangeDataset
from sympy import Basic
from sympy.parsing.sympy_parser import parse_expr
import ipywidgets as widgets
from IPython.core.display import display
import numpy as np
DEBUG=False
def debug(*args, **kwargs) :
if DEBUG :
print(*args, **kwargs)
def error(*args, **kwargs):
print(*args, **kwargs, file=stderr)
def _eprint(*args, **kwargs):
print(*args, file=sys.stderr, **kwargs)
def _isnumber(value):
return isinstance(value, int) or isinstance(value, float)
dbs = dict()
def _getDb(dbname) -> bw.Database:
"""Pool of Database instances"""
if not dbname in dbs:
dbs[dbname] = bw.Database(dbname)
return dbs[dbname]
def interpolate(x, x1, x2, y1, y2):
"""Build an expression for linear interpolation between two points.
If x is not within [x1, x2] the corresponding bound Y values are returned"""
x = Min(Max(x, x1), x2)
return y1 + (y2 - y1) * (x - x1) / (x2 - x1)
def Max(a, b) :
"""Max define as algrebraic forumal with 'abs' for proper computation on vectors """
return (a + b + abs(a - b)) / 2
def Min(a, b) :
"""Max define as algrebraic forumal with 'abs' for proper computation on vectors """
return (a + b - abs(b - a)) / 2
def _actDesc(act: Activity):
"""Generate pretty name for activity + basic information """
name = _actName(act)
amount = 1
for ex in act.exchanges() :
if ex['type'] == 'production' :
amount = ex['amount']
return "%s (%f %s)" % (name, amount, act['unit'])
def _method_unit(method) :
return bw.Method(method).metadata['unit']
def _actName(act: Activity):
"""Generate pretty name for activity, appending location if not 'GLO' """
res = act['name']
if act['location'] != 'GLO':
res += "[%s]" % act["location"]
return res
def _getAmountOrFormula(ex: ExchangeDataset) -> Union[Basic, float]:
""" Return either a fixed float value or an expression for the amount of this exchange"""
if 'formula' in ex:
try:
return parse_expr(ex['formula'])
except:
_eprint("Error while parsing formula '%s' : backing to amount" % ex['formula'])
return ex['amount']
def displayWithExportButton(df):
'''Display dataframe with option to export'''
button = widgets.Button(description="Export data")
button.style.button_color = "lightgray"
def click(e) :
df.to_csv("out.csv")
button.description = "exported as 'out.csv'"
dfout = widgets.Output()
with dfout :
display(df)
button.on_click(click)
display(widgets.VBox([button, dfout]))
def as_np_array(a) :
if type(a) == list :
return np.asarray(a)
else :
return a
def r_squared(y, y_hat):
y_bar = y.mean()
ss_tot = ((y - y_bar) ** 2).sum()
ss_res = ((y - y_hat) ** 2).sum()
return 1 - (ss_res / ss_tot)</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="lca_algebraic.base_utils.Max"><code class="name flex">
<span>def <span class="ident">Max</span></span>(<span>a, b)</span>
</code></dt>
<dd>
<section class="desc"><p>Max define as algrebraic forumal with 'abs' for proper computation on vectors</p></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def Max(a, b) :
"""Max define as algrebraic forumal with 'abs' for proper computation on vectors """
return (a + b + abs(a - b)) / 2</code></pre>
</details>
</dd>
<dt id="lca_algebraic.base_utils.Min"><code class="name flex">
<span>def <span class="ident">Min</span></span>(<span>a, b)</span>
</code></dt>
<dd>
<section class="desc"><p>Max define as algrebraic forumal with 'abs' for proper computation on vectors</p></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def Min(a, b) :
"""Max define as algrebraic forumal with 'abs' for proper computation on vectors """
return (a + b - abs(b - a)) / 2</code></pre>
</details>
</dd>
<dt id="lca_algebraic.base_utils.as_np_array"><code class="name flex">
<span>def <span class="ident">as_np_array</span></span>(<span>a)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def as_np_array(a) :
if type(a) == list :
return np.asarray(a)
else :
return a</code></pre>
</details>
</dd>
<dt id="lca_algebraic.base_utils.debug"><code class="name flex">
<span>def <span class="ident">debug</span></span>(<span>*args, **kwargs)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def debug(*args, **kwargs) :
if DEBUG :
print(*args, **kwargs)</code></pre>
</details>
</dd>
<dt id="lca_algebraic.base_utils.displayWithExportButton"><code class="name flex">
<span>def <span class="ident">displayWithExportButton</span></span>(<span>df)</span>
</code></dt>
<dd>
<section class="desc"><p>Display dataframe with option to export</p></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def displayWithExportButton(df):
'''Display dataframe with option to export'''
button = widgets.Button(description="Export data")
button.style.button_color = "lightgray"
def click(e) :
df.to_csv("out.csv")
button.description = "exported as 'out.csv'"
dfout = widgets.Output()
with dfout :
display(df)
button.on_click(click)
display(widgets.VBox([button, dfout]))</code></pre>
</details>
</dd>
<dt id="lca_algebraic.base_utils.error"><code class="name flex">
<span>def <span class="ident">error</span></span>(<span>*args, **kwargs)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def error(*args, **kwargs):
print(*args, **kwargs, file=stderr)</code></pre>
</details>
</dd>
<dt id="lca_algebraic.base_utils.interpolate"><code class="name flex">
<span>def <span class="ident">interpolate</span></span>(<span>x, x1, x2, y1, y2)</span>
</code></dt>
<dd>
<section class="desc"><p>Build an expression for linear interpolation between two points.
If x is not within [x1, x2] the corresponding bound Y values are returned</p></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def interpolate(x, x1, x2, y1, y2):
"""Build an expression for linear interpolation between two points.
If x is not within [x1, x2] the corresponding bound Y values are returned"""
x = Min(Max(x, x1), x2)
return y1 + (y2 - y1) * (x - x1) / (x2 - x1)</code></pre>
</details>
</dd>
<dt id="lca_algebraic.base_utils.r_squared"><code class="name flex">
<span>def <span class="ident">r_squared</span></span>(<span>y, y_hat)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def r_squared(y, y_hat):
y_bar = y.mean()
ss_tot = ((y - y_bar) ** 2).sum()
ss_res = ((y - y_hat) ** 2).sum()
return 1 - (ss_res / ss_tot)</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="lca_algebraic" href="index.html">lca_algebraic</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="lca_algebraic.base_utils.Max" href="#lca_algebraic.base_utils.Max">Max</a></code></li>
<li><code><a title="lca_algebraic.base_utils.Min" href="#lca_algebraic.base_utils.Min">Min</a></code></li>
<li><code><a title="lca_algebraic.base_utils.as_np_array" href="#lca_algebraic.base_utils.as_np_array">as_np_array</a></code></li>
<li><code><a title="lca_algebraic.base_utils.debug" href="#lca_algebraic.base_utils.debug">debug</a></code></li>
<li><code><a title="lca_algebraic.base_utils.displayWithExportButton" href="#lca_algebraic.base_utils.displayWithExportButton">displayWithExportButton</a></code></li>
<li><code><a title="lca_algebraic.base_utils.error" href="#lca_algebraic.base_utils.error">error</a></code></li>
<li><code><a title="lca_algebraic.base_utils.interpolate" href="#lca_algebraic.base_utils.interpolate">interpolate</a></code></li>
<li><code><a title="lca_algebraic.base_utils.r_squared" href="#lca_algebraic.base_utils.r_squared">r_squared</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad()</script>
</body>
</html>