

<!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>Welcome to the PsrPopPy documentation! &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="#" />
    <link rel="next" title="Introduction" href="introduction.html" /> 
  </head>
  <body>

<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="#"><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 class="right" >
          <a href="introduction.html" title="Introduction"
             accesskey="N">next</a> |</li>
        <li><a href="#">home</a>|&nbsp;</li>
        <li><a href="search.html">search</a>|&nbsp;</li>
 
      </ul>
    </div>

      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="#">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Welcome to the PsrPopPy documentation!</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>

  <h4>Next topic</h4>
  <p class="topless"><a href="introduction.html"
                        title="next chapter">Introduction</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/index.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="welcome-to-the-psrpoppy-documentation">
<h1>Welcome to the PsrPopPy documentation!<a class="headerlink" href="#welcome-to-the-psrpoppy-documentation" title="Permalink to this headline">¶</a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#what-is-psrpoppy">What is PsrPopPy?</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#why-is-psrpoppy">Why is PsrPopPy?</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#who-can-contribute">Who can contribute?</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#acknowledgements">Acknowledgements</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#download-the-package">Download the package</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#compile-the-fortran">Compile the FORTRAN</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cmd-line-docs.html">Command-line scripts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cmd-line-docs.html#populate-py">populate.py</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd-line-docs.html#dosurvey-py">dosurvey.py</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd-line-docs.html#view-py">view.py</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd-line-docs.html#visualize-py">visualize.py</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-basic.html">Tutorial - Basic Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorial-basic.html#generate-population-model">Generate Population Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial-basic.html#simulate-a-pulsar-survey">Simulate a Pulsar Survey</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial-basic.html#visualising-a-pulsar-model">Visualising a Pulsar Model</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="module-level-docs.html">Module-level Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="module-level-docs.html#module-pulsar"><tt class="docutils literal"><span class="pre">pulsar</span></tt> &#8211; Creates/stores a pulsar object</a></li>
<li class="toctree-l2"><a class="reference internal" href="module-level-docs.html#module-population"><tt class="docutils literal"><span class="pre">population</span></tt> &#8211; Creates/stores a population</a></li>
<li class="toctree-l2"><a class="reference internal" href="module-level-docs.html#module-survey"><tt class="docutils literal"><span class="pre">survey</span></tt> &#8211; Read a survey file into a survey object</a></li>
<li class="toctree-l2"><a class="reference internal" href="module-level-docs.html#module-populate"><tt class="docutils literal"><span class="pre">populate</span></tt> &#8211; Create a population object</a></li>
<li class="toctree-l2"><a class="reference internal" href="module-level-docs.html#module-radialmodels"><tt class="docutils literal"><span class="pre">radialmodels</span></tt> &#8211; Container for radial distn models</a></li>
<li class="toctree-l2"><a class="reference internal" href="module-level-docs.html#galacticops-container-for-functions-relating-to-the-galaxy"><tt class="docutils literal"><span class="pre">galacticops</span></tt> &#8211; Container for functions relating to the Galaxy</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</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 class="right" >
          <a href="introduction.html" title="Introduction"
             >next</a> |</li>
        <li><a href="#">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>