

<!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>Getting started &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" />
    <link rel="prev" title="Welcome to the PsrPopPy documentation!" href="index.html" /> 
  </head>
  <body>
    <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="index.html" title="Welcome to the PsrPopPy documentation!"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">PsrPopPy 1 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="getting-started">
<span id="id1"></span><h1>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
<p>To get started with PsrPopPy there are a few steps you&#8217;ll need to
go through.</p>
<p>PsrPopPy is currently supported on Linux and Mac OS X.</p>
<div class="section" id="installation">
<span id="id2"></span><h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<div class="section" id="download-the-package">
<span id="download-package"></span><h3>Download the package<a class="headerlink" href="#download-the-package" title="Permalink to this headline">¶</a></h3>
<p>The source for PsrPopPy can be downloaded from <a class="reference external" href="http://github.com">GitHub</a>
from the <a class="reference external" href="https://github.com/samb8s/PsrPopPy">PsrPopPy page</a>.
The source will contain the Python modules and scripts needed both for
basic and advanced use.</p>
</div>
<div class="section" id="compile-the-fortran">
<span id="compiling-fortran"></span><h3>Compile the FORTRAN<a class="headerlink" href="#compile-the-fortran" title="Permalink to this headline">¶</a></h3>
<p>Although PsrPopPy is a Python-based package, some of the algorithms
have been kept in their native FORTRAN for speed and ease of
programming (e.g. the NE2001 electron model, coordinate conversion...).
Therefore, it is necessary to compile the FORTRAN.</p>
<p>Two scripts are provided for just this purpose (though I hope to find
someone willing to contribute configure scripts). From the base
directory:</p>
<div class="highlight-python"><pre>&gt; cd fortran</pre>
</div>
<p>then edit either <tt class="docutils literal"><span class="pre">make_mac.csh</span></tt> or <tt class="docutils literal"><span class="pre">make_linux.csh</span></tt>, depending upon
your system, so that the <tt class="docutils literal"><span class="pre">gf</span></tt> variable points to your local gfortran/f77
compiler. Running the script:</p>
<div class="highlight-python"><pre>&gt; tcsh make_&lt;os&gt;.csh</pre>
</div>
<p><cite>should</cite> then compile a series of <tt class="docutils literal"><span class="pre">.so</span></tt> files in the <tt class="docutils literal"><span class="pre">fortran</span></tt> directory.
Assuming this went to plan, the installation process is completed.</p>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Getting started</a><ul>
<li><a class="reference internal" href="#installation">Installation</a><ul>
<li><a class="reference internal" href="#download-the-package">Download the package</a></li>
<li><a class="reference internal" href="#compile-the-fortran">Compile the FORTRAN</a></li>
</ul>
</li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="index.html"
                        title="previous chapter">Welcome to the PsrPopPy documentation!</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/getting_started.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="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="index.html" title="Welcome to the PsrPopPy documentation!"
             >previous</a> |</li>
        <li><a href="index.html">PsrPopPy 1 documentation</a> &raquo;</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>