<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>custom_logging_functions module — binary_c-python documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" 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 src="_static/language_data.js"></script>
<script type="text/javascript" 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="distribution_functions module" href="distribution_functions.html" />
<link rel="prev" title="Binarycpython code" href="modules.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" alt="Documentation 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="main navigation">
<p class="caption"><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 current"><a class="current reference internal" href="#">custom_logging_functions module</a></li>
<li class="toctree-l2"><a class="reference internal" href="distribution_functions.html">distribution_functions 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">grid_class module</a></li>
<li class="toctree-l2"><a class="reference internal" href="grid_options_defaults.html">Grid options and descriptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="hpc_functions.html">hpc_functions 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="run_system_wrapper.html">run_system_wrapper module</a></li>
<li class="toctree-l2"><a class="reference internal" href="spacing_functions.html">spacing_functions 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="examples.html">Examples</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="top navigation">
<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="breadcrumbs 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>custom_logging_functions module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/custom_logging_functions.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">
<div class="section" id="module-binarycpython.utils.custom_logging_functions">
<span id="custom-logging-functions-module"></span><h1>custom_logging_functions module<a class="headerlink" href="#module-binarycpython.utils.custom_logging_functions" title="Permalink to this headline">¶</a></h1>
<p>Module containing functions for the custom logging functionality.
The functions here make it possible for the user to define binaryc output logs on runtime</p>
<dl class="py function">
<dt id="binarycpython.utils.custom_logging_functions.autogen_C_logging_code">
<code class="sig-prename descclassname">binarycpython.utils.custom_logging_functions.</code><code class="sig-name descname">autogen_C_logging_code</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">logging_dict</span></em>, <em class="sig-param"><span class="n">verbose</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binarycpython/utils/custom_logging_functions.html#autogen_C_logging_code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binarycpython.utils.custom_logging_functions.autogen_C_logging_code" title="Permalink to this definition">¶</a></dt>
<dd><p>Function that autogenerates PRINTF statements for binaryc.
Input is a dictionary where the key is the header of that logging line
and items which are lists of parameters that will be put in that logging line</p>
<p>The list elements are all appended to ‘stardata->’ in the autogenerated code.</p>
<p class="rubric">Example</p>
<p>Input dictionary should look like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">'MY_STELLAR_DATA'</span><span class="p">:</span>
<span class="p">[</span>
<span class="s1">'model.time'</span><span class="p">,</span>
<span class="s1">'star[0].mass'</span><span class="p">,</span>
<span class="s1">'model.probability'</span><span class="p">,</span>
<span class="s1">'model.dt'</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>logging_dict</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>) – Dictionary containing lists of parameters that binary_c has to output. The keys are used by binary_c as start of the sentence.</p></li>
<li><p><strong>verbose</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Level of verbosity. Defaults to zero if not set explicilty.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>string containing C printf statement built to output the parameters given as input.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="binarycpython.utils.custom_logging_functions.binary_c_log_code">
<code class="sig-prename descclassname">binarycpython.utils.custom_logging_functions.</code><code class="sig-name descname">binary_c_log_code</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">verbose</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binarycpython/utils/custom_logging_functions.html#binary_c_log_code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binarycpython.utils.custom_logging_functions.binary_c_log_code" title="Permalink to this definition">¶</a></dt>
<dd><p>Function to construct the code to construct the custom logging function</p>
<p class="rubric">Example</p>
<p>Code to log and terminate evolution when the primary star becomes a NS:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">if</span><span class="p">(</span><span class="n">stardata</span><span class="o">-></span><span class="n">star</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">stellar_type</span><span class="o">>=</span><span class="n">NS</span><span class="p">)</span>
<span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="n">stardata</span><span class="o">-></span><span class="n">model</span><span class="o">.</span><span class="n">time</span> <span class="o"><</span> <span class="n">stardata</span><span class="o">-></span><span class="n">model</span><span class="o">.</span><span class="n">max_evolution_time</span><span class="p">)</span>
<span class="p">{</span>
<span class="n">Printf</span><span class="p">(</span><span class="s2">"EXAMPLE_LOG_CO </span><span class="si">%30.12e</span><span class="s2"> </span><span class="si">%g</span><span class="s2"> </span><span class="si">%g</span><span class="s2"> </span><span class="si">%g</span><span class="s2"> </span><span class="si">%g</span><span class="s2"> </span><span class="si">%d</span><span class="s2"> </span><span class="si">%d</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span>
<span class="o">//</span>
<span class="n">stardata</span><span class="o">-></span><span class="n">model</span><span class="o">.</span><span class="n">time</span><span class="p">,</span> <span class="o">//</span> <span class="mi">1</span>
<span class="n">stardata</span><span class="o">-></span><span class="n">star</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">mass</span><span class="p">,</span> <span class="o">//</span><span class="mi">2</span>
<span class="n">stardata</span><span class="o">-></span><span class="n">previous_stardata</span><span class="o">-></span><span class="n">star</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">mass</span><span class="p">,</span> <span class="o">//</span><span class="mi">3</span>
<span class="n">stardata</span><span class="o">-></span><span class="n">star</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">radius</span><span class="p">,</span> <span class="o">//</span><span class="mi">4</span>
<span class="n">stardata</span><span class="o">-></span><span class="n">previous_stardata</span><span class="o">-></span><span class="n">star</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">radius</span><span class="p">,</span> <span class="o">//</span><span class="mi">5</span>
<span class="n">stardata</span><span class="o">-></span><span class="n">star</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">stellar_type</span><span class="p">,</span> <span class="o">//</span><span class="mi">6</span>
<span class="n">stardata</span><span class="o">-></span><span class="n">previous_stardata</span><span class="o">-></span><span class="n">star</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">stellar_type</span> <span class="o">//</span><span class="mi">7</span>
<span class="p">);</span>
<span class="p">};</span>
<span class="o">/*</span> <span class="n">Kill</span> <span class="n">the</span> <span class="n">simulation</span> <span class="n">to</span> <span class="n">save</span> <span class="n">time</span> <span class="o">*/</span>
<span class="n">stardata</span><span class="o">-></span><span class="n">model</span><span class="o">.</span><span class="n">max_evolution_time</span> <span class="o">=</span> <span class="n">stardata</span><span class="o">-></span><span class="n">model</span><span class="o">.</span><span class="n">time</span> <span class="o">-</span> <span class="n">stardata</span><span class="o">-></span><span class="n">model</span><span class="o">.</span><span class="n">dtm</span><span class="p">;</span>
<span class="p">};</span>
</pre></div>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Exact c-statement to output information in binary_c. Can be wrapped in logical statements.</p></li>
<li><p><strong>verbose</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Level of verbosity. Defaults to zero if not set explicilty.</p></li>
</ul>
</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">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>string containing the custom logging code. This includes all the includes and other definitions. This code will be used as the shared library</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="binarycpython.utils.custom_logging_functions.binary_c_write_log_code">
<code class="sig-prename descclassname">binarycpython.utils.custom_logging_functions.</code><code class="sig-name descname">binary_c_write_log_code</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">filename</span></em>, <em class="sig-param"><span class="n">verbose</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binarycpython/utils/custom_logging_functions.html#binary_c_write_log_code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binarycpython.utils.custom_logging_functions.binary_c_write_log_code" title="Permalink to this definition">¶</a></dt>
<dd><p>Function to write the generated logging code to a file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – string containing the custom logging code to write to a file.</p></li>
<li><p><strong>filename</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – target filename.</p></li>
<li><p><strong>verbose</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Level of verbosity. Defaults to zero if not set explicilty.</p></li>
</ul>
</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>
<dl class="py function">
<dt id="binarycpython.utils.custom_logging_functions.compile_shared_lib">
<code class="sig-prename descclassname">binarycpython.utils.custom_logging_functions.</code><code class="sig-name descname">compile_shared_lib</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">sourcefile_name</span></em>, <em class="sig-param"><span class="n">outfile_name</span></em>, <em class="sig-param"><span class="n">verbose</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binarycpython/utils/custom_logging_functions.html#compile_shared_lib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binarycpython.utils.custom_logging_functions.compile_shared_lib" title="Permalink to this definition">¶</a></dt>
<dd><p>Function to write the custom logging code to a file and then compile it.</p>
<p>TODO: nicely put in the -fPIC
TODO: consider returning a status</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – string containing the custom logging code</p></li>
<li><p><strong>sourcefile_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – name of the file that will contain the code</p></li>
<li><p><strong>outfile_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – name of the file that will be the shared library</p></li>
<li><p><strong>verbose</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Level of verbosity. Defaults to zero if not set explicilty.</p></li>
</ul>
</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>
<dl class="py function">
<dt id="binarycpython.utils.custom_logging_functions.create_and_load_logging_function">
<code class="sig-prename descclassname">binarycpython.utils.custom_logging_functions.</code><code class="sig-name descname">create_and_load_logging_function</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">custom_logging_code</span></em>, <em class="sig-param"><span class="n">verbose</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">custom_tmp_dir</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binarycpython/utils/custom_logging_functions.html#create_and_load_logging_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binarycpython.utils.custom_logging_functions.create_and_load_logging_function" title="Permalink to this definition">¶</a></dt>
<dd><p>Function to automatically compile the shared library with the given
custom logging code and load it with ctypes.</p>
<p>This function is more or less the main function of this module and unless you know what you’re doing with the other functions
I recommend using this in function in combination with a function that generates the exact code (like <code class="xref py py-meth docutils literal notranslate"><span class="pre">binary_c_log_code()</span></code>)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>custom_logging_code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – string containing the custom logging code</p></li>
<li><p><strong>verbose</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Level of verbosity. Defaults to zero if not set explicilty.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>memory adress of the custom logging function in a int type.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="binarycpython.utils.custom_logging_functions.from_binary_c_config">
<code class="sig-prename descclassname">binarycpython.utils.custom_logging_functions.</code><code class="sig-name descname">from_binary_c_config</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config_file</span></em>, <em class="sig-param"><span class="n">flag</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binarycpython/utils/custom_logging_functions.html#from_binary_c_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binarycpython.utils.custom_logging_functions.from_binary_c_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Function to run the binaryc_config command with flags</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>config_file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – binary_c-config filepath TODO: change the name of this</p></li>
<li><p><strong>flag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – flag used in the binary_c-config call.</p></li>
</ul>
</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">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>returns the result of <binary_c-config> <flag></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="binarycpython.utils.custom_logging_functions.return_compilation_dict">
<code class="sig-prename descclassname">binarycpython.utils.custom_logging_functions.</code><code class="sig-name descname">return_compilation_dict</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">verbose</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binarycpython/utils/custom_logging_functions.html#return_compilation_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binarycpython.utils.custom_logging_functions.return_compilation_dict" title="Permalink to this definition">¶</a></dt>
<dd><p>Function to build the compile command for the shared library</p>
<p>Inspired by binary_c_inline_config command in perl</p>
<p>TODO: this function still has some cleaning up to do wrt default values for the compile command
# <a class="reference external" href="https://developers.redhat.com/blog/2018/03/21/compiler-and-linker-flags-gcc/">https://developers.redhat.com/blog/2018/03/21/compiler-and-linker-flags-gcc/</a></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>verbose</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Level of verbosity. Defaults to zero if not set explicilty.</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>string containing the command to build the shared library</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="distribution_functions.html" class="btn btn-neutral float-right" title="distribution_functions module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="modules.html" class="btn btn-neutral float-left" title="Binarycpython code" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2021, David Hendriks, Robert Izzard
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
<br><br>
Generated on binarycpython git branch: development_version/2.1.7 git revision 1b4c6f9cc7be3ad0a2d3770500d30d610bf35d8f url: <a href="https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python/-/tree/development_version/2.1.7">git url</a>.
<br><br>
Using binary_c with bit branch branch_david: git revision: "6044:20210720:d1ed5b6c1" url: <a href="https://gitlab.eps.surrey.ac.uk/ri0005/binary_c/-/tree/branch_david">git url</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>