<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Run the SAMIR model — modspa-pixel 0.1 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<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=2709fde1"></script>
<script src="../_static/doctools.js?v=888ff710"></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="Good practices to use the SAMIR model" href="data_and_ram_management.html" />
<link rel="prev" title="Preparing the SAMIR parameter csv file" href="../preprocessing/samir_params.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">
modspa-pixel
</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">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../setup/setup.html">Setting up the correct environnment and parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../mode/mode.html">Choosing the run mode</a></li>
<li class="toctree-l1"><a class="reference internal" href="../preprocessing/input_preparation.html">Preparing the inputs for Modspa-Pixel</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Run the SAMIR model</a><ul>
<li class="toctree-l2"><a class="reference internal" href="data_and_ram_management.html">Good practices to use the SAMIR model</a></li>
<li class="toctree-l2"><a class="reference internal" href="samir_functions.html">How the SAMIR functions works</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../file_structure.html">Project file structure</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">modspa-pixel</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">Run the SAMIR model</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/samir/run_samir.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="run-the-samir-model">
<h1>Run the SAMIR model<a class="headerlink" href="#run-the-samir-model" title="Link to this heading"></a></h1>
<p>After you have run the <a class="reference internal" href="../preprocessing/input_preparation.html#prepare-inputs"><span class="std std-ref">input preparation</span></a> script, created the soil and land cover datasets and created a <a class="reference internal" href="../preprocessing/samir_params.html#samir-params"><span class="std std-ref">SAMIR parameter csv</span></a> file, all the necessary inputs are present to run the <strong>SAMIR</strong> model. All you need to do is run the following python script to run the model:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">(</span>modspa_pixel<span class="o">)</span><span class="w"> </span>/modspa_pixel$<span class="w"> </span>python<span class="w"> </span>main_run_samir.py
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Depending on the size of your datasets and your machine’s specifications, this script can take some time to run. A <strong>progress bar</strong> will keep you informed on the script’s progress and operations.</p>
</div>
<p>Once the script is finished, the output dataset (or daframe and shapefile for the <strong>parcel</strong> mode) will be found in the <strong>output</strong> directory, in a subdirectory carrying the <strong>run_name</strong>. Plotting scripts and notebooks are located in the <code class="code docutils literal notranslate"><span class="pre">modspa_pixel/postprocessing/</span></code> directory.</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="data_and_ram_management.html">Good practices to use the SAMIR model</a></li>
<li class="toctree-l1"><a class="reference internal" href="samir_functions.html">How the SAMIR functions works</a></li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../preprocessing/samir_params.html" class="btn btn-neutral float-left" title="Preparing the SAMIR parameter csv file" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="data_and_ram_management.html" class="btn btn-neutral float-right" title="Good practices to use the SAMIR model" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2023, auclairj.</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>