Code owners
Assign users and groups as approvers for specific file changes. Learn more.
grid_options_defaults.html 20.07 KiB
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Population class extension: grid_options_defaults module — binary_c-python documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" 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 crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script 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="Population class extension: HPC module" href="HPC.html" />
<link rel="prev" title="Population class extension: grid_logging module" href="grid_logging.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"> binary_c-python
</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="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../readme_link.html">Python module for binary_c</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../modules.html">Binarycpython code</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../custom_logging_functions.html">custom_logging_functions module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dicts.html">dicts module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../ensemble.html">ensemble module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../functions.html">functions module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../grid.html">Population class module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plot_functions.html">plot_functions module</a></li>
<li class="toctree-l2"><a class="reference internal" href="analytics.html">Population class extension: analytics module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cache.html">Population class extension: cache module</a></li>
<li class="toctree-l2"><a class="reference internal" href="condor.html">Population class extension: condor module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataIO.html">Population class extension: dataIO module</a></li>
<li class="toctree-l2"><a class="reference internal" href="distribution_functions.html">Population class extension: distribution_functions module</a></li>
<li class="toctree-l2"><a class="reference internal" href="gridcode.html">Population class extension: gridcode module</a></li>
<li class="toctree-l2"><a class="reference internal" href="grid_logging.html">Population class extension: grid_logging module</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Population class extension: grid_options_defaults module</a></li>
<li class="toctree-l2"><a class="reference internal" href="HPC.html">Population class extension: HPC module</a></li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html">Population class extension: metadata module</a></li>
<li class="toctree-l2"><a class="reference internal" href="Moe_di_Stefano_2017.html">Population class extension: Moe_di_Stefano_2017 module</a></li>
<li class="toctree-l2"><a class="reference internal" href="slurm.html">Population class extension: slurm module</a></li>
<li class="toctree-l2"><a class="reference internal" href="spacing_functions.html">Population class extension: spacing_functions module</a></li>
<li class="toctree-l2"><a class="reference internal" href="version_info.html">Population class extension: version_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../run_system_wrapper.html">run_system_wrapper module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stellar_types.html">stellar_types module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../useful_funcs.html">useful_funcs module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../example_notebooks.html">Example notebooks</a></li><li class="toctree-l1"><a class="reference internal" href="../binary_c_parameters.html">Binary_c parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../grid_options_descriptions.html">Population grid code options</a></li>
<li class="toctree-l1"><a class="reference external" href="https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python">Visit the GitLab repo</a></li>
<li class="toctree-l1"><a class="reference external" href="https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python/-/issues/new">Submit an issue</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">binary_c-python</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> »</li>
<li><a href="../modules.html">Binarycpython code</a> »</li>
<li>Population class extension: grid_options_defaults module</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/population_extensions/grid_options_defaults.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">
<style>
/* CSS overrides for sphinx_rtd_theme */
/* 24px margin */
.nbinput.nblast.container,
.nboutput.nblast.container {
margin-bottom: 19px; /* padding has already 5px */
}
/* ... except between code cells! */
.nblast.container + .nbinput.container {
margin-top: -19px;
}
.admonition > p:before {
margin-right: 4px; /* make room for the exclamation icon */
}
/* Fix math alignment, see https://github.com/rtfd/sphinx_rtd_theme/pull/686 */
.math {
text-align: unset;
}
</style>
<section id="module-binarycpython.utils.population_extensions.grid_options_defaults">
<span id="population-class-extension-grid-options-defaults-module"></span><h1>Population class extension: grid_options_defaults module<a class="headerlink" href="#module-binarycpython.utils.population_extensions.grid_options_defaults" title="Permalink to this headline"></a></h1>
<dl class="simple">
<dt>Module that contains the default options for the population grid code along with the description for these options, in the form of dictionaries:</dt><dd><ul class="simple">
<li><p>grid_options_defaults_dict: dictionary containing the default values for all the options</p></li>
<li><p>grid_options_descriptions: dictionary containing the description for these options.</p></li>
</ul>
</dd>
<dt>There are several other functions in this module, mostly to generate help texts or documents:</dt><dd><ul class="simple">
<li><p>grid_options_help: interactive function for the user to get descriptions for options</p></li>
<li><p>grid_options_description_checker: function that checks that checks which options have a description.</p></li>
<li><p>write_grid_options_to_rst_file: function to generate the .rst document for the docs</p></li>
</ul>
</dd>
</dl><p>With this its also possible to automatically generate a document containing all the setting names + descriptions.</p>
<p>All the options starting with _ should not be changed by the user except when you really know what you’re doing (which is probably hacking the code :P)</p>
<p>TODO: reconsider having this all as class methods. It seems unnecessary to have all these functions as class methods.</p>
<dl class="py class">
<dt class="sig sig-object py" id="binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">binarycpython.utils.population_extensions.grid_options_defaults.</span></span><span class="sig-name descname"><span class="pre">grid_options_defaults</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/binarycpython/utils/population_extensions/grid_options_defaults.html#grid_options_defaults"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Class extension to Population grid containing all the functionality for the options and defaults</p>
<dl class="py method">
<dt class="sig sig-object py" id="binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.default_cache_dir">
<span class="sig-name descname"><span class="pre">default_cache_dir</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/binarycpython/utils/population_extensions/grid_options_defaults.html#grid_options_defaults.default_cache_dir"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.default_cache_dir" title="Permalink to this definition"></a></dt>
<dd><p>Return a default cache directory path, or None if we cannot find one.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.get_grid_options_defaults_dict">
<span class="sig-name descname"><span class="pre">get_grid_options_defaults_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/binarycpython/utils/population_extensions/grid_options_defaults.html#grid_options_defaults.get_grid_options_defaults_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.get_grid_options_defaults_dict" title="Permalink to this definition"></a></dt>
<dd><p>Function to return the default values for the grid options</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.get_grid_options_descriptions">
<span class="sig-name descname"><span class="pre">get_grid_options_descriptions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/binarycpython/utils/population_extensions/grid_options_defaults.html#grid_options_defaults.get_grid_options_descriptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.get_grid_options_descriptions" title="Permalink to this definition"></a></dt>
<dd><p>Function that returns the descriptions for all the grid options</p>
<p>TODO: consider putting input types for all of them</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.grid_options_description_checker">
<span class="sig-name descname"><span class="pre">grid_options_description_checker</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">print_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/binarycpython/utils/population_extensions/grid_options_defaults.html#grid_options_defaults.grid_options_description_checker"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.grid_options_description_checker" title="Permalink to this definition"></a></dt>
<dd><p>Function that checks which descriptions are missing</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>print_info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – whether to print out information about which options contain proper descriptions and which do not</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>the number of undescribed keys</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.grid_options_help">
<span class="sig-name descname"><span class="pre">grid_options_help</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">option</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/binarycpython/utils/population_extensions/grid_options_defaults.html#grid_options_defaults.grid_options_help"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.grid_options_help" title="Permalink to this definition"></a></dt>
<dd><p>Function that prints out the description of a grid option. Useful function for the user.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>option</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – which option you want to have the description of</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dict containing the option, the description if its there, otherwise empty string. And if the key doesnt exist, the dict is empty</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.print_option_descriptions">
<span class="sig-name descname"><span class="pre">print_option_descriptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filehandle</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">descriptions</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_text</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/binarycpython/utils/population_extensions/grid_options_defaults.html#grid_options_defaults.print_option_descriptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.print_option_descriptions" title="Permalink to this definition"></a></dt>
<dd><p>Function to print the description of an option</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.write_grid_options_to_rst_file">
<span class="sig-name descname"><span class="pre">write_grid_options_to_rst_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_file</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/binarycpython/utils/population_extensions/grid_options_defaults.html#grid_options_defaults.write_grid_options_to_rst_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#binarycpython.utils.population_extensions.grid_options_defaults.grid_options_defaults.write_grid_options_to_rst_file" title="Permalink to this definition"></a></dt><dd><p>Function that writes the descriptions of the grid options to an rst file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>output_file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – target file where the grid options descriptions are written to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="grid_logging.html" class="btn btn-neutral float-left" title="Population class extension: grid_logging module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="HPC.html" class="btn btn-neutral float-right" title="Population class extension: HPC module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2021, David Hendriks, Robert Izzard.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
<br><br>
Generated on binarycpython git branch: development_0.9.3/2.2.1 git revision 7e2b822d04dcc5482eabcc79ac1fe76bc42a6ece url: <a href="https://gitlab.surrey.ac.uk/ri0005/binary_c-python/-/tree/development_0.9.3/2.2.1">git url</a>.
<br><br>
Using binary_c with bit branch branch_david: git revision: "5845:20220107:201620bd7" url: <a href="https://gitlab.surrey.ac.uk/ri0005/binary_c/-/tree/branch_david">git url</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>