gui.html



<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Graphical User Interface &mdash; OpenDrift  documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
      <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
      <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
      <link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
      <link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
      <link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
      <link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
      <link rel="stylesheet" type="text/css" href="_static/theme_overrides.css" />

  
      <script src="_static/jquery.js?v=5d32c60e"></script>
      <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
      <script src="_static/documentation_options.js?v=5929fcd5"></script>
      <script src="_static/doctools.js?v=9bcbadda"></script>
      <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Publications" href="references.html" />
    <link rel="prev" title="Using OpenDrift in a container" href="docker.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          <a href="index.html" class="icon icon-home">
            OpenDrift
              <img src="_static/opendrift_logo.png" class="logo" alt="Logo"/>
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Introduction to OpenDrift</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="history_link.html">History</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installing OpenDrift</a></li>
<li class="toctree-l1"><a class="reference internal" href="performance.html">Performance in OpenDrift</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="theory/index.html">Theory</a></li>
<li class="toctree-l1"><a class="reference internal" href="theory/index.html#drift-in-the-ocean">Drift in the Ocean</a></li>
<li class="toctree-l1"><a class="reference internal" href="choosing_a_model.html">How to choose which model to use</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing_a_new_model.html">How to write a new module</a></li>
<li class="toctree-l1"><a class="reference internal" href="gallery/index.html">Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="oil_types.html">Oil types</a></li>
<li class="toctree-l1"><a class="reference internal" href="interaction_with_coastline.html">Interaction with coastline</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using OpenDrift in a container</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Graphical User Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#choosing-a-model-and-parameters">Choosing a model and parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="#seeding-of-particles">Seeding of particles</a></li>
<li class="toctree-l2"><a class="reference internal" href="#simulation-time">Simulation time</a></li>
<li class="toctree-l2"><a class="reference internal" href="#forcing-data">Forcing data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#simulation-and-analysis">Simulation and analysis</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="references.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="services.html">Services using OpenDrift</a></li>
<li class="toctree-l1"><a class="reference internal" href="autoapi/index.html">API Reference</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">OpenDrift</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">Graphical User Interface</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/gui.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="graphical-user-interface">
<h1>Graphical User Interface<a class="headerlink" href="#graphical-user-interface" title="Link to this heading"></a></h1>
<p>OpenDrift comes with a basic Graphical User Interface, which can be started with the command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ opendrift_gui.py
</pre></div>
</div>
<p>When OpenDrift has been installed or the <a class="reference external" href="https://github.com/OpenDrift/opendrift/tree/master/opendrift/scripts">scripts-folder</a> is
added to your PATH-variable. Otherwise, the command <cite>$ python opendrift_gui.py</cite>
can be run from within the scripts-folder. On Windows, the <cite>opendrift_gui.py</cite>
script may be launched by a double-click.</p>
<img alt="_images/opendrift_gui.png" src="_images/opendrift_gui.png" />
<section id="choosing-a-model-and-parameters">
<h2>Choosing a model and parameters<a class="headerlink" href="#choosing-a-model-and-parameters" title="Link to this heading"></a></h2>
<p>The <a class="reference internal" href="autoapi/opendrift/models/leeway/index.html#module-opendrift.models.leeway" title="opendrift.models.leeway"><code class="xref py py-mod docutils literal notranslate"><span class="pre">Leeway</span> <span class="pre">model</span> <span class="pre">(Search</span> <span class="pre">and</span> <span class="pre">Rescue)</span></code></a>, <a class="reference internal" href="autoapi/opendrift/models/openoil/index.html#module-opendrift.models.openoil" title="opendrift.models.openoil"><code class="xref py py-mod docutils literal notranslate"><span class="pre">OpenOil</span> <span class="pre">(oil</span> <span class="pre">drift)</span></code></a>, <code class="xref py py-mod docutils literal notranslate"><span class="pre">ShipDrift</span> <span class="pre">model</span></code> and <a class="reference internal" href="autoapi/opendrift/models/openberg_old/index.html#module-opendrift.models.openberg_old" title="opendrift.models.openberg_old"><code class="xref py py-mod docutils literal notranslate"><span class="pre">OpenBergOld</span> <span class="pre">model</span></code></a> are available in the GUI.</p>
<p>The first step is to select the model of interest from the upper menu.
If Leeway or OpenOil are chosen, the second dropdown-menu will allow you to select either</p>
<blockquote>
<div><ul class="simple">
<li><p>an oil type (from <a class="reference external" href="https://github.com/NOAA-ORR-ERD/OilLibrary">NOAA OilLibrary</a>), or</p></li>
<li><p>a <a class="reference external" href="https://www.dropbox.com/s/d5jhwo6y5zldxgh/Drivbanehjelp.pdf?raw=1">Leeway object category</a>.</p></li>
</ul>
</div></blockquote>
<p>If the ShipDrift model is selected, the dimensions of the ship can be selected (beam, length, draft and height).</p>
<p>The ice berg drift simulation has parameters <cite>wind_drift_factor</cite>, <cite>water_line_length</cite> and <cite>keel_depth</cite>. The <cite>wind_drift_factor</cite> is unlikely that you need to change, while the other parameters describe the geometry of the ice berg. These are described in more detail in the <a class="reference internal" href="autoapi/opendrift/models/openberg_old/index.html#module-opendrift.models.openberg_old" title="opendrift.models.openberg_old"><code class="xref py py-mod docutils literal notranslate"><span class="pre">OpenBergOld</span> <span class="pre">reference</span></code></a> at <a class="reference internal" href="autoapi/opendrift/models/openberg_old/index.html#openberg-parameters"><span class="std std-ref">Parameters and iceberg properties affecting drift</span></a>.</p>
<p>The following steps are the same for all models:</p>
</section>
<section id="seeding-of-particles">
<h2>Seeding of particles<a class="headerlink" href="#seeding-of-particles" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>Choose a starting point for the seeding (initialisation) of particles. Latitude and longitude must be given in decimal degrees, and negative longitudes correspond to west of Greenwich.</p></li>
<li><p>The radius is an uncertainty radius (standard deviation, given in meters) around the given location within which all the (5000) elements will be seeded.</p></li>
<li><p>Optional:</p>
<ul>
<li><p>the end time can be changed if a continuous release of particles over a time span is desired, simulating e.g. a leaking well,</p></li>
<li><p>the end position can be changed if particles shall be released between the start and end positions, simulating e.g. a ship track.</p></li>
<li><p>or a combination of both.</p></li>
</ul>
</li>
<li><p>Note that whenever the start position or time is updated, the end position/time will be copied/overwritten.</p></li>
<li><p>By clicking <code class="docutils literal notranslate"><span class="pre">Check</span> <span class="pre">seeding</span></code> it is possible to see a plot of the seeding positions before the simulation is started. Note that it it can take up to about 30 seconds before the plot is shown.</p></li>
</ul>
</section>
<section id="simulation-time">
<h2>Simulation time<a class="headerlink" href="#simulation-time" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>Simulations may by run forwards or backwards (backtracking, to check from where the object or oil has drifted)</p></li>
<li><p>The simulation duration is given in hours. Note that simulations longer than 100 hours may take significant time (&gt; 10 minutes), especially for oil drift.</p></li>
</ul>
</section>
<section id="forcing-data">
<h2>Forcing data<a class="headerlink" href="#forcing-data" title="Link to this heading"></a></h2>
<p>The sources used for current, wind and waves are given in <a class="reference external" href="https://github.com/OpenDrift/opendrift/blob/master/opendrift/scripts/data_sources.txt">this list</a>, in prioritized order.
The forcing data are obtained/downloaded from remote servers (Thredds, OPeNDAP) during the simulation, and has global coverage, but high resolution for the North Atlantic only.</p>
<p>Whenever wave data is not available, OpenDrift will calculate wave parameters from wind.</p>
</section>
<section id="simulation-and-analysis">
<h2>Simulation and analysis<a class="headerlink" href="#simulation-and-analysis" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>The simulation is started by clicking <code class="docutils literal notranslate"><span class="pre">START</span></code></p></li>
<li><p>The simulation will take from less than a minute for a short (12 hours) Leeway simulation and up to 10 minutes or more for a long (100 hours) oil drift simulation. Oil drift simulations takes more time due to heavy vertical turbulence calculations.</p>
<ul>
<li><p>It is not possible to stop an ongoing simulation, except for using a task manager (or <cite>kill</cite> command in Linux). The user interface is unresponsive during the simulation.</p></li>
</ul>
</li>
<li><p>After the simulation, the result may be analysed with buttons appearing at the bottom:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">Animation</span></code>: an animation of the simulation is shown or saved to file.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Oil</span> <span class="pre">budget</span></code> (oil drift only): the time-history of the <a class="reference internal" href="autoapi/opendrift/models/openoil/index.html#module-opendrift.models.openoil" title="opendrift.models.openoil"><code class="xref py py-mod docutils literal notranslate"><span class="pre">oil</span> <span class="pre">budget</span></code></a> is shown or saved to file.</p></li>
<li><p>MET Norway only: a button <code class="docutils literal notranslate"><span class="pre">Show</span> <span class="pre">in</span> <span class="pre">Diana</span></code> will launch the Diana analysis tool.</p>
<ul>
<li><p>Note that this is local Diana, not VGL-version.</p></li>
<li><p>The present and previous simulations may be viewed by opening <code class="docutils literal notranslate"><span class="pre">Felter</span> <span class="pre">-&gt;</span> <span class="pre">Drivbane_OpenDrift</span></code> and then selecting <code class="docutils literal notranslate"><span class="pre">Leeway</span></code>, <code class="docutils literal notranslate"><span class="pre">Oljedrift</span></code> or <code class="docutils literal notranslate"><span class="pre">ShipDrift</span></code>. Note that the simulations will be sorted by the starting-time of the simulations, not the time at which the simulation was performed. Thus if you performed a simulation starting back in time, it might not be the last item in the list (<cite>Referansetid</cite>). Click on all the items in felter (submerged, stranded, surface), and then <cite>Utfør</cite>. For oil drift simulations, submerged particles are blue, surface oil is grey or black.</p></li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="docker.html" class="btn btn-neutral float-left" title="Using OpenDrift in a container" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="references.html" class="btn btn-neutral float-right" title="Publications" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2020, Knut-Frode Dagestad (knutfd@met.no) and Gaute Hope (gauteh@met.no)..</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>