Skip to content
Snippets Groups Projects
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
example_notebooks.html 13.96 KiB


<!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>Example notebooks &mdash; 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 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 async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
        <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</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="Tutorial: Running individual systems with binary_c-python" href="notebook_individual_systems.html" />
    <link rel="prev" title="useful_funcs module" href="useful_funcs.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"><a class="reference internal" href="modules.html">Binarycpython code</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Example notebooks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="notebook_individual_systems.html">Tutorial: Running individual systems with binary_c-python</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_custom_logging.html">Tutorial: Using custom logging routines with binary_c-python</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_population.html">Tutorial: Running populations with binary_c-python</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_extra_features.html">Tutorial: Extra features and functionality of binary_c-python</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_api_functionality.html">Tutorial: Using the API functionality of binary_c-python</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_luminosity_function_single.html">Example use case: Zero-age stellar luminosity function</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_luminosity_function_binaries.html">Example use case: Zero-age stellar luminosity function in binaries</a></li>
</ul>
</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> &raquo;</li>
        
      <li>Example notebooks</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/example_notebooks.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>
<div class="section" id="example-notebooks">
<h1>Example notebooks<a class="headerlink" href="#example-notebooks" title="Permalink to this headline">¶</a></h1>
<p>We have a set of notebooks that explain and show the usage of the binarycpython features. The notebooks are also stored in the examples/ directory in the <a class="reference external" href="https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python/-/tree/master/examples">repository</a></p>
<p>The order of the notebooks below is more or less the recommended order to read. The last couple of notebooks are example usecases</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="notebook_individual_systems.html">Tutorial: Running individual systems with binary_c-python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="notebook_individual_systems.html#Single-system-with-run_wrapper">Single system with run_wrapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_individual_systems.html#Single-system-via-population-object">Single system via population object</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_individual_systems.html#Single-system-via-API-functionality">Single system via API functionality</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="notebook_custom_logging.html">Tutorial: Using custom logging routines with binary_c-python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="notebook_custom_logging.html#Usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_custom_logging.html#Examples-of-logging-strings">Examples of logging strings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="notebook_population.html">Tutorial: Running populations with binary_c-python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="notebook_population.html#Setting-up-the-Population-object">Setting up the Population object</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_population.html#Adding-grid-variables">Adding grid variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_population.html#Setting-logging-and-handling-the-output">Setting logging and handling the output</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_population.html#Evolving-the-grid">Evolving the grid</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_population.html#Noteworthy-functionality">Noteworthy functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_population.html#Full-examples-of-population-scripts">Full examples of population scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="notebook_extra_features.html">Tutorial: Extra features and functionality of binary_c-python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="notebook_extra_features.html#getting-extra-information-about-binary_c-parameters">getting extra information about binary_c parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_extra_features.html#Build-information-of-binary_c">Build information of binary_c</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_extra_features.html#Example-parse-function">Example parse function</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_extra_features.html#Dictionary-modification">Dictionary modification</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_extra_features.html#Getting-help">Getting help</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="notebook_api_functionality.html">Tutorial: Using the API functionality of binary_c-python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="notebook_api_functionality.html#Example-usage:">Example usage:</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="notebook_luminosity_function_single.html">Example use case: Zero-age stellar luminosity function</a><ul>
<li class="toctree-l2"><a class="reference internal" href="notebook_luminosity_function_single.html#Setting-up-the-Population-object">Setting up the Population object</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_luminosity_function_single.html#Adding-grid-variables">Adding grid variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_luminosity_function_single.html#Setting-logging-and-handling-the-output">Setting logging and handling the output</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_luminosity_function_single.html#Evolving-the-grid">Evolving the grid</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_luminosity_function_single.html#ZAMS-Luminosity-distribution-with-the-initial-mass-function">ZAMS Luminosity distribution with the initial mass function</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_luminosity_function_single.html#A-better-sampled-grid">A better-sampled grid</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="notebook_luminosity_function_binaries.html">Example use case: Zero-age stellar luminosity function in binaries</a><ul>
<li class="toctree-l2"><a class="reference internal" href="notebook_luminosity_function_binaries.html#Setting-up-the-Population-object">Setting up the Population object</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_luminosity_function_binaries.html#Adding-grid-variables">Adding grid variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_luminosity_function_binaries.html#Setting-logging-and-handling-the-output">Setting logging and handling the output</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebook_luminosity_function_binaries.html#Evolving-the-grid">Evolving the grid</a></li>
</ul>
</li>
</ul>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="notebook_individual_systems.html" class="btn btn-neutral float-right" title="Tutorial: Running individual systems with binary_c-python" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="useful_funcs.html" class="btn btn-neutral float-left" title="useful_funcs module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        
        &copy; 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: master git revision 0e871bc098f163940c2256300af798a29ad36e29 url: <a href="https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python/-/tree/master">git url</a>.
<br><br>
Using binary_c with bit branch newmaster: git revision: "6185:20210910:1621c23a5" url: <a href="https://gitlab.eps.surrey.ac.uk/ri0005/binary_c/-/tree/newmaster">git url</a>.



</footer>

        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>