Homec4science
Diffusion pNbody (master) Browse

pNbody/Doc/newdoc/_build/html/rst/ParamModule.html
c7e938c86e93master

Last Change
Raw File

ParamModule.html
View Options

<!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>the param module &mdash; pNbody v4 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: '4',
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="pNbody v4 documentation" href="../index.html" />
<link rel="up" title="Reference" href="Reference.html" />
<link rel="next" title="the parameters module" href="ParameterModule.html" />
<link rel="prev" title="the libutil module" href="LibutilModule.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="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../np-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="ParameterModule.html" title="the parameters module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="LibutilModule.html" title="the libutil module"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pNbody v4 documentation</a> &raquo;</li>
<li><a href="Reference.html" accesskey="U">Reference</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-pNbody.param">
<span id="the-param-module"></span><h1>the param module<a class="headerlink" href="#module-pNbody.param" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pNbody.param.Params">
<em class="property">class </em><tt class="descclassname">pNbody.param.</tt><tt class="descname">Params</tt><big>(</big><em>filename</em>, <em>master</em><big>)</big><a class="headerlink" href="#pNbody.param.Params" title="Permalink to this definition"></a></dt>
<dd><dl class="docutils">
<dt>params = [[&#8216;imwidth&#8217;,&#8217;image width&#8217;,&#8217;i&#8217;,512],</dt>
<dd>[&#8216;imheight&#8217;,&#8217;image height&#8217;,&#8217;i&#8217;,384],
[&#8216;winwidth&#8217;,&#8217;window width&#8217;,&#8217;f&#8217;,50.],
[&#8216;winheight&#8217;,&#8217;window height&#8217;,&#8217;f&#8217;,37.5]]</dd>
</dl>
<p class="rubric">Methods</p>
<dl class="method">
<dt id="pNbody.param.Params.get">
<tt class="descname">get</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pNbody.param.Params.get" title="Permalink to this definition"></a></dt>
<dd><p>return the value of a parameter</p>
</dd></dl>
<dl class="method">
<dt id="pNbody.param.Params.get_dic">
<tt class="descname">get_dic</tt><big>(</big><big>)</big><a class="headerlink" href="#pNbody.param.Params.get_dic" title="Permalink to this definition"></a></dt>
<dd><p>return values of parameters in a dictionary</p>
</dd></dl>
<dl class="method">
<dt id="pNbody.param.Params.get_string">
<tt class="descname">get_string</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pNbody.param.Params.get_string" title="Permalink to this definition"></a></dt>
<dd><p>return the value of a parameter in a string</p>
</dd></dl>
<dl class="method">
<dt id="pNbody.param.Params.get_type">
<tt class="descname">get_type</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pNbody.param.Params.get_type" title="Permalink to this definition"></a></dt>
<dd><p>return the type of a parameter</p>
</dd></dl>
<dl class="method">
<dt id="pNbody.param.Params.lists">
<tt class="descname">lists</tt><big>(</big><big>)</big><a class="headerlink" href="#pNbody.param.Params.lists" title="Permalink to this definition"></a></dt>
<dd><p>print the list of the content of the class</p>
</dd></dl>
<dl class="method">
<dt id="pNbody.param.Params.save">
<tt class="descname">save</tt><big>(</big><em>filename=None</em><big>)</big><a class="headerlink" href="#pNbody.param.Params.save" title="Permalink to this definition"></a></dt>
<dd><p>[&#8216;cd&#8217;, &#8216;cd&#8217;, &#8216;Float&#8217;, 0.0]</p>
</dd></dl>
<dl class="method">
<dt id="pNbody.param.Params.set">
<tt class="descname">set</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#pNbody.param.Params.set" title="Permalink to this definition"></a></dt>
<dd><p>set the value of a parameter</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="pNbody.param.read_ascii_value">
<tt class="descclassname">pNbody.param.</tt><tt class="descname">read_ascii_value</tt><big>(</big><em>value</em>, <em>tpe</em>, <em>name</em><big>)</big><a class="headerlink" href="#pNbody.param.read_ascii_value" title="Permalink to this definition"></a></dt>
<dd><p>from a name and type, return
an object corresponding to the value given</p>
</dd></dl>
<dl class="function">
<dt id="pNbody.param.write_ascii_value">
<tt class="descclassname">pNbody.param.</tt><tt class="descname">write_ascii_value</tt><big>(</big><em>value</em>, <em>tpe</em>, <em>name</em><big>)</big><a class="headerlink" href="#pNbody.param.write_ascii_value" title="Permalink to this definition"></a></dt>
<dd><p>from a name and type and value, return
an ascii representation of the object</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/icon-small.jpg" alt="Logo"/>
</a></p>
<h4>Previous topic</h4>
<p class="topless"><a href="LibutilModule.html"
title="previous chapter">the libutil module</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ParameterModule.html"
title="next chapter">the parameters module</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/rst/ParamModule.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" size="18" />
<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="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../np-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="ParameterModule.html" title="the parameters module"
>next</a> |</li>
<li class="right" >
<a href="LibutilModule.html" title="the libutil module"
>previous</a> |</li>
<li><a href="../index.html">pNbody v4 documentation</a> &raquo;</li>
<li><a href="Reference.html" >Reference</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Yves Revaz.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
</div>
</body>
</html>
c4science · Help