Code owners
Assign users and groups as approvers for specific file changes. Learn more.
example_notebooks.html 17.23 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>Example notebooks — 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="Tutorial: Running individual systems with binary_c-python" href="examples/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"> 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"><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="examples/notebook_individual_systems.html">Tutorial: Running individual systems with binary_c-python</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_custom_logging.html">Tutorial: Using custom logging routines with binary_c-python</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_population.html">Tutorial: Running populations with binary_c-python</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_extra_features.html">Tutorial: Extra features and functionality of binary_c-python</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_api_functionality.html">Tutorial: Using the API functionality of binary_c-python</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_luminosity_function_single.html">Example use case: Zero-age stellar luminosity function</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_luminosity_function_binaries.html">Example use case: Zero-age stellar luminosity function in binaries</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_HRD.html">Example use case: Hertzsprung-Russell diagrams</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_common_envelope_evolution.html">Example use case: Common-envelope evolution</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_BHBH.html">Example use case: Binary black hole systems</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_massive_remnants.html">Example use case: Massive star luminosity</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_solar_system.html">Example use case: Solar system using the API functionality</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="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>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>
<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" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="examples/notebook_individual_systems.html">Tutorial: Running individual systems with binary_c-python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_individual_systems.html#Single-system-with-run_system_wrapper">Single system with run_system_wrapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/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="examples/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="examples/notebook_custom_logging.html">Tutorial: Using custom logging routines with binary_c-python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_custom_logging.html#Usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/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="examples/notebook_population.html">Tutorial: Running populations with binary_c-python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_population.html#Setting-up-the-Population-object">Setting up the Population object</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_population.html#Adding-grid-variables">Adding grid variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/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="examples/notebook_population.html#Evolving-the-grid">Evolving the grid</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_population.html#Noteworthy-functionality">Noteworthy functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/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="examples/notebook_extra_features.html">Tutorial: Extra features and functionality of binary_c-python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/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="examples/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="examples/notebook_extra_features.html#Example-parse-function">Example parse function</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_extra_features.html#Dictionary-modification">Dictionary modification</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/notebook_api_functionality.html">Tutorial: Using the API functionality of binary_c-python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_api_functionality.html#Example-usage:">Example usage:</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/notebook_luminosity_function_single.html">Example use case: Zero-age stellar luminosity function</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/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="examples/notebook_luminosity_function_single.html#Adding-grid-variables">Adding grid variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/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="examples/notebook_luminosity_function_single.html#Evolving-the-grid">Evolving the grid</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/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="examples/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="examples/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="examples/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="examples/notebook_luminosity_function_binaries.html#Adding-grid-variables">Adding grid variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/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="examples/notebook_luminosity_function_binaries.html#Evolving-the-grid">Evolving the grid</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/notebook_HRD.html">Example use case: Hertzsprung-Russell diagrams</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_HRD.html#Setting-up-the-Population-object">Setting up the Population object</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_HRD.html#Stellar-Grid">Stellar Grid</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_HRD.html#Setting-logging-and-handling-the-output">Setting logging and handling the output</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_HRD.html#Evolving-the-grid">Evolving the grid</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_HRD.html#Binary-stars">Binary stars</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/notebook_common_envelope_evolution.html">Example use case: Common-envelope evolution</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_common_envelope_evolution.html#Setting-up-the-Population-object">Setting up the Population object</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_common_envelope_evolution.html#Stellar-Grid">Stellar Grid</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_common_envelope_evolution.html#Logging-and-handling-the-output">Logging and handling the output</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_common_envelope_evolution.html#Evolving-the-grid">Evolving the grid</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/notebook_BHBH.html">Example use case: Binary black hole systems</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/notebook_massive_remnants.html">Example use case: Massive star luminosity</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_massive_remnants.html#Setting-up-the-Population-object">Setting up the Population object</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_massive_remnants.html#Adding-grid-variables">Adding grid variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_massive_remnants.html#Setting-logging-and-handling-the-output">Setting logging and handling the output</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_massive_remnants.html#Evolving-the-grid">Evolving the grid</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/notebook_massive_remnants.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="examples/notebook_massive_remnants.html#A-better-sampled-grid">A better-sampled grid</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/notebook_solar_system.html">Example use case: Solar system using the API functionality</a></li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<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" aria-hidden="true"></span> Previous</a>
<a href="examples/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" 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 15fbbaba24e219ad1d2633582e4a420dc4e08955 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 HEAD: git revision: "5853:20220225:db09898b6" url: <a href="https://gitlab.surrey.ac.uk/ri0005/binary_c/-/tree/HEAD">git url</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>