This file is indexed.

/usr/share/doc/python-simpy3-doc/html/examples/gas_station_refuel.html is in python-simpy3-doc 3.0.7+dfsg-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Gas Station Refueling &mdash; SimPy 3.0.7 documentation</title>
    
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '3.0.7',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="shortcut icon" href="../_static/favicon.ico"/>
    <link rel="top" title="SimPy 3.0.7 documentation" href="../index.html" />
    <link rel="up" title="Examples" href="index.html" />
    <link rel="next" title="Process Communication" href="process_communication.html" />
    <link rel="prev" title="Movie Renege" href="movie_renege.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="process_communication.html" title="Process Communication"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="movie_renege.html" title="Movie Renege"
             accesskey="P">previous</a> |</li>
        <li><a href="../contents.html">SimPy 3.0.7 documentation</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">Examples</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="gas-station-refueling">
<h1>Gas Station Refueling<a class="headerlink" href="#gas-station-refueling" title="Permalink to this headline"></a></h1>
<p>Covers:</p>
<ul class="simple">
<li>Resources: Resource</li>
<li>Resources: Container</li>
<li>Waiting for other processes</li>
</ul>
<p>This examples models a gas station and cars that arrive at the station for
refueling.</p>
<p>The gas station has a limited number of fuel pumps and a fuel tank that is
shared between the fuel pumps. The gas station is thus modeled as
<a class="reference internal" href="../api_reference/simpy.resources.html#simpy.resources.resource.Resource" title="simpy.resources.resource.Resource"><tt class="xref py py-class docutils literal"><span class="pre">Resource</span></tt></a>. The shared fuel tank is modeled
with a <a class="reference internal" href="../api_reference/simpy.resources.html#simpy.resources.container.Container" title="simpy.resources.container.Container"><tt class="xref py py-class docutils literal"><span class="pre">Container</span></tt></a>.</p>
<p>Vehicles arriving at the gas station first request a fuel pump from the
station. Once they acquire one, they try to take the desired amount of fuel
from the fuel pump. They leave when they are done.</p>
<p>The gas stations fuel level is reqularly monitored by <em>gas station control</em>.
When the level drops below a certain threshold, a <em>tank truck</em> is called to
refuel the gas station itself.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Gas Station Refueling example</span>

<span class="sd">Covers:</span>

<span class="sd">- Resources: Resource</span>
<span class="sd">- Resources: Container</span>
<span class="sd">- Waiting for other processes</span>

<span class="sd">Scenario:</span>
<span class="sd">  A gas station has a limited number of gas pumps that share a common</span>
<span class="sd">  fuel reservoir. Cars randomly arrive at the gas station, request one</span>
<span class="sd">  of the fuel pumps and start refueling from that reservoir.</span>

<span class="sd">  A gas station control process observes the gas station&#39;s fuel level</span>
<span class="sd">  and calls a tank truck for refueling if the station&#39;s level drops</span>
<span class="sd">  below a threshold.</span>

<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">itertools</span>
<span class="kn">import</span> <span class="nn">random</span>

<span class="kn">import</span> <span class="nn">simpy</span>


<span class="n">RANDOM_SEED</span> <span class="o">=</span> <span class="mi">42</span>
<span class="n">GAS_STATION_SIZE</span> <span class="o">=</span> <span class="mi">200</span>     <span class="c"># liters</span>
<span class="n">THRESHOLD</span> <span class="o">=</span> <span class="mi">10</span>             <span class="c"># Threshold for calling the tank truck (in %)</span>
<span class="n">FUEL_TANK_SIZE</span> <span class="o">=</span> <span class="mi">50</span>        <span class="c"># liters</span>
<span class="n">FUEL_TANK_LEVEL</span> <span class="o">=</span> <span class="p">[</span><span class="mi">5</span><span class="p">,</span> <span class="mi">25</span><span class="p">]</span>  <span class="c"># Min/max levels of fuel tanks (in liters)</span>
<span class="n">REFUELING_SPEED</span> <span class="o">=</span> <span class="mi">2</span>        <span class="c"># liters / second</span>
<span class="n">TANK_TRUCK_TIME</span> <span class="o">=</span> <span class="mi">300</span>      <span class="c"># Seconds it takes the tank truck to arrive</span>
<span class="n">T_INTER</span> <span class="o">=</span> <span class="p">[</span><span class="mi">30</span><span class="p">,</span> <span class="mi">300</span><span class="p">]</span>        <span class="c"># Create a car every [min, max] seconds</span>
<span class="n">SIM_TIME</span> <span class="o">=</span> <span class="mi">1000</span>            <span class="c"># Simulation time in seconds</span>


<span class="k">def</span> <span class="nf">car</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">env</span><span class="p">,</span> <span class="n">gas_station</span><span class="p">,</span> <span class="n">fuel_pump</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;A car arrives at the gas station for refueling.</span>

<span class="sd">    It requests one of the gas station&#39;s fuel pumps and tries to get the</span>
<span class="sd">    desired amount of gas from it. If the stations reservoir is</span>
<span class="sd">    depleted, the car has to wait for the tank truck to arrive.</span>

<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">fuel_tank_level</span> <span class="o">=</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="o">*</span><span class="n">FUEL_TANK_LEVEL</span><span class="p">)</span>
    <span class="k">print</span><span class="p">(</span><span class="s">&#39;</span><span class="si">%s</span><span class="s"> arriving at gas station at </span><span class="si">%.1f</span><span class="s">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">env</span><span class="o">.</span><span class="n">now</span><span class="p">))</span>
    <span class="k">with</span> <span class="n">gas_station</span><span class="o">.</span><span class="n">request</span><span class="p">()</span> <span class="k">as</span> <span class="n">req</span><span class="p">:</span>
        <span class="n">start</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">now</span>
        <span class="c"># Request one of the gas pumps</span>
        <span class="k">yield</span> <span class="n">req</span>

        <span class="c"># Get the required amount of fuel</span>
        <span class="n">liters_required</span> <span class="o">=</span> <span class="n">FUEL_TANK_SIZE</span> <span class="o">-</span> <span class="n">fuel_tank_level</span>
        <span class="k">yield</span> <span class="n">fuel_pump</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">liters_required</span><span class="p">)</span>

        <span class="c"># The &quot;actual&quot; refueling process takes some time</span>
        <span class="k">yield</span> <span class="n">env</span><span class="o">.</span><span class="n">timeout</span><span class="p">(</span><span class="n">liters_required</span> <span class="o">/</span> <span class="n">REFUELING_SPEED</span><span class="p">)</span>

        <span class="k">print</span><span class="p">(</span><span class="s">&#39;</span><span class="si">%s</span><span class="s"> finished refueling in </span><span class="si">%.1f</span><span class="s"> seconds.&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span>
                                                          <span class="n">env</span><span class="o">.</span><span class="n">now</span> <span class="o">-</span> <span class="n">start</span><span class="p">))</span>


<span class="k">def</span> <span class="nf">gas_station_control</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">fuel_pump</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Periodically check the level of the *fuel_pump* and call the tank</span>
<span class="sd">    truck if the level falls below a threshold.&quot;&quot;&quot;</span>
    <span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
        <span class="k">if</span> <span class="n">fuel_pump</span><span class="o">.</span><span class="n">level</span> <span class="o">/</span> <span class="n">fuel_pump</span><span class="o">.</span><span class="n">capacity</span> <span class="o">*</span> <span class="mi">100</span> <span class="o">&lt;</span> <span class="n">THRESHOLD</span><span class="p">:</span>
            <span class="c"># We need to call the tank truck now!</span>
            <span class="k">print</span><span class="p">(</span><span class="s">&#39;Calling tank truck at </span><span class="si">%d</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">env</span><span class="o">.</span><span class="n">now</span><span class="p">)</span>
            <span class="c"># Wait for the tank truck to arrive and refuel the station</span>
            <span class="k">yield</span> <span class="n">env</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">tank_truck</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">fuel_pump</span><span class="p">))</span>

        <span class="k">yield</span> <span class="n">env</span><span class="o">.</span><span class="n">timeout</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>  <span class="c"># Check every 10 seconds</span>


<span class="k">def</span> <span class="nf">tank_truck</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">fuel_pump</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Arrives at the gas station after a certain delay and refuels it.&quot;&quot;&quot;</span>
    <span class="k">yield</span> <span class="n">env</span><span class="o">.</span><span class="n">timeout</span><span class="p">(</span><span class="n">TANK_TRUCK_TIME</span><span class="p">)</span>
    <span class="k">print</span><span class="p">(</span><span class="s">&#39;Tank truck arriving at time </span><span class="si">%d</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">env</span><span class="o">.</span><span class="n">now</span><span class="p">)</span>
    <span class="n">ammount</span> <span class="o">=</span> <span class="n">fuel_pump</span><span class="o">.</span><span class="n">capacity</span> <span class="o">-</span> <span class="n">fuel_pump</span><span class="o">.</span><span class="n">level</span>
    <span class="k">print</span><span class="p">(</span><span class="s">&#39;Tank truck refuelling </span><span class="si">%.1f</span><span class="s"> liters.&#39;</span> <span class="o">%</span> <span class="n">ammount</span><span class="p">)</span>
    <span class="k">yield</span> <span class="n">fuel_pump</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">ammount</span><span class="p">)</span>


<span class="k">def</span> <span class="nf">car_generator</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">gas_station</span><span class="p">,</span> <span class="n">fuel_pump</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Generate new cars that arrive at the gas station.&quot;&quot;&quot;</span>
    <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">itertools</span><span class="o">.</span><span class="n">count</span><span class="p">():</span>
        <span class="k">yield</span> <span class="n">env</span><span class="o">.</span><span class="n">timeout</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="o">*</span><span class="n">T_INTER</span><span class="p">))</span>
        <span class="n">env</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">car</span><span class="p">(</span><span class="s">&#39;Car </span><span class="si">%d</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">i</span><span class="p">,</span> <span class="n">env</span><span class="p">,</span> <span class="n">gas_station</span><span class="p">,</span> <span class="n">fuel_pump</span><span class="p">))</span>


<span class="c"># Setup and start the simulation</span>
<span class="k">print</span><span class="p">(</span><span class="s">&#39;Gas Station refuelling&#39;</span><span class="p">)</span>
<span class="n">random</span><span class="o">.</span><span class="n">seed</span><span class="p">(</span><span class="n">RANDOM_SEED</span><span class="p">)</span>

<span class="c"># Create environment and start processes</span>
<span class="n">env</span> <span class="o">=</span> <span class="n">simpy</span><span class="o">.</span><span class="n">Environment</span><span class="p">()</span>
<span class="n">gas_station</span> <span class="o">=</span> <span class="n">simpy</span><span class="o">.</span><span class="n">Resource</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="n">fuel_pump</span> <span class="o">=</span> <span class="n">simpy</span><span class="o">.</span><span class="n">Container</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">GAS_STATION_SIZE</span><span class="p">,</span> <span class="n">init</span><span class="o">=</span><span class="n">GAS_STATION_SIZE</span><span class="p">)</span>
<span class="n">env</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">gas_station_control</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">fuel_pump</span><span class="p">))</span>
<span class="n">env</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">car_generator</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">gas_station</span><span class="p">,</span> <span class="n">fuel_pump</span><span class="p">))</span>

<span class="c"># Execute!</span>
<span class="n">env</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">until</span><span class="o">=</span><span class="n">SIM_TIME</span><span class="p">)</span>
</pre></div>
</div>
<p>The simulation&#8217;s output:</p>
<div class="highlight-python"><div class="highlight"><pre>Gas Station refuelling
Car 0 arriving at gas station at 87.0
Car 0 finished refueling in 18.5 seconds.
Car 1 arriving at gas station at 129.0
Car 1 finished refueling in 19.0 seconds.
Car 2 arriving at gas station at 284.0
Car 2 finished refueling in 21.0 seconds.
Car 3 arriving at gas station at 385.0
Car 3 finished refueling in 13.5 seconds.
Car 4 arriving at gas station at 459.0
Calling tank truck at 460
Car 4 finished refueling in 22.0 seconds.
Car 5 arriving at gas station at 705.0
Car 6 arriving at gas station at 750.0
Tank truck arriving at time 760
Tank truck refuelling 188.0 liters.
Car 6 finished refueling in 29.0 seconds.
Car 5 finished refueling in 76.5 seconds.
Car 7 arriving at gas station at 891.0
Car 7 finished refueling in 13.0 seconds.
</pre></div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../contents.html">
              <img class="logo" src="../_static/simpy-logo-small.png" alt="Logo"/>
            </a></p>
  <h4>Previous topic</h4>
  <p class="topless"><a href="movie_renege.html"
                        title="previous chapter">Movie Renege</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="process_communication.html"
                        title="next chapter">Process Communication</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/examples/gas_station_refuel.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="process_communication.html" title="Process Communication"
             >next</a> |</li>
        <li class="right" >
          <a href="movie_renege.html" title="Movie Renege"
             >previous</a> |</li>
        <li><a href="../contents.html">SimPy 3.0.7 documentation</a> &raquo;</li>
          <li><a href="index.html" >Examples</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2002–2015, Team SimPy.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
    </div>
  </body>
</html>