model-utils-api.html

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Model Utils API &mdash; pymoc  documentation</title>
  

  
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

  
  
  
  

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/doctools.js"></script>
        <script src="_static/language_data.js"></script>
        <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    
    <script type="text/javascript" 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="publications.html" />
    <link rel="prev" title="pymoc.modules.SO_ML" href="module-api/pymoc.modules.SO_ML.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" alt="Documentation Home"> pymoc
          

          
          </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" />
    <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="main navigation">
          
            
            
              
            
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="model-physics.html">Model Physics</a></li>
<li class="toctree-l1"><a class="reference internal" href="module-api.html">Module API</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Model Utils API</a></li>
<li class="toctree-l1"><a class="reference internal" href="publications.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
</ul>

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

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">pymoc</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
        
      <li>Model Utils API</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/model-utils-api.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">
            
  <div class="section" id="module-pymoc.utils">
<span id="id1"></span><span id="model-utils-api"></span><h1>Model Utils API<a class="headerlink" href="#module-pymoc.utils" title="Permalink to this headline">¶</a></h1>
<dl class="py function">
<dt id="pymoc.utils.check_numpy_version">
<code class="sig-prename descclassname">pymoc.utils.</code><code class="sig-name descname">check_numpy_version</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pymoc.utils.check_numpy_version" title="Permalink to this definition">¶</a></dt>
<dd><p>Check whether your system is using a numpy version of at least 1.13,
required for some modules for gradient calculations.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><strong>is_sufficient</strong> – True if numpy version &gt;= 1.13, False otherwise.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>logical</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pymoc.utils.gridit">
<code class="sig-prename descclassname">pymoc.utils.</code><code class="sig-name descname">gridit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x1</span></em>, <em class="sig-param"><span class="n">x2</span></em>, <em class="sig-param"><span class="n">f</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pymoc.utils.gridit" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate a gridded dataset, based on a function in x1 and x2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x1</strong> (<em>ndarray</em>) – Grid points in the first dimension along which values are to be calculated.</p></li>
<li><p><strong>x2</strong> (<em>ndarray</em>) – Grid points in the second dimension along which values are to be calculated.</p></li>
<li><p><strong>f</strong> (<em>function</em>) – A function in dimensions x1 and x2, that returns a single value for each pair of coordinate values.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><strong>gridded</strong> – A 2D array of shape <code class="xref py py-func docutils literal notranslate"><span class="pre">(len(x1),</span> <span class="pre">len(x2))()</span></code>, where each point <code class="xref py py-func docutils literal notranslate"><span class="pre">gridded[i,</span> <span class="pre">j]</span> <span class="pre">=</span> <span class="pre">f(x1[i],</span> <span class="pre">x2[j])()</span></code>.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>ndarray</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pymoc.utils.make_array">
<code class="sig-prename descclassname">pymoc.utils.</code><code class="sig-name descname">make_array</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">myst</span></em>, <em class="sig-param"><span class="n">axis</span></em>, <em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pymoc.utils.make_array" title="Permalink to this definition">¶</a></dt>
<dd><p>Make an argument of unknown type into an array if needed, along the specified array.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>myst</strong> (<em>float</em><em>, </em><em>function</em><em>, or </em><em>ndarray</em>) – The argument to be transformed. Either a single numerical value, a function in a single dimension, or an array.</p></li>
<li><p><strong>axis</strong> (<em>ndarray</em>) – Grid points in the direction along which the array is to be created.</p></li>
<li><p><strong>name</strong> (<em>string</em>) – Name of the variable being transformed into an array.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><p><strong>made_array</strong> – An array representing the data in myst, along axis:</p>
<ul class="simple">
<li><p>If myst is an ndarray, simply returns myst.</p></li>
<li><p>If myst is a float, returns an array of length <code class="xref py py-func docutils literal notranslate"><span class="pre">len(axis)()</span></code> where each row contains the value of myst.</p></li>
<li><p>If myst is a function, returns an array of length <code class="xref py py-func docutils literal notranslate"><span class="pre">len(axis)()</span></code> where each row contains the value <code class="xref py py-func docutils literal notranslate"><span class="pre">made_array[i]=myst(axis[i])()</span></code>.</p></li>
</ul>
</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>ndarray</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pymoc.utils.make_func">
<code class="sig-prename descclassname">pymoc.utils.</code><code class="sig-name descname">make_func</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">myst</span></em>, <em class="sig-param"><span class="n">axis</span></em>, <em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pymoc.utils.make_func" title="Permalink to this definition">¶</a></dt>
<dd><p>Make an argument of unknown type into a function if needed, in the dimension of the specified array.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>myst</strong> (<em>float</em><em>, </em><em>function</em><em>, or </em><em>ndarray</em>) – The argument to be transformed. Either a single numerical value, a function in a single dimension, or an array.</p></li>
<li><p><strong>axis</strong> (<em>ndarray</em>) – Grid points in the direction along which the function is to operate. If myst is an array, axis should be of the same length.</p></li>
<li><p><strong>name</strong> (<em>string</em>) – Name of the variable being transformed into a function.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><p><strong>made_func</strong> – An function representing the data in myst, along axis:</p>
<ul class="simple">
<li><p>If myst is a funcion, simply returns myst.</p></li>
<li><p>If myst is a float, returns a function that returns the value of myst.</p></li>
<li><p>If myst is an array, returns an function that operates along the same dimension as axis, which returns the value <code class="xref py py-func docutils literal notranslate"><span class="pre">made_func(axis[i])=myst[i]()</span></code>, and interpolates values between points in axis.</p></li>
</ul>
</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>ndarray</p>
</dd>
</dl>
</dd></dl>

</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="publications.html" class="btn btn-neutral float-right" title="Publications" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="module-api/pymoc.modules.SO_ML.html" class="btn btn-neutral float-left" title="pymoc.modules.SO_ML" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        
        &copy; Copyright 2020, PyMOC Team

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

</footer>

        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>