-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
209 lines (195 loc) · 11.8 KB
/
index.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
<!DOCTYPE html>
<html lang='en'> <!-- Opening Tag -->
<head>
<!-- Metadata goes here -->
<meta charset='UTF-8'/>
<link rel="stylesheet" type="text/css" href="./stylesheets/style.css">
<title>pystorms</title>
<meta name="author" content="Abhiram Mullapudi">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<div class="master-container">
<!-- Content -->
<!-- Header -->
<div class='header-container'>
<div class='header-logo'>
<div class='logo'><img src='./images/OS-black.png' style="height:20%;width:20%" alt="Random Storms Logo"/></div>
</div>
<div class='header-menu'>
<div class='documentation'><a href="./docs/build/html/getting_started.html" style="color:black" target="_blank">docs</a></div>
<div class='jupyter notebooks'><a href="#ipynb" style="color:black">jupyer notebooks</a></div>
<div class='repo'><a href="https://github.com/kLabUM/pystorms" style="color:black" target="_blank">repo</a></div>
<div class='about'><a href="#about" style="color:black">about us</a></div>
</div>
</div>
<!-- What is pystorms ?-->
<div class='content-container'>
<h1> pystorms </h1>
<h2> A simulation sandbox for the development and evaluation of stormwater control algorithms </h2>
<br>
<p style="padding-bottom: 0px;padding-top: 5px;font-size: 12pt;">
Welcome! We’ve developed pystorms with the objective of making the research of stormwater control more accessible.
This open-source python package provides a curated collection of diverse stormwater networks and rain events, coupled with a streamlined programming interface and a stormwater simulator to provide a standalone package for developing and evaluating stormwater control algorithms.
Please refer to the manuscript for more details on the motivation behind this effort.
</p>
<h3> Getting Started </h3>
<p style="font-size: 12pt;">
<em> pystorms </em> is available on pypi and can be directly installed using pip.
It is supported on OSX, Linux, and Windows.
<em> pystorms </em> requires python(3+), pyswmm(≥ 0.6.0), numpy(≥ 18.4), and PyYAML(≥ 5.3).
Please raise an issue on the repository or reach out if you encounter any installation issues.
</p>
<br>
<pre style="padding-bottom: 1px;padding-top: 1px; background-color: #f6f5f5;border-radius: 5px;"><code> pip install pystorms</code></pre>
<br>
<p style="font-size: 12pt;">
In <em> pystorms </em>, control of stormwater networks is abstracted as scenarios, named after letters from Greek alphabet.
</p>
<br>
<div style="background: #ffffff;overflow:auto;width:auto;padding:.2em .6em;font-family: Consolas;background-color: #f6f5f5;border-radius: 5px;">
<pre style="margin: 0;line-height: 125%">
<span style="color: #008800; font-weight: bold">import</span> <span style="color: #0e84b5; font-weight: bold">pystorms</span>
<span style="color: #008800; font-weight: bold">def</span> controller(state):
<span style="color: #919191">"""
Your control algorithm that generates actions based on state information.
"""</span>
<span style="color: #008800; font-weight: bold">return</span> actions
env = pystorms.scenarios.theta()
done = <span style="color: #007020">False</span>
<span style="color: #008800; font-weight: bold">while</span> <span style="font-weight: bold">not</span> done:
state = env.state()
actions = controller(state)
done = env.step(actions)
</pre></div>
<br>
<p style="font-size: 12pt;">
Scenario theta is a synthetic example for prototyping control algorithms.
Six other scenarios inspired from real-world stormwater are included to provide realistic examples for evaluating stormwater control algorithms.
Please refer to the <a href="./docs/build/html/Home.html" style="color: #003153" target="_blank">documentation</a> for more details.
</p>
<h3 id="ipynb"> Jupyter Notebooks </h3>
<p style="font-size: 12pt;">
<ul>
<li> Theta: <ul>
<li>
Google Colab: <a href="https://colab.research.google.com/github/kLabUM/pystorms/blob/master/tutorials/Scenario_Theta.ipynb?hl=en" style="color: #003153" target="_blank"> Theta.ipynb</a> </li>
<li>
Github Source: <a href="https://github.com/kLabUM/pystorms/blob/master/tutorials/Scenario_Theta.ipynb" style="color: #003153" target="_blank">Theta.ipynb</a></li>
</ul>
<li> Alpha: <ul>
<li>
Google Colab: <a href="https://colab.research.google.com/github/kLabUM/pystorms/blob/master/tutorials/Scenario_Alpha.ipynb?hl=en" style="color: #003153" target="_blank"> Alpha.ipynb</a> </li>
<li>
Github Source: <a href="https://github.com/kLabUM/pystorms/blob/master/tutorials/Scenario_Alpha.ipynb" style="color: #003153" target="_blank">Alpha.ipynb</a></li>
</ul>
</li>
<li> Beta: <ul>
<li>
Google Colab: <a href="https://colab.research.google.com/github/kLabUM/pystorms/blob/master/tutorials/Scenario_Beta.ipynb?hl=en" style="color: #003153" target="_blank"> Beta.ipynb</a> </li>
<li>
Github Source: <a href="https://github.com/kLabUM/pystorms/blob/master/tutorials/Scenario_Beta.ipynb" style="color: #003153" target="_blank">Beta.ipynb</a></li>
</ul>
</li>
<li> Gamma: <ul>
<li>
Google Colab: <a href="https://colab.research.google.com/github/kLabUM/pystorms/blob/master/tutorials/Scenario_Gamma.ipynb?hl=en" style="color: #003153" target="_blank"> Gamma.ipynb</a> </li>
<li>
Github Source: <a href="https://github.com/kLabUM/pystorms/blob/master/tutorials/Scenario_Gamma.ipynb" style="color: #003153" target="_blank">Gamma.ipynb</a></li>
</ul>
</li>
<li> Delta: <ul>
<li>
Google Colab: <a href="https://colab.research.google.com/github/kLabUM/pystorms/blob/master/tutorials/Scenario_Delta.ipynb?hl=en" style="color: #003153" target="_blank"> Delta.ipynb</a> </li>
<li>
Github Source: <a href="https://github.com/kLabUM/pystorms/blob/master/tutorials/Scenario_Delta.ipynb" style="color: #003153" target="_blank">Delta.ipynb</a></li>
</ul>
</li>
<li> Episilon: <ul>
<li>
Google Colab: <a href="https://colab.research.google.com/github/kLabUM/pystorms/blob/master/tutorials/Scenario_Epsilon.ipynb?hl=en" style="color: #003153" target="_blank"> Eplison.ipynb</a> </li>
<li>
Github Source: <a href="https://github.com/kLabUM/pystorms/blob/master/tutorials/Scenario_Epsilon.ipynb" style="color: #003153" target="_blank">Eplison.ipynb</a></li>
</ul>
</li>
<li> Zeta: <ul>
<li>
Google Colab: <a href="https://colab.research.google.com/github/kLabUM/pystorms/blob/master/tutorials/Scenario_Zeta.ipynb?hl=en" style="color: #003153" target="_blank"> Zeta.ipynb</a> </li>
<li>
Github Source: <a href="https://github.com/kLabUM/pystorms/blob/master/tutorials/Scenario_Zeta.ipynb" style="color: #003153" target="_blank">Zeta.ipynb</a></li>
</ul></li>
</ul>
</p>
<h3 id="ipynb_tutorial"> UDM 2022: UDS-RTC 101 </h3>
<p style="font-size: 12pt;">
<ul>
<li> Presentation : <ul>
<li>
pdf: <a href="./data/UDM2020_PreConf_RTC101.pdf" style="color: #003153" target="_blank"> udm2022_rtc101.pdf</a> </li>
</ul>
<li> pyswmm : <ul>
<li>
Google Colab: <a href="https://colab.research.google.com/github/kLabUM/pystorms/blob/master/tutorials/PySWMM_RTC.ipynb" style="color: #003153" target="_blank"> pyswmm.ipynb</a> </li>
<li>
Github Source: <a href="https://github.com/kLabUM/pystorms/blob/master/tutorials/PySWMM_RTC.ipynb" style="color: #003153" target="_blank">pyswmm.ipynb</a></li>
</ul>
<li> pystorms : <ul>
<li>
Google Colab: <a href="https://colab.research.google.com/github/kLabUM/pystorms/blob/master/tutorials/pystorms_Example.ipynb" style="color: #003153" target="_blank"> pystorms.ipynb</a> </li>
<li>
Github Source: <a href="https://github.com/kLabUM/pystorms/blob/master/tutorials/pystorms_Example.ipynb" style="color: #003153" target="_blank"> pystorms.ipynb</a></li>
</ul>
</li>
<li> Equal Filling : <ul>
<li>
Google Colab: <a href="https://colab.research.google.com/github/kLabUM/pystorms/blob/master/tutorials/Scenario_Gamma.ipynb" style="color: #003153" target="_blank"> EqualFilling.ipynb</a> </li>
<li>
Github Source: <a href="https://github.com/kLabUM/pystorms/blob/master/tutorials/Scenario_Gamma.ipynb" style="color: #003153" target="_blank">EqualFilling.ipynb</a></li>
</ul>
</li>
<li> Bayesian Optimization : <ul>
<li>
Google Colab: <a href="https://colab.research.google.com/github/kLabUM/pystorms/blob/master/tutorials/BayesianOptimization.ipynb" style="color: #003153" target="_blank"> BayesianOptimization.ipynb</a> </li>
<li>
Github Source: <a href="https://github.com/kLabUM/pystorms/blob/master/tutorials/BayesianOptimization.ipynb" style="color: #003153" target="_blank">BayesianOptimization.ipynb</a></li>
</ul></li>
</ul>
</p>
<h3> Get Involved </h3>
<p style="font-size: 12pt;">
If you want to be more involved, please consider the following:
</p>
<ul>
<li>Submit some of your own scenarios to our repository! We are looking to expand this package to include far more networks/scenarios with more diverse control needs and that have been implemented with a variety of different hydraulic simulators.</li>
<li>Download our code and hack into it for whatever other needs you may have! We have built this package to be 100% open-source, so if you want to use it for any other application or need that you see fit, by all means, have at it. While the scenarios were built specifically for direct algorithm performance, we have also provided libraries of many other driving events so that you can customize your own research problem.</li>
<li>Check out our other open-source efforts, including <a href="http://open-storm.org/" style="color: #003153" target="_blank">open-storm.org</a>, where we have built open-source sensor nodes for smart stormwater testing and deployment.</li>
</ul>
<h3> Testimonials </h3>
<div class="testimonials">
<img src='./images/testimonial_famous.png' style="height:23%;width:23%" alt="famous">
<img src='./images/testimonial_lovelace.png' style="height:23%;width:23%" alt="lovelace">
<img src='./images/testimonial_venant.png' style="height:23%;width:23%" alt="venant">
<img src='./images/testimonial_vonNeumann.png' style="height:23%;width:23%" alt="vonNeu">
</div>
<h3 id="about"> About us </h3>
<p style="font-size: 12pt;">
pystorms is developed by the open-storm group, a consortium of universities and industry partners developing open-source solutions for smarter stormwater systems.
</p>
<br>
<div class="testimonials" style="padding-bottom: 5px;padding-top: 5px;">
<a href="https://umich.edu/" target="_blank"><img src="./images/partner_umich.png" alt="University of Michigan" style="height:90pt"></a>
<a href="http://www.virginia.edu/" target="_blank"><img src="./images/partner_uva.png" alt="University of Virginia" style="height:90pt"></a>
<a href="https://www.utk.edu/" target="_blank"><img src="./images/partner_utk.png" alt="University of Tennessee, Knoxville" style="height:90pt"></a>
<a href="https://www.emnet.net/" target="_blank"><img src="./images/partner_emnet.png" alt="Emnet, LLC" style="height:90pt"></a>
</div>
</div>
</div>
<br>
<hr/>
<div class='footer-container'>
<p style="font-size:small;padding-top:px;">
Font design and elements inspired from <a href="https://www.johnsonbanks.co.uk/work/mozilla"> Johnson Banks/<em>mozilla</em></a>, <a href="https://mathpix.com"> mathpix</a>, and <a href="https://edwardtufte.github.io/tufte-css/"> Dave Liepmann </a>
</p>
</div>
</body>
</html> <!-- Closing Tag -->