

<!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>populate – Create a population object &mdash; PsrPopPy 1 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:     '1',
        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="top" title="PsrPopPy 1 documentation" href="index.html" /> 
  </head>
  <body>

<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="index.html"><img src="_static/logo2.png" border="0" alt="py4sci"/></a>
</div>

    <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><a href="index.html">home</a>|&nbsp;</li>
        <li><a href="search.html">search</a>|&nbsp;</li>
 
      </ul>
    </div>

      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/populate_module_docs.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="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-populate">
<span id="populate-create-a-population-object"></span><h1><a class="reference internal" href="#module-populate" title="populate: Create a population object"><tt class="xref py py-mod docutils literal"><span class="pre">populate</span></tt></a> &#8211; Create a population object<a class="headerlink" href="#module-populate" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="populate.Populate">
<em class="property">class </em><tt class="descclassname">populate.</tt><tt class="descname">Populate</tt><a class="headerlink" href="#populate.Populate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="populate.Populate.generate">
<tt class="descclassname">Populate.</tt><tt class="descname">generate</tt><big>(</big><em>ngen</em><span class="optional">[</span>, <em>surveyList</em>, <em>pDistType</em>, <em>radialDistType</em>, <em>electronModel</em>, <em>pDistPars</em>, <em>siDistPars</em>, <em>lumDistType</em>, <em>lumDistPars</em>, <em>zscale</em>, <em>duty</em>, <em>scindex</em>, <em>gpsArgs</em>, <em>doubleSpec</em>, <em>nostdout</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#populate.Populate.generate" title="Permalink to this definition">¶</a></dt>
<dd><p>The method called by the <tt class="docutils literal"><span class="pre">populate.py</span></tt> command-line-script</p>
</dd></dl>

<dl class="method">
<dt id="populate.Populate.write">
<tt class="descclassname">Populate.</tt><tt class="descname">write</tt><big>(</big><em>outf=populate.model</em><big>)</big><a class="headerlink" href="#populate.Populate.write" title="Permalink to this definition">¶</a></dt>
<dd><p>Writes the <a class="reference internal" href="module-level-docs.html#population.Population" title="population.Population"><tt class="xref py py-class docutils literal"><span class="pre">Population</span></tt></a> model into file outf as a cPickle dump</p>
</dd></dl>

</div>


          </div>
        </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><a href="index.html">home</a>|&nbsp;</li>
        <li><a href="search.html">search</a>|&nbsp;</li>
 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, S Bates.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>