diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index a1c47f1cbca152a45b2ffa21300ef7ba6c48b24c..a55afdd521a7e085438117dc19577df0381194c4 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/grid_options_descriptions.doctree b/docs/build/doctrees/grid_options_descriptions.doctree index 5aba912489ff05c0ec09862e425f4c8e0f74109d..cc9ffd870ff70d24ee5752c26ab67babc7654714 100644 Binary files a/docs/build/doctrees/grid_options_descriptions.doctree and b/docs/build/doctrees/grid_options_descriptions.doctree differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree index 22d2e370b6297ae4c7c2e6bc90ce11008f601f54..718a50346bbec6e764df22335dd992bdf73b095c 100644 Binary files a/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/readme_link.doctree b/docs/build/doctrees/readme_link.doctree index 44d8850ecc6026a410d1bd617360626979745a19..c4af319685ff890a89b27c4801b3ce7ae7da8e7f 100644 Binary files a/docs/build/doctrees/readme_link.doctree and b/docs/build/doctrees/readme_link.doctree differ diff --git a/docs/build/html/_modules/binarycpython/utils/custom_logging_functions.html b/docs/build/html/_modules/binarycpython/utils/custom_logging_functions.html index 4e934288308f3ab578cdd2f5cbba552e50231364..98ea493c5e771fc00f7fe273c9110db6e085917c 100644 --- a/docs/build/html/_modules/binarycpython/utils/custom_logging_functions.html +++ b/docs/build/html/_modules/binarycpython/utils/custom_logging_functions.html @@ -87,6 +87,7 @@ <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">GitLab</a></li> </ul> diff --git a/docs/build/html/_modules/binarycpython/utils/distribution_functions.html b/docs/build/html/_modules/binarycpython/utils/distribution_functions.html index 57b7d0e499c418c39e1a1c007f0d729e5ba17542..cd4b2e23270282d3ed1f990bf92bccdfa0623131 100644 --- a/docs/build/html/_modules/binarycpython/utils/distribution_functions.html +++ b/docs/build/html/_modules/binarycpython/utils/distribution_functions.html @@ -87,6 +87,7 @@ <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">GitLab</a></li> </ul> diff --git a/docs/build/html/_modules/binarycpython/utils/functions.html b/docs/build/html/_modules/binarycpython/utils/functions.html index 3f083c3256a1ccd9c95b561e397cf9ed5181bc85..9c27f1825f51b2da052c10a3eeff516fd7da797c 100644 --- a/docs/build/html/_modules/binarycpython/utils/functions.html +++ b/docs/build/html/_modules/binarycpython/utils/functions.html @@ -87,6 +87,7 @@ <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">GitLab</a></li> </ul> diff --git a/docs/build/html/_modules/binarycpython/utils/grid.html b/docs/build/html/_modules/binarycpython/utils/grid.html index 22e2ce4ca80215568065f514fce46637181c4ad8..2f1fc2d45c20d2645f36497098566055f9a44d5d 100644 --- a/docs/build/html/_modules/binarycpython/utils/grid.html +++ b/docs/build/html/_modules/binarycpython/utils/grid.html @@ -87,6 +87,7 @@ <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">GitLab</a></li> </ul> diff --git a/docs/build/html/_modules/binarycpython/utils/grid_options_defaults.html b/docs/build/html/_modules/binarycpython/utils/grid_options_defaults.html index 22629f991899b712cf6771625fe6db1273d928a8..9fe1f0d37aac25cdc226fc82cb57cf84092b460b 100644 --- a/docs/build/html/_modules/binarycpython/utils/grid_options_defaults.html +++ b/docs/build/html/_modules/binarycpython/utils/grid_options_defaults.html @@ -87,6 +87,7 @@ <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">GitLab</a></li> </ul> @@ -239,8 +240,6 @@ <span class="s2">"_probtot"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="c1"># total probability</span> <span class="s2">"weight"</span><span class="p">:</span> <span class="mf">1.0</span><span class="p">,</span> <span class="c1"># weighting for the probability</span> <span class="s2">"repeat"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="c1"># number of times to repeat each system (probability is adjusted to be 1/repeat)</span> - <span class="s2">"results"</span><span class="p">:</span> <span class="p">{},</span> <span class="c1"># dict to store the results. Every process fills this on its own and then it will be joined later</span> - <span class="s2">"ensemble_results"</span><span class="p">:</span> <span class="p">{},</span> <span class="c1"># Dict to store the ensemble results</span> <span class="s2">"_start_time_evolution"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="c1"># Start time of the grid</span> <span class="s2">"_end_time_evolution"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="c1"># end time of the grid</span> <span class="s2">"_errors_found"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> <span class="c1"># Flag whether there are any errors from binary_c</span> @@ -590,7 +589,6 @@ <span class="s2">"_errors_found"</span><span class="p">:</span> <span class="s2">"Variable storing a boolean flag whether errors by binary_c are encountered."</span><span class="p">,</span> <span class="s2">"_errors_exceeded"</span><span class="p">:</span> <span class="s2">"Variable storing a boolean flag whether the amount of errors was higher than the set threshold (failed_systems_threshold). If True, then the commandline arguments of the failing systems will not be stored in the failed_system_log files."</span><span class="p">,</span> <span class="s2">"source_file_filename"</span><span class="p">:</span> <span class="s2">"Variable containing the source file containing lines of binary_c commandline calls. These all have to start with binary_c."</span><span class="p">,</span> <span class="c1"># TODO: Expand</span> - <span class="s2">"results"</span><span class="p">:</span> <span class="s2">"Dictionary in which the user can place their results. This dictionary gets merged at the end of a mulitprocessing simulation."</span><span class="p">,</span> <span class="s2">"C_auto_logging"</span><span class="p">:</span> <span class="s2">"Dictionary containing parameters to be logged by binary_c. The structure of this dictionary is as follows: the key is used as the headline which the user can then catch. The value at that key is a list of binary_c system parameters (like star[0].mass)"</span><span class="p">,</span> <span class="s2">"C_logging_code"</span><span class="p">:</span> <span class="s2">"Variable to store the exact code that is used for the custom_logging. In this way the user can do more complex logging, as well as putting these logging strings in files."</span><span class="p">,</span> <span class="s2">"_failed_count"</span><span class="p">:</span> <span class="s2">"Variable storing the amount of failed systems."</span><span class="p">,</span> @@ -618,7 +616,6 @@ <span class="s2">"repeat"</span><span class="p">:</span> <span class="s2">"Factor of how many times a system should be repeated. Consider the evolution splitting binary_c argument for supernovae kick repeating."</span><span class="p">,</span> <span class="c1"># TODO: make sure this is used.</span> <span class="s2">"evolution_type"</span><span class="p">:</span> <span class="s2">"Variable containing the type of evolution used of the grid. Multiprocessing or linear processing"</span><span class="p">,</span> <span class="s2">"combine_ensemble_with_thread_joining"</span><span class="p">:</span> <span class="s2">"BOolean flag on whether to combine everything and return it to the user or if false: write it to data_dir/ensemble_output_</span><span class="si">{popuation_id}</span><span class="s2">_</span><span class="si">{thread_id}</span><span class="s2">.json"</span><span class="p">,</span> - <span class="s2">"ensemble_results"</span><span class="p">:</span> <span class="s2">"Dictinary that stores the ensemble results if combine_ensemble_with_thread_joining==True"</span><span class="p">,</span> <span class="s2">"log_runtime_systems"</span><span class="p">:</span> <span class="s2">"Whether to log the runtime of the systems . Each systems run by the thread is logged to a file and is stored in the tmp_dir. (1 file per thread). Don't use this if you are planning to run alot of systems. This is mostly for debugging and finding systems that take long to run. Integer, default = 0. if value is 1 then the systems are logged"</span><span class="p">,</span> <span class="p">}</span> diff --git a/docs/build/html/_modules/binarycpython/utils/hpc_functions.html b/docs/build/html/_modules/binarycpython/utils/hpc_functions.html index 24338e44ea77f361e3e82b567f41d1808bd0f93c..26343d65dc33a7a889e8aea6742dee86a6a2c590 100644 --- a/docs/build/html/_modules/binarycpython/utils/hpc_functions.html +++ b/docs/build/html/_modules/binarycpython/utils/hpc_functions.html @@ -87,6 +87,7 @@ <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">GitLab</a></li> </ul> diff --git a/docs/build/html/_modules/binarycpython/utils/plot_functions.html b/docs/build/html/_modules/binarycpython/utils/plot_functions.html index acfd39c1545acf75e6282c54bd8822bd16ac93e3..78320e491f44d65f2685c7c95b2fa2fa1743e81b 100644 --- a/docs/build/html/_modules/binarycpython/utils/plot_functions.html +++ b/docs/build/html/_modules/binarycpython/utils/plot_functions.html @@ -87,6 +87,7 @@ <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">GitLab</a></li> </ul> diff --git a/docs/build/html/_modules/binarycpython/utils/run_system_wrapper.html b/docs/build/html/_modules/binarycpython/utils/run_system_wrapper.html index fb0db0ee1323d8e88e7a47ddcaab1432a356dfd2..9025161f63123041999678a2031c0ab241331de5 100644 --- a/docs/build/html/_modules/binarycpython/utils/run_system_wrapper.html +++ b/docs/build/html/_modules/binarycpython/utils/run_system_wrapper.html @@ -87,6 +87,7 @@ <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">GitLab</a></li> </ul> diff --git a/docs/build/html/_modules/binarycpython/utils/spacing_functions.html b/docs/build/html/_modules/binarycpython/utils/spacing_functions.html index 87fe236fcbaca9f967067e6f03644d11a4c7c662..44e0ddf21742cb07096a6f33cccc86c9da49665d 100644 --- a/docs/build/html/_modules/binarycpython/utils/spacing_functions.html +++ b/docs/build/html/_modules/binarycpython/utils/spacing_functions.html @@ -87,6 +87,7 @@ <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">GitLab</a></li> </ul> diff --git a/docs/build/html/_modules/binarycpython/utils/useful_funcs.html b/docs/build/html/_modules/binarycpython/utils/useful_funcs.html index 31738128bd2382cd7026c887d8b4c18fdb9b771c..01c278d1968fd8cefbe657d3a55348b671d120ea 100644 --- a/docs/build/html/_modules/binarycpython/utils/useful_funcs.html +++ b/docs/build/html/_modules/binarycpython/utils/useful_funcs.html @@ -87,6 +87,7 @@ <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">GitLab</a></li> </ul> diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html index a789af0843b21968bf2fb91f5c7fea80bd15f39f..8c749f2ce2073ac1abdd8b8c512b2754ced831ee 100644 --- a/docs/build/html/_modules/index.html +++ b/docs/build/html/_modules/index.html @@ -87,6 +87,7 @@ <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">GitLab</a></li> </ul> diff --git a/docs/build/html/_sources/grid_options_descriptions.rst.txt b/docs/build/html/_sources/grid_options_descriptions.rst.txt index 0f948ea04cddcd472441000f45fd2de48011ee71..7c1c75c4f19882a77b78468b995bc5dd9594dac9 100644 --- a/docs/build/html/_sources/grid_options_descriptions.rst.txt +++ b/docs/build/html/_sources/grid_options_descriptions.rst.txt @@ -23,8 +23,6 @@ The following options are meant to be changed by the user. | **custom_logging_func_memaddr**: Memory adress where the custom_logging_function is stored. Input: int -| **ensemble_results**: Dictinary that stores the ensemble results if combine_ensemble_with_thread_joining==True - | **evolution_type**: Variable containing the type of evolution used of the grid. Multiprocessing or linear processing | **failed_systems_threshold**: Variable storing the maximum amount of systems that are allowed to fail before logging their commandline arguments to failed_systems log files @@ -45,8 +43,6 @@ The following options are meant to be changed by the user. | **repeat**: Factor of how many times a system should be repeated. Consider the evolution splitting binary_c argument for supernovae kick repeating. -| **results**: Dictionary in which the user can place their results. This dictionary gets merged at the end of a mulitprocessing simulation. - | **slurm**: Int flag whether to use a slurm type population evolution. | **source_file_filename**: Variable containing the source file containing lines of binary_c commandline calls. These all have to start with binary_c. diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt index bf0ccf76e20c9344a43d7345dd40a3d377bc2f68..d1f22839883a98a5815066ce6532ee7f488fc72e 100644 --- a/docs/build/html/_sources/index.rst.txt +++ b/docs/build/html/_sources/index.rst.txt @@ -5,6 +5,8 @@ Welcome to binary_c-python's documentation! =========================================== +.. mdinclude:: ../../README.md + .. toctree:: :maxdepth: 2 @@ -15,11 +17,12 @@ Welcome to binary_c-python's documentation! examples binary_c_parameters grid_options_descriptions - - + GitLab <https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python> + Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` + diff --git a/docs/build/html/binary_c_parameters.html b/docs/build/html/binary_c_parameters.html index fadee75952a70b28799dfa0b17b5cf3f5f0e92a7..f49bcf2a64246f3317eb5649d6d25ea31842b4a6 100644 --- a/docs/build/html/binary_c_parameters.html +++ b/docs/build/html/binary_c_parameters.html @@ -99,6 +99,7 @@ </ul> </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">GitLab</a></li> </ul> diff --git a/docs/build/html/custom_logging_functions.html b/docs/build/html/custom_logging_functions.html index 24fb7ce334b87a930af40a6f711c21984b294e47..2ec6a003cf5c714053b7a6f124c0c037d440f535 100644 --- a/docs/build/html/custom_logging_functions.html +++ b/docs/build/html/custom_logging_functions.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</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> @@ -102,6 +104,7 @@ <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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/distribution_functions.html b/docs/build/html/distribution_functions.html index 24ab3090a372707eb5a272e075eed19bc3f6482a..828310cf1d1eff9a804f528bd3eba2e6e8bdf2a2 100644 --- a/docs/build/html/distribution_functions.html +++ b/docs/build/html/distribution_functions.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</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 current"><a class="current reference internal" href="#">distribution_functions module</a></li> @@ -102,6 +104,7 @@ <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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/examples.html b/docs/build/html/examples.html index d94fdbd349546254cb6e17e9e8e0263c1eae4db4..bda1409f85990bcc71ca3e63051e830873b864a7 100644 --- a/docs/build/html/examples.html +++ b/docs/build/html/examples.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</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="#">Examples</a><ul> <li class="toctree-l2"><a class="reference internal" href="general_examples.html">Examples</a></li> @@ -93,6 +95,7 @@ </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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/functions.html b/docs/build/html/functions.html index 0b8698f3ef325ed40849dde447ef053806177b72..9184fde1e46441d41a45fb076088768dafb0f5fc 100644 --- a/docs/build/html/functions.html +++ b/docs/build/html/functions.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</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="distribution_functions.html">distribution_functions module</a></li> @@ -102,6 +104,7 @@ <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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/general_examples.html b/docs/build/html/general_examples.html index 82aecdc2b570ec7d37f37139303bbb9ae38d0386..bfc9a31f245f1c2d0866fe6bc034eacdc366b223 100644 --- a/docs/build/html/general_examples.html +++ b/docs/build/html/general_examples.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</a></li> <li class="toctree-l1"><a class="reference internal" href="modules.html">Binarycpython code</a></li> <li class="toctree-l1 current"><a class="reference internal" href="examples.html">Examples</a><ul class="current"> <li class="toctree-l2 current"><a class="current reference internal" href="#">Examples</a></li> @@ -93,6 +95,7 @@ </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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index e9954b899a4e96fef83e739dab6e87ecd7338ace..e344e42eb5ce544e7843ed3e86a7b3e8bca0da41 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -87,6 +87,7 @@ <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">GitLab</a></li> </ul> diff --git a/docs/build/html/grid.html b/docs/build/html/grid.html index 8ced97503a8ddaf708ab2e314b78d9bb496091c7..1e11f418ca0ecf32f9f67f209651d50b93bfc1b8 100644 --- a/docs/build/html/grid.html +++ b/docs/build/html/grid.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</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="distribution_functions.html">distribution_functions module</a></li> @@ -102,6 +104,7 @@ <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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/grid_options_defaults.html b/docs/build/html/grid_options_defaults.html index 148ec390eb8387bb28eb85d726280d263da07bf8..37eea5bee7d7015dbc22489e3924a9d3893e80b0 100644 --- a/docs/build/html/grid_options_defaults.html +++ b/docs/build/html/grid_options_defaults.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</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="distribution_functions.html">distribution_functions module</a></li> @@ -102,6 +104,7 @@ <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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/grid_options_descriptions.html b/docs/build/html/grid_options_descriptions.html index aef7e1c0c4f0583822bf0908c65a64d8a89b4417..99492f0b8df16760c67a65c05dfc595873272e7d 100644 --- a/docs/build/html/grid_options_descriptions.html +++ b/docs/build/html/grid_options_descriptions.html @@ -92,6 +92,7 @@ <li class="toctree-l2"><a class="reference internal" href="#private-options">Private options</a></li> </ul> </li> +<li class="toctree-l1"><a class="reference external" href="https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python">GitLab</a></li> </ul> @@ -186,9 +187,6 @@ There are 1 options that are not described yet.</p> <div class="line"><strong>custom_logging_func_memaddr</strong>: Memory adress where the custom_logging_function is stored. Input: int</div> </div> <div class="line-block"> -<div class="line"><strong>ensemble_results</strong>: Dictinary that stores the ensemble results if combine_ensemble_with_thread_joining==True</div> -</div> -<div class="line-block"> <div class="line"><strong>evolution_type</strong>: Variable containing the type of evolution used of the grid. Multiprocessing or linear processing</div> </div> <div class="line-block"> @@ -219,9 +217,6 @@ There are 1 options that are not described yet.</p> <div class="line"><strong>repeat</strong>: Factor of how many times a system should be repeated. Consider the evolution splitting binary_c argument for supernovae kick repeating.</div> </div> <div class="line-block"> -<div class="line"><strong>results</strong>: Dictionary in which the user can place their results. This dictionary gets merged at the end of a mulitprocessing simulation.</div> -</div> -<div class="line-block"> <div class="line"><strong>slurm</strong>: Int flag whether to use a slurm type population evolution.</div> </div> <div class="line-block"> diff --git a/docs/build/html/hpc_functions.html b/docs/build/html/hpc_functions.html index 627876c8f96a6fefdb5c1d5adcbf856a5b594d01..c1e1bf215502d6f186acfbd654991a2a4aa7f151 100644 --- a/docs/build/html/hpc_functions.html +++ b/docs/build/html/hpc_functions.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</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="distribution_functions.html">distribution_functions module</a></li> @@ -102,6 +104,7 @@ <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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/index.html b/docs/build/html/index.html index 7937e04943dba6d1afc70ff513cad7227b1a15d3..a7567522b55b45395ee333731e8922abd5118e18 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -88,6 +88,7 @@ <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">GitLab</a></li> </ul> @@ -155,6 +156,102 @@ <div class="section" id="welcome-to-binary-c-python-s-documentation"> <h1>Welcome to binary_c-python’s documentation!<a class="headerlink" href="#welcome-to-binary-c-python-s-documentation" title="Permalink to this headline">¶</a></h1> +</div> +<div class="section" id="python-module-for-binary-c"> +<h1>Python module for binary_c<a class="headerlink" href="#python-module-for-binary-c" title="Permalink to this headline">¶</a></h1> +<p>Coverage: +.. image:: coverage.svg</p> +<blockquote> +<div><dl class="field-list simple"> +<dt class="field-odd">target</dt> +<dd class="field-odd"><p>coverage.svg</p> +</dd> +<dt class="field-even">alt</dt> +<dd class="field-even"><p>alt text</p> +</dd> +</dl> +</div></blockquote> +<p>Based on a original work by Jeff Andrews (can be found in old_solution/ directory) +updated and extended for Python3 by Robert Izzard, David hendriks</p> +<div class="section" id="requirements"> +<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2> +<p>To run this code you need to at least have installations of:</p> +<ul class="simple"> +<li><p>Python3</p></li> +<li><p>binary_c version 2.1+</p></li> +</ul> +<p>And the following python packages (which will get installed automatically when installing with pip):</p> +<ul class="simple"> +<li><p>numpy</p></li> +<li><p>pytest</p></li> +<li><p>h5py</p></li> +<li><p>pathos</p></li> +<li><p>pandas</p></li> +<li><p>astropy</p></li> +<li><p>matplotlib</p></li> +</ul> +</div> +<div class="section" id="environment-variables"> +<h2>Environment variables<a class="headerlink" href="#environment-variables" title="Permalink to this headline">¶</a></h2> +<p>Before compilation you need to have certain environment variables:</p> +<p>Required:</p> +<ul class="simple"> +<li><p><code class="docutils literal notranslate"><span class="pre">BINARY_C</span></code> should point to the root directory of your binary_c installation</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">LD_LIBRARY_PATH</span></code> should include $BINARY_C/src and whatever directories are required to run binary_c (e.g. locations of libgsl, libmemoize, librinterpolate, etc.)</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">LIBRARY_PATH</span></code> should include whatever directories are required to build binary_c (e.g. locations of libgsl, libmemoize, librinterpolate, etc.)</p></li> +</ul> +</div> +<div class="section" id="build-instructions"> +<h2>Build instructions<a class="headerlink" href="#build-instructions" title="Permalink to this headline">¶</a></h2> +<p>First, make sure you have built binary_c (See <code class="docutils literal notranslate"><span class="pre">$BINARY_C/doc/binary_c2.pdf</span></code> section: installation for all the installation instructions for <code class="docutils literal notranslate"><span class="pre">binary_c</span></code>)) and that it functions correctly.</p> +<div class="section" id="installation-via-pip"> +<h3>Installation via PIP:<a class="headerlink" href="#installation-via-pip" title="Permalink to this headline">¶</a></h3> +<p>To install this package via pip:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">binarycpython</span> +</pre></div> +</div> +</div> +<div class="section" id="installation-from-source"> +<h3>Installation from source:<a class="headerlink" href="#installation-from-source" title="Permalink to this headline">¶</a></h3> +<p>For this it is best to set up a virtual environment for this. Activate the virtualenvironment and enter the downloaded version of the repo.</p> +<p>Then run</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">clean</span> <span class="o">&&</span> <span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">build</span> <span class="o">--</span><span class="n">force</span> <span class="o">&&</span> <span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">sdist</span> <span class="o">&&</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">ignore</span><span class="o">-</span><span class="n">installed</span> <span class="o">--</span><span class="n">no</span><span class="o">-</span><span class="n">dependencies</span> <span class="o">-</span><span class="n">v</span> <span class="n">dist</span><span class="o">/</span><span class="n">binarycpython</span><span class="o">-<</span><span class="n">version</span> <span class="n">of</span> <span class="n">this</span> <span class="n">package</span><span class="o">>.</span><span class="n">tar</span><span class="o">.</span><span class="n">gz</span> +</pre></div> +</div> +<p>This will install this package into the virtual environment. Making changes to the sourcecode can be “installed†into the virtual env with the same command.</p> +</div> +</div> +<div class="section" id="examples"> +<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2> +<p>See the examples/ directory for example script. The documentation contains example pages as well.</p> +</div> +<div class="section" id="usage-notes"> +<h2>Usage notes<a class="headerlink" href="#usage-notes" title="Permalink to this headline">¶</a></h2> +<p>Make sure that with every change/recompilation you make in <code class="docutils literal notranslate"><span class="pre">binary_c</span></code>, you also rebuild this package.</p> +</div> +<div class="section" id="documentation"> +<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2> +<p>Look in the doc/ directory. Within the build/html/ there is the html version of the documentation.</p> +</div> +<div class="section" id="faq-issues"> +<h2>FAQ/Issues:<a class="headerlink" href="#faq-issues" title="Permalink to this headline">¶</a></h2> +<p>Building issues with binary_c itself:</p> +<ul class="simple"> +<li><p>see the documentation of binary_c (in doc/).</p></li> +<li><p>If you have MESA installed, make sure that the <code class="docutils literal notranslate"><span class="pre">$MESASDK_ROOT/bin/mesasdk_init.sh</span></code> is not sourced. It comes with its own version of some programs, and those can interfere with installing.</p></li> +</ul> +<p>When Pip install fails:</p> +<ul class="simple"> +<li><p>Run the installation with <code class="docutils literal notranslate"><span class="pre">-v</span></code> and/or <code class="docutils literal notranslate"><span class="pre">--log</span> <span class="pre"><logfile></span></code> to get some more info</p></li> +<li><p>If gcc throws errors like <code class="docutils literal notranslate"><span class="pre">gcc:</span> <span class="pre">error:</span> <span class="pre">unrecognized</span> <span class="pre">command</span> <span class="pre">line</span> <span class="pre">option</span> <span class="pre">‘-ftz’;</span> <span class="pre">did</span> <span class="pre">you</span> <span class="pre">mean</span> <span class="pre">‘-flto’?</span></code>, this might be due to that the python on that system was built with a different compiler. It then passes the python3.6-config –cflags to the binarycpython installation, which, if done with gcc, will not work. Try a different python3.6. I suggest using <code class="docutils literal notranslate"><span class="pre">pyenv</span></code> to manage python versions. If installing a version of python with pyenv is not possible, then try to use a python version that is avaible to the machine that is built with the same compiler as binary_c was built with.</p></li> +<li><p>if pip installation results in <code class="docutils literal notranslate"><span class="pre">No</span> <span class="pre">files/directories</span> <span class="pre">in</span> <span class="pre">/tmp/pip-1ckzg0p9-build/pip-egg-info</span> <span class="pre">(from</span> <span class="pre">PKG-INFO)</span></code>, try running it verbose (<code class="docutils literal notranslate"><span class="pre">-v</span></code>) to see what is actually going wrong.</p></li> +<li><p>If pip terminates with the error FileNotFoundError: [Errno 2] No such file or directory: ‘<…>/binary_c-config’ Then make sure that the path to your main $BINARY_C directory is set correctly.</p></li> +</ul> +<p>Other:</p> +<ul class="simple"> +<li><p>When running jupyter notebooks, make sure you are running the jupyter installation from the same virtual environment.</p></li> +<li><p>When the output of binary_c seems to be different than expected, you might need to rebuild this python package. Everytime binary_c is compiled, this package needs to be rebuilt too.</p></li> +</ul> <div class="toctree-wrapper compound"> <p class="caption"><span class="caption-text">Contents:</span></p> <ul> @@ -162,8 +259,10 @@ <li class="toctree-l2"><a class="reference internal" href="readme_link.html#requirements">Requirements</a></li> <li class="toctree-l2"><a class="reference internal" href="readme_link.html#environment-variables">Environment variables</a></li> <li class="toctree-l2"><a class="reference internal" href="readme_link.html#build-instructions">Build instructions</a></li> +<li class="toctree-l2"><a class="reference internal" href="readme_link.html#examples">Examples</a></li> <li class="toctree-l2"><a class="reference internal" href="readme_link.html#usage-notes">Usage notes</a></li> -<li class="toctree-l2"><a class="reference internal" href="readme_link.html#faq">FAQ:</a></li> +<li class="toctree-l2"><a class="reference internal" href="readme_link.html#documentation">Documentation</a></li> +<li class="toctree-l2"><a class="reference internal" href="readme_link.html#faq-issues">FAQ/Issues:</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="modules.html">Binarycpython code</a><ul> @@ -197,9 +296,11 @@ <li class="toctree-l2"><a class="reference internal" href="grid_options_descriptions.html#private-options">Private options</a></li> </ul> </li> +<li class="toctree-l1"><a class="reference external" href="https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python">GitLab</a></li> </ul> </div> </div> +</div> <div class="section" id="indices-and-tables"> <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1> <ul class="simple"> diff --git a/docs/build/html/modules.html b/docs/build/html/modules.html index aa5eb5e26efd91d79e10b479834dcd6295957375..6dc4b42e062fa90c6d5b93226122d1fd80d10a71 100644 --- a/docs/build/html/modules.html +++ b/docs/build/html/modules.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Binarycpython code</a><ul> <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="distribution_functions.html">distribution_functions module</a></li> @@ -102,6 +104,7 @@ <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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index f64b02e86059822786cc5d39fb155ab3016694d5..73921d1fb3136eb65e2956afabe8464bdaa30722 100644 Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/plot_functions.html b/docs/build/html/plot_functions.html index 308c870e7fc6e6eb40b16a5eb880c7e713b37bb4..275b33a6961deb042b2135a2ee7bc95415d73e45 100644 --- a/docs/build/html/plot_functions.html +++ b/docs/build/html/plot_functions.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</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="distribution_functions.html">distribution_functions module</a></li> @@ -102,6 +104,7 @@ <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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/population_example.html b/docs/build/html/population_example.html index 3452450151bbf54692a145e148d5afeb399690a5..fdccaebaf24302af9f9fd50c0b82195ca67b67b8 100644 --- a/docs/build/html/population_example.html +++ b/docs/build/html/population_example.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</a></li> <li class="toctree-l1"><a class="reference internal" href="modules.html">Binarycpython code</a></li> <li class="toctree-l1 current"><a class="reference internal" href="examples.html">Examples</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="general_examples.html">Examples</a></li> @@ -93,6 +95,7 @@ </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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html index 3a44ccaf316334b0c2cba68c95f003caf0842bff..895499d62d8e60ffe39df7f2ff3d702d8c67af3e 100644 --- a/docs/build/html/py-modindex.html +++ b/docs/build/html/py-modindex.html @@ -90,6 +90,7 @@ <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">GitLab</a></li> </ul> diff --git a/docs/build/html/readme_link.html b/docs/build/html/readme_link.html index 0d318532938c6888bb3eeb3861f4d942b9478ae7..45cf9a2f9cd52e2e6d2f37e47544a13c25f44c14 100644 --- a/docs/build/html/readme_link.html +++ b/docs/build/html/readme_link.html @@ -87,15 +87,22 @@ <li class="toctree-l1 current"><a class="current reference internal" href="#">Python module for binary_c</a><ul> <li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li> <li class="toctree-l2"><a class="reference internal" href="#environment-variables">Environment variables</a></li> -<li class="toctree-l2"><a class="reference internal" href="#build-instructions">Build instructions</a></li> +<li class="toctree-l2"><a class="reference internal" href="#build-instructions">Build instructions</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l3"><a class="reference internal" href="#installation-from-source">Installation from source:</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li> <li class="toctree-l2"><a class="reference internal" href="#usage-notes">Usage notes</a></li> -<li class="toctree-l2"><a class="reference internal" href="#faq">FAQ:</a></li> +<li class="toctree-l2"><a class="reference internal" href="#documentation">Documentation</a></li> +<li class="toctree-l2"><a class="reference internal" href="#faq-issues">FAQ/Issues:</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="modules.html">Binarycpython code</a></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">GitLab</a></li> </ul> @@ -177,65 +184,85 @@ </div></blockquote> <p>Based on a original work by Jeff Andrews (can be found in old_solution/ directory) updated and extended for Python3 by Robert Izzard, David hendriks</p> -<p>Warning : THIS CODE IS EXPERIMENTAL!</p> -<p><a class="reference external" href="mailto:r.izzard%40surrey.ac.uk">r<span>.</span>izzard<span>@</span>surrey<span>.</span>ac<span>.</span>uk</a> -<a class="reference external" href="http://personal.ph.surrey.ac.uk/~ri0005/binary_c.html">http://personal.ph.surrey.ac.uk/~ri0005/binary_c.html</a> -09/06/2019</p> <div class="section" id="requirements"> <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2> +<p>To run this code you need to at least have installations of:</p> <ul class="simple"> <li><p>Python3</p></li> <li><p>binary_c version 2.1+</p></li> -<li><p>requirements.txt (no?)</p></li> +</ul> +<p>And the following python packages (which will get installed automatically when installing with pip):</p> +<ul class="simple"> +<li><p>numpy</p></li> +<li><p>pytest</p></li> +<li><p>h5py</p></li> +<li><p>pathos</p></li> +<li><p>pandas</p></li> +<li><p>astropy</p></li> +<li><p>matplotlib</p></li> </ul> </div> <div class="section" id="environment-variables"> <h2>Environment variables<a class="headerlink" href="#environment-variables" title="Permalink to this headline">¶</a></h2> -<p>Before compilation you should set the following environment variables:</p> +<p>Before compilation you need to have certain environment variables:</p> +<p>Required:</p> <ul class="simple"> -<li><p>required: <code class="docutils literal notranslate"><span class="pre">BINARY_C</span></code> should point to the root directory of your binary_c installation</p></li> -<li><p>recommended: <code class="docutils literal notranslate"><span class="pre">LD_LIBRARY_PATH</span></code> should include $BINARY_C/src and whatever directories are required to run binary_c (e.g. locations of libgsl, libmemoize, librinterpolate, etc.)</p></li> -<li><p>recommended: <code class="docutils literal notranslate"><span class="pre">LIBRARY_PATH</span></code> should include whatever directories are required to build binary_c (e.g. locations of libgsl, libmemoize, librinterpolate, etc.)</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">BINARY_C</span></code> should point to the root directory of your binary_c installation</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">LD_LIBRARY_PATH</span></code> should include $BINARY_C/src and whatever directories are required to run binary_c (e.g. locations of libgsl, libmemoize, librinterpolate, etc.)</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">LIBRARY_PATH</span></code> should include whatever directories are required to build binary_c (e.g. locations of libgsl, libmemoize, librinterpolate, etc.)</p></li> </ul> </div> <div class="section" id="build-instructions"> <h2>Build instructions<a class="headerlink" href="#build-instructions" title="Permalink to this headline">¶</a></h2> -<p>To build the module, make sure you have built binary_c (with <code class="docutils literal notranslate"><span class="pre">make</span></code> in the binary_c root directory), its shared library (with <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">libbinary_c.so</span></code> in the binary_c root directory), and set environment variables as described above, then run the following code in t:</p> -<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">clean</span> -<span class="n">make</span> +<p>First, make sure you have built binary_c (See <code class="docutils literal notranslate"><span class="pre">$BINARY_C/doc/binary_c2.pdf</span></code> section: installation for all the installation instructions for <code class="docutils literal notranslate"><span class="pre">binary_c</span></code>)) and that it functions correctly.</p> +<div class="section" id="installation-via-pip"> +<h3>Installation via PIP:<a class="headerlink" href="#installation-via-pip" title="Permalink to this headline">¶</a></h3> +<p>To install this package via pip:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">binarycpython</span> </pre></div> </div> -<p>Then to test the Python module:</p> -<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="o">./</span><span class="n">python_API_test</span><span class="o">.</span><span class="n">py</span> -</pre></div> </div> -<p>You will require whatever libraries with which binary_c was compiled, as well as the compiler with which Python was built (usually gcc, which is easily installed on most systems).</p> -<p>If you want to be able to import the binary_c module correctly for child directories (or anywhere for that matter), execute or put the following code in your .bashrc/.zshrc:</p> -<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>export LD_LIBRARY_PATH=<full path to root dir of repo>:$LD_LIBRARY_PATH -export PYTHONPATH=<full path to root dir of repo>:$PYTHONPATH +<div class="section" id="installation-from-source"> +<h3>Installation from source:<a class="headerlink" href="#installation-from-source" title="Permalink to this headline">¶</a></h3> +<p>For this it is best to set up a virtual environment for this. Activate the virtualenvironment and enter the downloaded version of the repo.</p> +<p>Then run</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">clean</span> <span class="o">&&</span> <span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">build</span> <span class="o">--</span><span class="n">force</span> <span class="o">&&</span> <span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">sdist</span> <span class="o">&&</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">ignore</span><span class="o">-</span><span class="n">installed</span> <span class="o">--</span><span class="n">no</span><span class="o">-</span><span class="n">dependencies</span> <span class="o">-</span><span class="n">v</span> <span class="n">dist</span><span class="o">/</span><span class="n">binarycpython</span><span class="o">-<</span><span class="n">version</span> <span class="n">of</span> <span class="n">this</span> <span class="n">package</span><span class="o">>.</span><span class="n">tar</span><span class="o">.</span><span class="n">gz</span> </pre></div> </div> +<p>This will install this package into the virtual environment. Making changes to the sourcecode can be “installed†into the virtual env with the same command.</p> +</div> +</div> +<div class="section" id="examples"> +<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2> +<p>See the examples/ directory for example script. The documentation contains example pages as well.</p> </div> <div class="section" id="usage-notes"> <h2>Usage notes<a class="headerlink" href="#usage-notes" title="Permalink to this headline">¶</a></h2> -<p>When running a jupyter notebook and importing binary_c, it might happen that the module binary_c cannot be found. I experienced this when I executed Jupyter Notebook from a virtual environment which didnt use the same python (version/binary/shim) as the one I built this library with. Make sure jupyter does use the same underlying python version/binary/shim. That resolved the issue for me.</p> -<p>Also: I figured that having binaryc output the log like “<span class="raw-html-m2r"><LOG HEADER></span> t=10e4 …†(i.e. printing the parameter names as well as their values) would be useful because in that way one can easily have python read that out automatically instead of having to manually copy the list of parameter names.</p> -<p>See examples/ dir for some working examples</p> -<p>When you try to <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">binary_c_python_api</span></code> and python complains about it not existing, but you are sure that you correctly included the necessary pythonpaths, then you probably need to rebuild the package.</p> +<p>Make sure that with every change/recompilation you make in <code class="docutils literal notranslate"><span class="pre">binary_c</span></code>, you also rebuild this package.</p> +</div> +<div class="section" id="documentation"> +<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2> +<p>Look in the doc/ directory. Within the build/html/ there is the html version of the documentation.</p> </div> -<div class="section" id="faq"> -<h2>FAQ:<a class="headerlink" href="#faq" title="Permalink to this headline">¶</a></h2> +<div class="section" id="faq-issues"> +<h2>FAQ/Issues:<a class="headerlink" href="#faq-issues" title="Permalink to this headline">¶</a></h2> <p>Building issues with binary_c itself:</p> <ul class="simple"> <li><p>see the documentation of binary_c (in doc/).</p></li> <li><p>If you have MESA installed, make sure that the <code class="docutils literal notranslate"><span class="pre">$MESASDK_ROOT/bin/mesasdk_init.sh</span></code> is not sourced. It comes with its own version of some programs, and those can interfere with installing.</p></li> </ul> -<p>Pip install failed:</p> +<p>When Pip install fails:</p> <ul class="simple"> <li><p>Run the installation with <code class="docutils literal notranslate"><span class="pre">-v</span></code> and/or <code class="docutils literal notranslate"><span class="pre">--log</span> <span class="pre"><logfile></span></code> to get some more info</p></li> <li><p>If gcc throws errors like <code class="docutils literal notranslate"><span class="pre">gcc:</span> <span class="pre">error:</span> <span class="pre">unrecognized</span> <span class="pre">command</span> <span class="pre">line</span> <span class="pre">option</span> <span class="pre">‘-ftz’;</span> <span class="pre">did</span> <span class="pre">you</span> <span class="pre">mean</span> <span class="pre">‘-flto’?</span></code>, this might be due to that the python on that system was built with a different compiler. It then passes the python3.6-config –cflags to the binarycpython installation, which, if done with gcc, will not work. Try a different python3.6. I suggest using <code class="docutils literal notranslate"><span class="pre">pyenv</span></code> to manage python versions. If installing a version of python with pyenv is not possible, then try to use a python version that is avaible to the machine that is built with the same compiler as binary_c was built with.</p></li> +<li><p>if pip installation results in <code class="docutils literal notranslate"><span class="pre">No</span> <span class="pre">files/directories</span> <span class="pre">in</span> <span class="pre">/tmp/pip-1ckzg0p9-build/pip-egg-info</span> <span class="pre">(from</span> <span class="pre">PKG-INFO)</span></code>, try running it verbose (<code class="docutils literal notranslate"><span class="pre">-v</span></code>) to see what is actually going wrong.</p></li> +<li><p>If pip terminates with the error FileNotFoundError: [Errno 2] No such file or directory: ‘<…>/binary_c-config’ Then make sure that the path to your main $BINARY_C directory is set correctly.</p></li> +</ul> +<p>Other:</p> +<ul class="simple"> +<li><p>When running jupyter notebooks, make sure you are running the jupyter installation from the same virtual environment.</p></li> +<li><p>When the output of binary_c seems to be different than expected, you might need to rebuild this python package. Everytime binary_c is compiled, this package needs to be rebuilt too.</p></li> </ul> -<p>if pip installation results in <code class="docutils literal notranslate"><span class="pre">No</span> <span class="pre">files/directories</span> <span class="pre">in</span> <span class="pre">/tmp/pip-1ckzg0p9-build/pip-egg-info</span> <span class="pre">(from</span> <span class="pre">PKG-INFO)</span></code>, try running it verbose (<code class="docutils literal notranslate"><span class="pre">-v</span></code>) to see what is actually going wrong.</p> </div> </div> diff --git a/docs/build/html/run_system_wrapper.html b/docs/build/html/run_system_wrapper.html index 6a55ea25c60438e298258e2e7fc71285ea652c80..ee1b44108f78e7955a625d8fa6603daf09572205 100644 --- a/docs/build/html/run_system_wrapper.html +++ b/docs/build/html/run_system_wrapper.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</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="distribution_functions.html">distribution_functions module</a></li> @@ -102,6 +104,7 @@ <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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/search.html b/docs/build/html/search.html index 611aafb8d84bd3b75951ff9d0288a405cf408aee..07f1d222ebf4e636d738ba584e5aa0440c8544a8 100644 --- a/docs/build/html/search.html +++ b/docs/build/html/search.html @@ -89,6 +89,7 @@ <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">GitLab</a></li> </ul> diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 18e10d8649e817ea96646ad84173d62364080160..707bc22610eda7a47840ca865db1a007f14445e7 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["binary_c_parameters","custom_logging_functions","distribution_functions","examples","functions","general_examples","grid","grid_options_defaults","grid_options_descriptions","hpc_functions","index","modules","plot_functions","population_example","readme_link","run_system_wrapper","spacing_functions","stellar_types","useful_funcs"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["binary_c_parameters.rst","custom_logging_functions.rst","distribution_functions.rst","examples.rst","functions.rst","general_examples.rst","grid.rst","grid_options_defaults.rst","grid_options_descriptions.rst","hpc_functions.rst","index.rst","modules.rst","plot_functions.rst","population_example.rst","readme_link.rst","run_system_wrapper.rst","spacing_functions.rst","stellar_types.rst","useful_funcs.rst"],objects:{"binarycpython.utils":{custom_logging_functions:[1,0,0,"-"],distribution_functions:[2,0,0,"-"],functions:[4,0,0,"-"],grid:[6,0,0,"-"],grid_options_defaults:[7,0,0,"-"],hpc_functions:[9,0,0,"-"],plot_functions:[12,0,0,"-"],run_system_wrapper:[15,0,0,"-"],spacing_functions:[16,0,0,"-"],stellar_types:[17,0,0,"-"],useful_funcs:[18,0,0,"-"]},"binarycpython.utils.custom_logging_functions":{autogen_C_logging_code:[1,1,1,""],binary_c_log_code:[1,1,1,""],binary_c_write_log_code:[1,1,1,""],compile_shared_lib:[1,1,1,""],create_and_load_logging_function:[1,1,1,""],from_binary_c_config:[1,1,1,""],return_compilation_dict:[1,1,1,""]},"binarycpython.utils.distribution_functions":{"const":[2,1,1,""],Arenou2010_binary_fraction:[2,1,1,""],Izzard2012_period_distribution:[2,1,1,""],Kroupa2001:[2,1,1,""],calculate_constants_three_part_powerlaw:[2,1,1,""],cosmic_SFH_madau_dickinson2014:[2,1,1,""],duquennoy1991:[2,1,1,""],flat:[2,1,1,""],flatsections:[2,1,1,""],gaussian:[2,1,1,""],gaussian_func:[2,1,1,""],gaussian_normalizing_const:[2,1,1,""],imf_chabrier2003:[2,1,1,""],imf_scalo1986:[2,1,1,""],imf_scalo1998:[2,1,1,""],imf_tinsley1980:[2,1,1,""],interpolate_in_mass_izzard2012:[2,1,1,""],ktg93:[2,1,1,""],number:[2,1,1,""],powerlaw:[2,1,1,""],powerlaw_constant:[2,1,1,""],prepare_dict:[2,1,1,""],raghavan2010_binary_fraction:[2,1,1,""],sana12:[2,1,1,""],set_opts:[2,1,1,""],three_part_powerlaw:[2,1,1,""]},"binarycpython.utils.functions":{BinaryCEncoder:[4,2,1,""],binarycDecoder:[4,2,1,""],binaryc_json_serializer:[4,1,1,""],create_arg_string:[4,1,1,""],create_hdf5:[4,1,1,""],example_parse_output:[4,1,1,""],extract_ensemble_json_from_string:[4,1,1,""],filter_arg_dict:[4,1,1,""],get_arg_keys:[4,1,1,""],get_defaults:[4,1,1,""],get_help:[4,1,1,""],get_help_all:[4,1,1,""],get_help_super:[4,1,1,""],handle_ensemble_string_to_json:[4,1,1,""],inspect_dict:[4,1,1,""],load_logfile:[4,1,1,""],make_build_text:[4,1,1,""],merge_dicts:[4,1,1,""],output_lines:[4,1,1,""],parse_binary_c_version_info:[4,1,1,""],remove_file:[4,1,1,""],return_binary_c_version_info:[4,1,1,""],temp_dir:[4,1,1,""],verbose_print:[4,1,1,""],write_binary_c_parameter_descriptions_to_rst_file:[4,1,1,""]},"binarycpython.utils.functions.BinaryCEncoder":{"default":[4,3,1,""]},"binarycpython.utils.functions.binarycDecoder":{decode:[4,3,1,""]},"binarycpython.utils.grid":{Population:[6,2,1,""]},"binarycpython.utils.grid.Population":{add_grid_variable:[6,3,1,""],evolve:[6,3,1,""],evolve_population:[6,3,1,""],evolve_single:[6,3,1,""],export_all_info:[6,3,1,""],parse_cmdline:[6,3,1,""],return_all_info:[6,3,1,""],return_population_settings:[6,3,1,""],set:[6,3,1,""],write_binary_c_calls_to_file:[6,3,1,""]},"binarycpython.utils.grid_options_defaults":{grid_options_description_checker:[7,1,1,""],grid_options_help:[7,1,1,""],write_grid_options_to_rst_file:[7,1,1,""]},"binarycpython.utils.plot_functions":{color_by_index:[12,1,1,""],dummy:[12,1,1,""],parse_function_hr_diagram:[12,1,1,""],parse_function_masses:[12,1,1,""],parse_function_orbit:[12,1,1,""],plot_HR_diagram:[12,1,1,""],plot_masses:[12,1,1,""],plot_orbit:[12,1,1,""],plot_system:[12,1,1,""]},"binarycpython.utils.run_system_wrapper":{run_system:[15,1,1,""]},"binarycpython.utils.spacing_functions":{"const":[16,1,1,""]},"binarycpython.utils.useful_funcs":{calc_period_from_sep:[18,1,1,""],calc_sep_from_period:[18,1,1,""],minimum_period_for_RLOF:[18,1,1,""],minimum_separation_for_RLOF:[18,1,1,""],ragb:[18,1,1,""],roche_lobe:[18,1,1,""],rzams:[18,1,1,""],zams_collision:[18,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"0001":18,"0007":2,"001":0,"002":5,"054":2,"0820":0,"08msun":0,"0902":0,"100":[0,2],"1000":5,"100000000000":5,"10e4":14,"115":2,"125":0,"12e":[1,13],"13e3":0,"1403":2,"150":13,"15000":[0,5,13],"15msun":2,"190":0,"1951":0,"1972":0,"1975":0,"1980":2,"1983":18,"1986":[0,2],"1991":2,"1993":0,"1996":18,"1998":[0,2],"1999":0,"1ckzg0p9":14,"1e9":0,"200":0,"2000":0,"2001":2,"2002":0,"2003":[0,2],"2004":0,"2005":0,"2009":0,"2010":[0,2],"2012":[0,2],"2013":0,"2014":[0,2],"2015":0,"2016":0,"2017":0,"2018":[0,1],"2019":[0,14],"2020":0,"2021":0,"20210111":[],"20210311":0,"257":18,"25msun":0,"281":18,"2969346":2,"2msun":0,"3000":0,"3msun":2,"42msun":0,"44msun":0,"45000000080":13,"4530":5,"463f148ec":[],"4e3":0,"500":0,"5479":[],"5542":0,"5msun":0,"625":0,"6944":0,"6msun":0,"7619":0,"763":2,"78125":0,"795":2,"80msol":2,"boolean":[0,4,6,8,12,18],"break":0,"case":[0,4],"catch":[4,5,8],"char":8,"class":[4,6],"const":[2,6,13,16],"default":[0,1,2,4,5,6,7,8,13,15],"export":[4,6,13,14],"float":[0,2,4,16,18],"function":[0,1,2,3,5,6,7,8,9,10,11,12,13,15,16,18],"import":[5,6,13,14],"int":[0,1,2,4,6,7,8,16,18],"long":[0,4,6,8,17],"new":[0,2,4,6],"null":[0,4],"paczy\u0144ski":0,"public":[7,10],"return":[0,1,2,4,6,7,8,12,15,16,18],"short":[0,17],"super":0,"switch":0,"throw":14,"true":[0,4,6,7,8,12,13],"try":[0,14],"while":0,And:[7,18],For:[0,12],Gas:0,Its:8,NOT:[0,6,15],Not:[8,13],One:0,Pms:12,That:[0,14],The:[0,1,2,4,5,6,8,12,13,15],Then:[4,14],There:[2,5,6,7,8,12],These:[4,8,12],Use:[0,5,6],Used:[0,8,12],Useful:[0,6,7],Uses:[0,16],Was:0,Will:[4,6,13,15],With:7,_binary_c_bind:[4,5,18],_binary_c_config_execut:8,_binary_c_dir:8,_binary_c_execut:8,_binary_c_shared_librari:8,_commandline_input:8,_count:8,_custom_logging_shared_library_fil:8,_end_time_evolut:8,_errors_exceed:8,_errors_found:8,_evolution_type_opt:8,_failed_count:8,_failed_prob:8,_failed_systems_error_cod:8,_generate_grid_cod:8,_grid_vari:8,_main_pid:8,_population_id:8,_probtot:8,_repeat:8,_set:[6,13],_start_time_evolut:8,_store_memaddr:8,_system_gener:8,_total_starcount:8,abat:0,abbrevi:17,abl:14,about:[4,6,7,13,14,18],abov:[0,4,5,6,14],abund:0,acc2:0,acceler:0,accept:[4,13],access:8,accord:0,accordingli:13,accret:0,accretion_end_tim:0,accretion_limit_dynamical_multipli:0,accretion_limit_eddington_lmms_multipli:0,accretion_limit_eddington_steady_multipli:0,accretion_limit_eddington_wd_to_remnant_multipli:0,accretion_limit_thermal_multipli:0,accretion_start_tim:0,accretor:[0,18],acess:2,act:[0,13],activ:0,actual:[0,4,6,12,14],adapt:0,add:[2,4,6,12,13,16],add_grid_vari:[6,13],added:4,admittingli:12,adress:[1,5,8,18],affect:0,after:[0,6],ag89:0,again:4,against:12,agb:0,agb_3dup_algorithm:0,agb_core_algorithm:0,agb_core_algorithm_default:0,agb_core_algorithm_hurlei:0,agb_core_algorithm_karaka:0,agb_luminosity_algorithm:0,agb_luminosity_algorithm_default:0,agb_luminosity_algorithm_hurlei:0,agb_luminosity_algorithm_karaka:0,agb_radius_algorithm:0,agb_radius_algorithm_default:0,agb_radius_algorithm_hurlei:0,agb_radius_algorithm_karaka:0,agb_third_dredge_up_algorithm_default:0,agb_third_dredge_up_algorithm_hurlei:0,agb_third_dredge_up_algorithm_karaka:0,agb_third_dredge_up_algorithm_stancliff:0,age:0,aging:0,algorithm:10,algothim:0,all:[0,1,2,4,5,6,7,8,11,12,13,15],all_info:6,allow:[0,5,8],allow_nan:4,along:[0,7,8],alot:[8,13],alpha:0,alpha_c:0,alphacb:0,alreadi:6,also:[0,4,5,6,7,14,18],alt:14,altern:0,alwai:0,amanda:0,amax:2,amin:2,amount:[0,6,7,8,13,16],amt_cor:[8,13],analys:15,andrew:14,andronov:0,angelou_lithium_cheb_decay_tim:0,angelou_lithium_cheb_massfrac:0,angelou_lithium_cheb_tim:0,angelou_lithium_decay_funct:0,angelou_lithium_decay_function_exponenti:0,angelou_lithium_decay_tim:0,angelou_lithium_eagb_decay_tim:0,angelou_lithium_eagb_massfrac:0,angelou_lithium_eagb_tim:0,angelou_lithium_gb_decay_tim:0,angelou_lithium_gb_massfrac:0,angelou_lithium_gb_tim:0,angelou_lithium_hg_decay_tim:0,angelou_lithium_hg_massfrac:0,angelou_lithium_hg_tim:0,angelou_lithium_lmms_decay_tim:0,angelou_lithium_lmms_massfrac:0,angelou_lithium_lmms_tim:0,angelou_lithium_ms_decay_tim:0,angelou_lithium_ms_massfrac:0,angelou_lithium_ms_tim:0,angelou_lithium_tpagb_decay_tim:0,angelou_lithium_tpagb_massfrac:0,angelou_lithium_tpagb_tim:0,angelou_lithium_vrot_trigg:0,angelou_lithium_vrotfrac_trigg:0,angmom_to_orbit_factor:0,angular:[0,12],angular_momentum_accretion_rate1:0,angular_momentum_accretion_rate2:0,angular_momentum_accretion_rate_orbit:0,ani:[0,2,4,6],anoth:0,ansi:0,anyth:[0,8],anywai:6,anywher:[6,14],api:[0,4],api_log_filename_prefix:0,append:[1,4],appli:0,approach:5,appropri:0,approxim:0,aren:2,arenou2010_binary_fract:2,arg:[2,4,12],arg_dict:4,argpair:4,argstr:5,argument:[0,2,4,5,6,8,13,15],argument_of_periastron:0,argument_of_periastron_quadrupl:0,argument_of_periastron_tripl:0,around:[0,5],arrai:[2,4,5],artifici:0,artificial_accretion_ignor:0,arxiv:[0,2],asarrai:5,asign:6,ask:[0,18],asplund:0,assum:[0,12],ast871:0,astronomi:0,astropi:12,atom:4,attempt:[4,6],auto:11,autogen_c_logging_cod:[1,5],autogener:[1,5],automat:[0,1,5,7,14],avaibl:14,avail:[0,4,8,12],awai:0,axi:[0,12],b_1:0,b_2:0,b_3:0,b_4:0,b_inclination1:0,b_inclination2:0,b_inclination3:0,b_inclination4:0,back:0,background:5,backward:0,bagb:0,barn:0,base:[0,2,4,5,6,12,14,18],base_filenam:[6,13],bashrc:14,basic:[5,6],batchmod:0,beasor:0,becaus:[0,5,6,14],becom:[0,1,2,4],been:[0,6],befor:[0,6,8,13,14],behaviour:[4,15],behind:5,being:4,belczynski:0,below:[0,13],berro:0,bertolami:0,best:[6,8],beta_reverse_nova:0,beta_reverse_novae_geometri:0,better:6,between:[0,2,16],bewar:6,bh_belczynski:0,bh_fryer12_delai:0,bh_fryer12_rapid:0,bh_hurley2002:0,bh_prescript:0,bh_spera2015:0,big:0,bin:[0,5,14],binari:[2,5,6,8,10,12,13,14,18],binary_c:[1,2,4,5,6,8,12,13,15],binary_c_cal:6,binary_c_default:13,binary_c_inline_config:1,binary_c_log_cod:[1,5],binary_c_macro:0,binary_c_output:4,binary_c_paramet:13,binary_c_python:4,binary_c_python_api:14,binary_c_task_:0,binary_c_write_log_cod:1,binary_grid:0,binary_star:18,binaryc:[1,4,14,15],binaryc_config:1,binaryc_json_seri:4,binarycdecod:4,binarycencod:4,binarycpython:[1,2,4,5,6,7,10,12,13,14,15,16,18],bind:0,birth:0,bivari:0,black:0,black_hol:0,bloecker:0,blog:1,boltzman:12,boltzmann:0,bondi:0,bondi_hoyle_accretion_factor:0,bool:[4,6,7,12],born:0,both:[0,4],bottom:0,bound:[2,16],boundari:2,brake:0,branch:[0,4],branch_david:0,breakup:0,broken:0,bse:[0,2],bse_opt:[6,13],buffer:0,build:[0,1,4,10],built:[0,1,4,14],burn:0,busso:0,bye:0,c13_eff:0,c_auto_log:[8,13],c_log:0,c_logging_cod:[8,13],calc_period_from_sep:18,calc_sep_from_period:[13,18],calcul:[0,2,6,8,18],calculate_constants_three_part_powerlaw:2,call:[0,1,4,6,8,12,13,15],can:[0,1,2,4,5,6,8,12,13,14,15],cannot:[6,14],cap:0,captur:0,carbon:0,carbon_oxygen_white_dwarf:0,carlo:0,carrasco:0,carri:0,cast:[4,5],categor:4,caught:4,caus:18,cbdisc:0,cbdisc_alpha:0,cbdisc_eccentricity_pumping_dermin:0,cbdisc_eccentricity_pumping_method:0,cbdisc_eccentricity_pumping_non:0,cbdisc_end_evolution_after_disc:0,cbdisc_fail_ring_inside_separ:0,cbdisc_gamma:0,cbdisc_init_djdm:0,cbdisc_init_dm:0,cbdisc_inner_edge_strip:0,cbdisc_inner_edge_stripping_timescal:0,cbdisc_kappa:0,cbdisc_mass_loss_constant_r:0,cbdisc_mass_loss_fuv_multipli:0,cbdisc_mass_loss_inner_l2_cross_multipli:0,cbdisc_mass_loss_inner_viscous_accretion_method:0,cbdisc_mass_loss_inner_viscous_accretion_method_equ:0,cbdisc_mass_loss_inner_viscous_accretion_method_gerosa_2015:0,cbdisc_mass_loss_inner_viscous_accretion_method_non:0,cbdisc_mass_loss_inner_viscous_accretion_method_young_clarke_2015:0,cbdisc_mass_loss_inner_viscous_angular_momentum_multipli:0,cbdisc_mass_loss_inner_viscous_multipli:0,cbdisc_mass_loss_ism_pressur:0,cbdisc_mass_loss_ism_ram_pressure_multipli:0,cbdisc_mass_loss_xray_multipli:0,cbdisc_max_lifetim:0,cbdisc_minimum_evaporation_timescal:0,cbdisc_minimum_fr:0,cbdisc_minimum_luminos:0,cbdisc_minimum_mass:0,cbdisc_no_wind_if_cbdisc:0,cbdisc_outer_edge_strip:0,cbdisc_outer_edge_stripping_timescal:0,cbdisc_resonance_damp:0,cbdisc_resonance_multipli:0,cbdisc_torquef:0,cbdisc_viscous_l2_coupl:0,cbdisc_viscous_photoevaporative_coupl:0,cbdisc_viscous_photoevaporative_coupling_inst:0,cbdisc_viscous_photoevaporative_coupling_non:0,cbdisc_viscous_photoevaporative_coupling_visc:0,cemp:0,cemp_cfe_minimum:0,certain:[3,8],cf_amanda_log:0,cflag:14,chabrier:2,chandrasekhar:0,chandrasekhar_mass:0,chang:[0,1,2,4,6,7,8,13],chapter:[0,3,8,11],cheb:0,check:[2,4,6,7,13,18],check_circular:4,chemic:0,chen:0,child:[4,14],choic:[0,6,12],choos:[0,5,12],chosen:6,circular:0,circumbinari:0,circumstanti:0,claei:0,clark:0,clean:[1,6,14],clean_up_custom_logging_fil:6,clear:4,cloud:0,cls:4,cluster:9,cmdline:6,code:[0,1,3,5,6,7,10,12,13,14,15],collaps:0,collapsar:0,collect:18,collid:18,color:12,color_by_index:12,colour:0,colour_log:0,column:[5,12,13],com:1,combin:[1,4,6,8],combine_ensemble_with_thread_join:8,come:[2,14,16],comenv_bs:0,comenv_disc_angmom_fract:0,comenv_disc_mass_fract:0,comenv_ejection_spin_method:0,comenv_ejection_spin_method_do_noth:0,comenv_ejection_spin_method_sychron:0,comenv_ejection_spin_method_synchron:0,comenv_merger_spin_method:0,comenv_merger_spin_method_breakup:0,comenv_merger_spin_method_conserve_angmom:0,comenv_merger_spin_method_conserve_omega:0,comenv_merger_spin_method_specif:0,comenv_ms_accret:0,comenv_ms_accretion_fract:0,comenv_ms_accretion_mass:0,comenv_nandez2016:0,comenv_nelemans_tout:0,comenv_ns_accret:0,comenv_ns_accretion_fract:0,comenv_ns_accretion_mass:0,comenv_post_eccentr:0,comenv_prescript:0,comenv_splitmass:0,comenv_undef:0,command:[0,1,6,8,14],commandlin:[6,8,13],commit:4,common:[0,13],companion:[0,13],compar:0,compil:[1,5,13,14],compile_shared_lib:1,complain:[13,14],complex:[5,6,8,12],compon:[4,12],comput:9,condit:[5,6,13],condor:[6,8,9],condor_grid:6,config:[1,8,14],config_fil:1,configur:[2,5,13],conserv:0,consid:[0,1,2,4,6,8,12],constant:[0,2,12],construct:[0,1,5],conta:7,contain:[0,1,2,3,4,6,7,8,9,11,12,13,15,16,17],content:[4,10],continu:6,control:0,convect:0,converg:0,convert:[2,4,6],cool:0,copi:[6,14,18],core:[0,6,8,12],core_helium_burn:0,core_mass:0,correct:[6,12,18],correctli:[5,12,13,14],correspond:12,corretor:0,cosmic:2,cosmic_sfh_madau_dickinson2014:2,could:[0,4],counter:8,coupl:0,coverag:14,cowd:0,cpu:0,crap_paramet:0,creat:[4,6,13],create_and_load_logging_funct:[1,5],create_arg_str:4,create_hdf5:[4,13],critic:0,cross:0,ctype:1,cuntz:0,current:[0,4],custom:[0,1,4,5,6,8,12,13,15],custom_log:[5,6,8],custom_logging_cod:[1,5,15],custom_logging_func_memaddr:[5,8],custom_logging_funct:[5,8,10,11,13],custom_logging_info:6,custom_opt:[6,13],cut:5,dai:[0,5,13,18],damp:0,dat:[0,4,13],data:[0,4,5,13,15],data_dir:[4,6,8,13],datadir:6,datafram:[5,12],date:6,david:[0,14],david_logging_funct:0,dd7:0,deactiv:0,deal:4,death:0,debug:8,decai:0,decid:[0,4,5],decod:4,decreas:0,deeper:6,def:[5,13],default_to_metal:0,defaultdict:4,defer:0,defin:[0,1,2,6,12],definit:[1,18],degener:0,degre:0,delta_mcmin:0,den:0,depend:[0,2,12],deprec:0,dermin:0,describ:[0,2,5,8,14],descript:[0,4,8,10,11],design:[6,12],desir:0,destruct:6,detail:[0,4],determin:[0,6,18],deton:0,dev:0,develop:1,deviat:2,dewi:0,dex:0,df2:5,diagnost:8,diagram:[0,12],dickonson:2,dict:[1,2,4,6,7,13,17],dict_1:4,dict_2:4,dictinari:8,dictionari:[1,2,4,6,7,8,12,17],did:[4,14],didnt:14,differ:[0,4,6,12,14],dimmer:0,dir:14,direct:[0,6],directli:5,director:8,directori:[0,4,6,8,13,14],disabl:0,disable_end_log:0,disable_ev:0,disc:0,disc_legacy_log:0,disc_log2d:0,disc_log:0,disc_log_directori:0,disc_log_dt:0,disc_log_level_non:0,disc_log_level_norm:0,disc_log_level_normal_first_disc_onli:0,disc_log_level_subtimestep:0,disc_log_level_subtimestep_first_disc_onli:0,disc_n_monte_carlo_guess:0,disc_stripping_timescale_infinit:0,disc_stripping_timescale_inst:0,disc_stripping_timescale_orbit:0,disc_stripping_timescale_visc:0,disc_timestep_factor:0,discs_circumbinary_from_comenv:0,discs_circumbinary_from_wind:0,disk:[0,6],dispers:0,displai:0,distribut:[0,2,9],distribution_funct:[10,11],distributoon:2,divid:9,dlnm1:[6,13],dlog10per:13,dlogp:2,doc:[4,7,14],doc_fetch:2,docstr:12,document:[4,7,8,11,14],doe:[0,2,6,14,18],doesn:6,doesnt:[5,7],doing:[0,1,6,7],don:8,done:[0,5,13,14],donm:13,donor:[0,18],donor_limit_dynamical_multipli:0,donor_limit_envelope_multipli:0,donor_limit_thermal_multipli:0,donor_rate_algorithm_bs:0,donor_rate_algorithm_claeys2014:0,dont:[2,4,5,6],dphasevol:[6,13],dr2:0,dr3:0,drai:0,dredg:0,dtfac:0,dtlimit:4,dtm:[1,13],dtype:5,due:14,dummi:[2,12],dump:[0,4],dumpvers:0,duquennoi:2,duquennoy1991:2,dure:0,dust:0,dwarf:0,dynam:0,e2_hurley_2002:0,e2_izzard:0,e2_prescript:0,each:[0,2,4,6,8],eagb:0,eagb_wind_beasor_etal_2020:0,eagb_wind_bs:0,eagb_wind_goldman_etal_2017:0,eagbwind:0,eagbwindfac:0,earli:0,early_asymptotic_giant_branch:0,easi:4,easier:[4,5],easili:14,ecc:[5,6],eccentr:[0,2,5,12,13,18],eccentric_rlof_model:0,eccentricity_quadrupl:0,eccentricity_tripl:0,echo:0,eddington:0,edg:0,edu:0,effect:[0,2],effective_metal:0,effici:0,egg:14,eggleton:[0,18],either:[0,4,5,6,15],eject:0,eld:0,eldridg:0,electon:0,electron:0,element:[0,1,4,8,12],email:4,emp:0,emp_logg_maximum:0,emp_minimum_ag:0,empti:[4,7],enabl:0,encod:4,encount:8,end:[0,4,8,13],energi:0,enhanc:0,enlarg:0,ensembl:[0,4,8],ensemble_def:0,ensemble_dt:0,ensemble_filter_:0,ensemble_filters_off:0,ensemble_json:4,ensemble_legacy_ensembl:0,ensemble_list:6,ensemble_logdt:0,ensemble_logtim:0,ensemble_output_:8,ensemble_result:8,ensemble_startlogtim:0,ensure_ascii:4,enter:0,enthalpi:0,entir:5,entri:4,entrypoint:6,env:12,envelop:0,environ:10,episod:0,equal:[4,13],equat:0,equation_of_state_algorithm:0,equation_of_state_paczynski:0,equatori:0,error:[4,8,14],esa:2,escap:0,escape_fract:0,escape_veloc:0,esnemble_macro:0,eta:0,etal:0,etc:[0,4,6,9,12,13,14,15],euler:0,evalu:[2,6,18],evan:0,evapor:0,event:0,everi:0,everyth:[6,8,13],evid:0,evolut:[0,1,5,6,8,12],evolution_split:0,evolution_splitting_maxdepth:0,evolution_splitting_sn_n:0,evolution_typ:8,evolutionari:0,evolv:[0,6,13],evolve_popul:[6,13],evolve_singl:[6,13],exact:[1,4,8],exactli:0,exampl:[1,2,4,6,10,14,15],example_head:4,example_header_1:5,example_header_2:5,example_log:15,example_log_co:1,example_parse_output:[4,5],example_pop:13,example_python_population_result:13,exce:[0,8],except:[4,6,7,12],excess:0,execut:[0,6,8,13,14],exist:[0,6,7,13,14],exist_ok:[4,13],exit:0,exp:[6,13],expand:15,experienc:14,experiment:[0,4,14],explain:4,explicilti:1,explod:0,explos:0,expoenti:0,expon:0,export_all_info:[6,13],express:0,extend:14,extern:0,extra:[0,6,8,15],extract:[4,13],extract_ensemble_json_from_str:4,f3401ead4:0,fabian:0,fabian_imf_log:0,fabian_imf_log_tim:0,fabian_imf_log_timestep:0,factor:[0,2,8],fail:[0,4,8,14],fail_sil:4,failed_system:8,failed_system_log:8,failed_systems_threshold:8,fals:[0,4,6,8,12,13],fancy_parsing_funct:15,faq:10,far:0,farmer:0,fase:13,fast:0,ferguson:0,field:0,fig:[0,2],figur:[8,12,14],file:[0,1,4,6,7,8,9,12,13,14],file_log:0,filenam:[0,1,4,5,6,8,13,15],filepath:[1,4],filesystem:4,filter:[0,4],filter_arg_dict:4,filter_valu:4,fin:0,find:[6,8],finish:[4,12],first:[0,2,4,6,18],first_giant_branch:0,fishlock:0,fit:[0,2,6,18],fix:[0,2,4,6,12],flag:[1,4,8],flash:0,flat:2,flatsect:[2,13],flaw:6,float64:5,flto:14,follow:[0,2,4,8,12,14],forc:0,force_circularization_on_rlof:0,force_corotation_of_primary_and_orbit:0,forloop:6,form:[0,4,6,7],formal:0,format:[0,2,4,5,6,13],formula:0,forward:0,found:[2,14],four:0,fpic:1,fraction:[0,2],frequenc:0,friction:0,fring:0,from:[0,2,4,5,6,8,12,13,14,18],from_binary_c_config:1,from_dict:5,ftz:14,full:[4,8,14],full_path:4,fulli:[6,13],func_memaddr:5,fuv:0,gaia:[0,2],gaia_colour_transform_method:0,gaia_conversion_ubvri_bivariate_jordi2010:0,gaia_conversion_ubvri_riello2020:0,gaia_conversion_ubvri_univariate_evans2018:0,gaia_conversion_ubvri_univariate_jordi2010:0,gaia_conversion_ugriz_bivariate_jordi2010:0,gaia_conversion_ugriz_riello2020:0,gaia_conversion_ugriz_univariate_evans2018:0,gaia_conversion_ugriz_univariate_jordi2010:0,gaia_l_binwidth:0,gaia_teff_binwidth:0,gain:8,galact:0,gallino:0,gamma:0,gap:0,garcia:0,gauss:0,gaussian:2,gaussian_func:2,gaussian_normalizing_const:2,gb_reimers_eta:0,gb_wind_beasor_etal_2020:0,gb_wind_goldman_etal_2017:0,gb_wind_reim:0,gb_wind_schroeder_cuntz_2005:0,gbwind:0,gbwindfac:0,gcc:[1,14],gce:0,gener:[0,1,2,4,5,6,7,8,12,13],geometr:0,gerosa:0,get:[0,4,5,6,7,8,13,14,15,18],get_arg_kei:4,get_default:4,get_help:[4,13],get_help_al:[4,6,13],get_help_sup:4,gettempdir:5,giant:0,giant_branch:0,git:[0,4],git_branch:4,git_build:4,give:[0,2,4,5,18],given:[0,1,2,4,5,6,15,18],globablli:2,global:[0,2],global_dict:2,gmax:2,gmin:2,goe:[0,6,12],gogo:0,going:14,goldman:0,gonna:2,good:[0,8,13,18],gravit:0,gravitational_radiation_bs:0,gravitational_radiation_bse_when_no_rlof:0,gravitational_radiation_landau_lifshitz:0,gravitational_radiation_landau_lifshitz_when_no_rlof:0,gravitational_radiation_model:0,gravitational_radiation_modulator_:0,gravitational_radiation_modulator_j:0,gravitational_radiation_non:0,grb:0,greater:0,grevess:0,grid:[0,4,6,10,11,13],grid_class:[10,11],grid_cod:6,grid_opt:[6,8,13],grid_options_default:7,grid_options_defaults_dict:7,grid_options_descript:7,grid_options_description_check:7,grid_options_help:7,grid_vari:[8,13],gridcod:6,gridcode_filenam:8,group:4,guess:[0,2],hachisu:0,hachisu_disk_wind:0,hachisu_ignore_qcrit:0,hachisu_qcrit:0,hack:7,had:6,half:0,handi:0,handl:[0,6,8,13,15,18],handle_ensemble_string_to_json:4,happen:[0,14],has:[0,1,4,5,6,8],have:[0,2,4,5,6,7,8,12,13,14],hbb:0,hbbtfac:0,hdf5:[4,13],hdf5file:4,header:[1,4,5,13],headerlin:13,headlin:8,hegb:0,hehg:0,height:[2,13],helium:0,helium_flash_mass_loss:0,helium_white_dwarf:0,help:[0,4,7,13],help_al:0,hem:0,henc:0,hendrik:14,here:[1,4,5,6,12,13],hertzsprung:0,hertzsprung_gap:0,hertzstrpung:0,heuvel:0,hewd:0,hex:8,high:[0,2],higher:[0,4,8],his:2,histori:2,hole:0,hopefulli:0,hot:0,how:[0,4,5,6,8],howev:0,hoyl:0,hpc:[6,9],hpc_function:[10,11],hr_diagram:12,hrd:0,hrdiag:0,hrdiag_output:0,html:14,http:[0,1,2,14],hurlei:0,hybrid:0,hydro:0,hydrogen:0,ibc:0,idea:12,idum:0,ignit:0,ignor:[0,5],iia:0,imag:14,imf:[0,2],imf_chabrier2003:2,imf_scalo1986:2,imf_scalo1998:2,imf_tinsley1980:2,immedi:0,implement:[0,6,8],impli:0,impos:13,inclin:0,inclination1:0,inclination2:0,inclination3:0,inclination4:0,inclini:0,incliniation_quadrupl:0,incliniation_tripl:0,includ:[0,1,4,5,6,12,14],include_binary_c_default:[6,13],include_binary_c_help_al:[6,13],include_binary_c_version_info:[6,13],include_default:6,include_popul:13,include_population_set:6,increas:0,inde:0,indent:4,index:[0,2,10],indic:0,individual_nova:0,induc:0,inertia:0,info:[4,6,12,13,14],inform:[0,1,4,6,7,12,13],init:6,init_abund:0,init_abund_dex:0,init_abund_mult:0,init_abunds_onli:0,initi:[0,2,6],initial_abundance_hash:6,initial_abundance_mix:0,initial_abunds_onli:0,inlin:5,inner:0,input:[1,2,4,6,8,10,12,18],input_dict:4,insert:6,inspect:[4,12,13],inspect_dict:4,inspir:[1,5,12,18],instabl:0,instal:14,instanc:[4,13],instant:0,instantli:0,instead:[0,4,8,14],instruct:10,integ:[0,6,8,18],interact:[0,7],interfac:4,interfer:14,intern:[0,8],internal_buff:0,internal_buffering_off:0,internal_buffering_print:0,internal_buffering_stor:0,interpol:2,interpolate_in_mass_izzard2012:2,intershel:0,interstellar:0,intro:0,invers:18,involv:0,inward:0,isn:[4,6],isnt:13,isotop:[0,4],isotope_hash:6,isotope_list:6,issu:14,item:1,iter:4,its:[0,4,7,12,14,15],itself:[4,8,14],iwamoto:0,izzard2012_period_distribut:2,izzard:[0,14],jager:0,jan:[],jaschek:2,jeff:14,jia:0,john:0,join:13,jordi:0,json:[4,6,8,13],jsondecod:4,jsonencod:4,jupyt:14,just:[0,2,4,5,6,8,18],kappa:0,karaka:0,keep:6,kei:[1,2,4,6,7,8,12],kelvin:0,keplerian:0,keypair:4,keyword:[12,15],kick:[0,8],kick_backward:0,kick_forward:0,kick_inward:0,kick_outward:0,kick_random:0,kick_straight_up:0,kick_velocity_custom:0,kick_velocity_fix:0,kick_velocity_maxwellian:0,kill:[1,13],kim:0,kind:0,know:[0,1,6,7],known:[0,6,13,15],kroupa2001:[2,6],kroupa:2,ktg93:2,kwarg:[6,12,15],lambda:0,lambda_c:0,lambda_ce_dewi_tauri:0,lambda_ce_polytrop:0,lambda_ce_wang_2016:0,lambda_enthalpi:0,lambda_ionis:0,lambda_min:0,lambda_mult:0,lambda_multipli:0,lamer:0,landau:0,langer:0,larger:0,late:5,latter:0,law:2,ld_library_path:14,lead:0,leav:0,left:0,legaci:0,legacy_yield:0,len:13,lengthen:0,less:[0,1,2],let:6,level:[1,4],li7:0,lib:5,libbinary_c:[8,14],libgsl:14,libmemo:14,librari:[1,5,6,8,14,15],library_path:14,librinterpol:14,lies:0,lifetim:0,lifshitz:0,like:[0,1,4,5,6,8,12,14,16],limit:[0,12],line:[1,4,5,6,8,12,14],linear:[0,8],linearli:[6,16],linker:1,linspac:16,list:[0,1,2,4,8,14,15,16],list_arg:0,list_of_sub_kei:2,lit:0,lithium:0,lithium_gb_post_1dup:0,lithium_gb_post_heflash:0,lithium_hbb_multipli:0,lithium_t:0,littleton:0,liu:0,lnm1:[6,13],load:[0,1,4,5,6,12,13],load_logfil:4,lobe:[0,18],local:2,locat:[0,2,8,14],lodder:0,log10:[0,2,13],log10p:2,log10per:13,log10pmin:2,log:[0,1,2,5,6,8,12,13,14,15,18],log_arg:8,log_args_dir:8,log_fil:8,log_filenam:[0,5,15],log_runtime_system:8,logarithm:2,logensembletim:0,logfil:[4,14,15],logg:0,logging_dict:1,logging_lin:5,logic:[1,6,8],logp:2,logper:2,long_spectral_typ:2,longer:0,longnam:[6,13],look:[1,4],lookback:0,loon:0,loop:6,loos:12,lose:0,loss:0,lost:0,lot:[4,15],low:[0,2,13],low_mass_m:0,low_mass_main_sequ:0,lower:[0,2,16],lsun:12,lugaro:0,luminos:[0,12],luminosity_1:12,luminosity_2:12,lynnett:0,m_1:[0,5,6,13,15],m_2:[0,5,13],m_3:0,m_4:0,m_max:[2,6],m_min:6,m_re:5,maccretor:0,machin:[8,14],macro:[0,4],madau:2,maeder:0,magellan:0,magnet:0,magnetic_braking_algorithm:0,magnetic_braking_algorithm_andronov_2003:0,magnetic_braking_algorithm_barnes_2010:0,magnetic_braking_algorithm_hurley_2002:0,magnetic_braking_algorithm_rappaport_1983:0,magnetic_braking_factor:0,magnetic_braking_gamma:0,mai:0,main:[0,1,8],main_sequ:0,mainli:9,major:0,make:[0,1,2,4,5,6,8,12,13,14,15],make_build_text:4,makedir:[4,13],manag:14,mani:[0,6,8],manual:14,manual_vrot:0,manufactur:0,mar:0,marchant:0,maria:0,mass:[0,1,2,4,5,6,8,12,13,15,18],mass_1:[5,12],mass_2:[5,12],mass_accretion_for_eld:0,mass_accretion_rate1:0,mass_accretion_rate2:0,mass_accretor:18,mass_donor:18,mass_evolut:12,mass_for_hestar_ia_low:0,mass_for_hestar_ia_upp:0,mass_of_pmz:0,massiv:[0,2],massless_remn:0,master:[8,12],match:[0,4,12],materi:0,math:[6,13],matplotlib:12,matter:[0,14],mattsson:0,mattsson_mass_loss:0,mattsson_orich_tpagbwind:0,max:[0,2,13],max_bound:[2,16],max_evolution_tim:[0,1,5,13],max_hewd_mass:0,max_model_numb:0,max_neutron_star_mass:0,max_stellar_angmom_chang:0,max_val:2,maximum:[0,2,8],maximum_mass_ratio_for_instant_rlof:0,maximum_mcbagb_for_degenerate_carbon_ignit:0,maximum_nuclear_burning_timestep:0,maximum_timestep:0,maximum_timestep_factor:0,maxmimum:0,maxwellian:0,mayb:12,mayor:2,mc13_pocket_multipli:0,mch:0,mcmin:0,mdonor:0,mean:[0,2,4,6,14],meant:8,medium:0,megaparsec:2,memaddr:5,memori:[1,5,6,8,18],menv:0,merg:[0,4,8],merge_dict:4,merger:0,merger_angular_momentum_factor:0,mesa:14,mesasdk_init:14,mesasdk_root:14,messag:4,mestel:0,met:6,metal:[0,2,5,18],method:[0,5,6],meynet:0,might:[6,14],milki:0,miller:0,min:[2,13],min_bound:[2,16],min_val:2,mind:5,minimal_verbos:4,minimum:[0,2,4,18],minimum_co_core_mass_for_carbon_ignit:0,minimum_co_core_mass_for_neon_ignit:0,minimum_donor_menv_for_comenv:0,minimum_envelope_mass_for_third_dredgeup:0,minimum_helium_ignition_core_mass:0,minimum_mcbagb_for_nondegenerate_carbon_ignit:0,minimum_orbital_period_for_instant_rlof:0,minimum_period_for_rlof:18,minimum_separation_for_instant_rlof:0,minimum_separation_for_rlof:18,minimum_timestep:0,mint:0,mint_dir:0,mint_ms_rejuven:0,mira:0,misc:10,miscellan:4,miss:[4,7],mix:0,mixtur:0,mmax:2,mnra:18,model:[0,1,5,13],modifi:0,modul:[0,7,10,11],modulo:8,moment:[0,13,16],momenta:[0,12],momentum:0,mont:0,monte_carlo_kick:0,montecarlo:8,more:[0,1,4,5,6,8,12,14,16],most:[4,14],mostli:[4,5,7,8,12,13,15],msun:[0,5],much:4,mulitpli:8,mulitprocess:8,multipl:[0,2],multiplc:0,multipli:0,multiprocess:[6,8],multithread:8,must:[0,2],my_header_lin:13,my_sss2:5,my_stellar_data:[1,5,13],myr:[0,5],n100:0,n100_z0:0,n100h:0,n100l:0,n10:0,n150:0,n1600:0,n1600c:0,n200:0,n20:0,n300c:0,n40:0,naked_helium_star_giant_branch:0,naked_helium_star_hertzsprung_gap:0,naked_main_sequence_helium_star:0,name:[1,4,5,6,7,13,14,15,17],natur:0,nauenberg:0,nearer:0,necessari:[4,5,6,13,14],need:[0,5,6,13,14],neg:0,neither:[0,6],neleman:0,nelemans_gamma:0,nelemans_max_frac_j_chang:0,nelemans_minq:0,nelemans_n_comenv:0,nelemans_recalc_eccentr:0,nenamg:0,neon:0,nest:[4,6],network:0,neutrn:0,neutron:[0,13],neutron_star:0,never:0,newer:[0,2],newli:0,newopt:2,newton:0,next:4,nice:[1,6,12,13],nieuwenhuijzen:0,nieuwenhuijzen_windfac:0,no_thermohaline_mix:0,noecho:0,noechonow:0,noel:0,nomin:0,non:0,nonconservative_angmom_gamma:0,none:[0,1,2,4,5,6,7],nor:0,normal:[0,2],normalis:2,note:[0,5,10],notebook:14,notifi:15,nova:0,nova_faml_multipli:0,nova_irradiation_multipli:0,nova_retention_algorithm_claeys2014:0,nova_retention_algorithm_const:0,nova_retention_algorithm_hillman2015:0,nova_retention_fract:0,nova_retention_method:0,nova_timestep_accelerator_index:0,nova_timestep_accelerator_max:0,nova_timestep_accelerator_num:0,now:[0,2,4,5],nuclear:0,nuclear_mass_hash:6,nuclear_mass_list:6,nucleosynthesi:[0,4],nucleosynthesis_sourc:4,nucreacmult:0,nucsyn:10,nucsyn_angelou_lithium:0,nucsyn_gce_outflow_check:0,nucsyn_hbb:0,nucsyn_init_abund_mix_ag89:0,nucsyn_init_abund_mix_asplund2005:0,nucsyn_init_abund_mix_asplund2009:0,nucsyn_init_abund_mix_garciaberro:0,nucsyn_init_abund_mix_grevesse_noels_1993:0,nucsyn_init_abund_mix_karakas2002:0,nucsyn_init_abund_mix_kobayashi2011_asplund2009:0,nucsyn_init_abund_mix_lodders2003:0,nucsyn_init_abund_mix_lodders2010:0,nucsyn_metal:0,nucsyn_s_process:0,nucsyn_third_dredge_up:0,nugi:0,number:[0,2,4,5,6],numpi:[4,5,16],obj:4,object:[0,4,6,8,9,12,13],object_hook:4,object_pairs_hook:4,obtain:0,occur:[0,18],ofcours:12,off:[0,5,13],offset:0,ohio:0,old_solut:14,omega:0,onc:0,one:[0,4,5,6,12,14],onewd:0,onli:[0,4,5,6,8,18],onset:0,onto:0,opac:0,opacity_algorithm:0,opacity_algorithm_ferguson_op:0,opacity_algorithm_paczynski:0,opacity_algorithm_star:0,opal:0,open:13,opm:2,opt:[2,4],option:[1,2,4,5,6,10,11,13,14,18],orb:6,orbit:[0,2,12,13,18],orbit_evolut:12,orbital_inclin:0,orbital_inclinationi:0,orbital_period:[0,5,13,18],orbital_period_quadrupl:0,orbital_period_tripl:0,orbital_phas:0,orbital_phase_quadrupl:0,orbital_phase_tripl:0,order:[4,5,6],org:[0,2],origin:14,other:[0,1,2,4,7,8,12,13],otherwis:[6,7,8],out:[4,7,8,14],outcom:0,outer:0,outfil:[6,13],outfile_nam:1,outfilenam:13,output:[1,4,5,6,8,10,12,13,14,15,18],output_dir:6,output_fil:[4,7],output_filenam:6,output_lin:[4,13],outsid:0,outward:0,over:[4,6,13],overflow:0,overrid:[2,5],overriden:13,overshoot:0,overspin_algorithm:0,overspin_bs:0,overspin_massloss:0,own:[5,6,8,14],oxygen:0,oxygen_neon_white_dwarf:0,pack:13,packag:[4,14,16],paczynski:0,page:[0,10],pair:[0,4],panda:[4,5,12],pane:12,panel:0,paper:0,param:12,param_nam:4,paramet:[1,2,4,6,7,8,10,12,13,14,15,16,18],parameter_nam:[4,6,13],parameter_value_input_typ:4,pars:[4,5,6,12,13,15],parse_binary_c_version_info:4,parse_cmdlin:6,parse_const:4,parse_float:4,parse_funct:[6,8,13,15],parse_function_hr_diagram:12,parse_function_mass:12,parse_function_orbit:12,parse_int:4,parse_output:5,part:[2,5,6,18],partial:0,particularli:0,pasp:2,pass:[5,8,12,14,15],path:[4,8,13,14],pdf:[0,2],pend:0,per:[0,4,6,8,13,18],peret:0,perform:0,perhap:0,periastron:0,pericent:18,period:[0,2,5,12,13,18],perl:1,person:14,pgo:0,phase:0,phasevol:0,photoevapor:0,php:2,physic:13,pick:12,piec:[5,6],pinnsonneault:0,pip:14,pisn:0,pkg:14,place:8,placehold:12,plai:0,plan:8,pleas:[0,4],plot:[5,12],plot_funct:[10,11],plot_hr_diagram:12,plot_hr_diagram_singl:12,plot_mass:12,plot_orbit:12,plot_system:12,plot_typ:12,pls:6,plu:0,pms:12,pms_mass_1:12,pms_mass_2:12,pogg:0,point:[0,2,4,14],pol:0,polytrop:0,popuation_id:8,popul:[0,2,6,7,9,10,16],population_set:6,posit:[0,2],possibl:[0,1,2,4,7,14],post:0,post_sn_orbit_bs:0,post_sn_orbit_method:0,post_sn_orbit_tt98:0,postagb_legacy_log:0,potenti:0,power:[0,2],powerlaw:2,powerlaw_const:2,ppisn:0,ppisn_dis:0,ppisn_farmer19:0,ppisn_prescript:0,pre:[0,12],pre_main_sequ:0,pre_main_sequence_fit_lob:0,precis:4,precod:[6,13],predefin:2,predictor:0,prefer:[0,6],prefix:0,preload:12,prepar:2,prepare_dict:2,prescript:0,present:[2,4,6,13],preserv:0,preset:12,pressur:0,prevent:0,previou:4,previous_stardata:1,primari:[1,2,6,13,18],print:[4,5,7,8,13,14],print_help:4,print_info:7,print_structur:4,printf:[1,5,13],prior:0,privat:[6,7,10],probabl:[0,1,2,6,7,8,13,14],probdist:[6,13],problabl:12,process:[0,4,5,6,8],progenitor:0,program:14,project:0,proper:7,properli:0,properti:[0,4,8,12],provid:[0,2,6,8,13,15],pseudorandom:0,puls:[0,18],pulsat:0,pump:0,purpos:[8,12],put:[1,4,5,8,12,13,14],pyenv:14,python3:[5,14],python:[4,5],python_api_test:14,pythonpath:14,qcrit_bh:0,qcrit_cheb:0,qcrit_cowd:0,qcrit_degenerate_bh:0,qcrit_degenerate_cheb:0,qcrit_degenerate_cowd:0,qcrit_degenerate_eagb:0,qcrit_degenerate_gb:0,qcrit_degenerate_hegb:0,qcrit_degenerate_hehg:0,qcrit_degenerate_hem:0,qcrit_degenerate_hewd:0,qcrit_degenerate_hg:0,qcrit_degenerate_lmm:0,qcrit_degenerate_m:0,qcrit_degenerate_n:0,qcrit_degenerate_onewd:0,qcrit_degenerate_tpagb:0,qcrit_eagb:0,qcrit_gb:0,qcrit_gb_bs:0,qcrit_gb_chen_han_formula:0,qcrit_gb_chen_han_t:0,qcrit_gb_ge2015:0,qcrit_gb_hjellming_webbink:0,qcrit_gb_q_no_comenv:0,qcrit_gb_vos2018:0,qcrit_hegb:0,qcrit_hehg:0,qcrit_hem:0,qcrit_hewd:0,qcrit_hg:0,qcrit_lmm:0,qcrit_m:0,qcrit_n:0,qcrit_onewd:0,qcrit_tpagb:0,qcrits_:0,qcrits_degenerate_:0,quadrat:0,quadrulpl:0,quadrupl:0,quantiti:12,quit:[0,4],r_l:18,radi:0,radiat:0,radii:[0,18],radiu:[0,1,12,13,18],radius_1:12,radius_2:12,ragb:18,raghavan2010_binary_fract:2,raghavan:2,rai:0,railton:0,rais:[0,4,8,13],ram:0,random:[0,8],random_se:0,random_skip:0,random_system:0,random_systems_se:0,rang:[0,2,6,16],rapidli:0,rappaport:0,rate:[0,2],rather:[0,4,6,8],ratio:[0,2,13,18],raw:[4,5,6,12,15],raw_output:4,reaction:0,read:[4,14],real:6,realli:[0,6,7,8],reason:0,rebuild:14,recalcul:0,reciev:4,recombin:0,recommend:[1,6,14],recurs:[4,6],red:0,redhat:1,redshift:2,reduc:0,reduct:8,regardless:12,region:0,reimer:0,reject:0,rejuven:0,rel:0,relat:0,remain:0,remnant:0,remov:[0,4,6],remove_fil:4,repeat:[0,8],repo:14,report:0,represent:[4,6],reproduc:0,requir:[0,4,5,10,12,13,15],reset:0,reset_pref:0,reset_star:0,reset_stars_default:0,resolut:[0,6,13],resolv:[0,14],reson:0,respect:[0,2],rest:6,restructuredtext:4,result:[0,1,2,4,5,6,8,13,14],result_example_head:5,result_example_header_1:5,result_example_header_2:5,retain:0,rethink:4,return_all_info:6,return_binary_c_version_info:[4,6],return_compilation_dict:1,return_help_al:4,return_minimum_orbit_for_rlof:18,return_population_set:6,return_version_info:4,revap_in:0,revap_out:0,revers:[0,12],reverse_tim:0,revis:[0,4],rewrit:6,ri0005:14,rich:0,riello:0,rin:0,ring:0,risk:6,ritter:0,rk2:0,rk4:0,rlof:[0,18],rlof_angular_momentum_transfer_model:0,rlof_angular_momentum_transfer_model_bs:0,rlof_angular_momentum_transfer_model_conserv:0,rlof_eccentric_as_circular:0,rlof_entry_threshold:0,rlof_f:0,rlof_interpolation_binary_c:0,rlof_interpolation_bs:0,rlof_interpolation_method:0,rlof_mdot_factor:0,rlof_mdot_modul:0,rlof_method:0,rlof_method_adapt:0,rlof_method_adaptive2:0,rlof_method_bs:0,rlof_method_claei:0,rlof_method_ritt:0,rlof_nonconservative_gamma_donor:0,rlof_nonconservative_gamma_isotrop:0,rlof_radiation_correct:0,rob:[0,2,18],robert:14,roch:[0,18],roche_lob:18,rochelob:18,room:6,root:14,rotat:[0,2],rotation:0,rotationally_enhanced_expon:0,rotationally_enhanced_mass_loss:0,rotationally_enhanced_massloss:0,rotationally_enhnaced_massloss_angmom:0,rotationally_enhnaced_massloss_langer_formula:0,rotationally_enhnaced_massloss_langer_formula_and_angmom:0,rotationally_enhnaced_massloss_non:0,rout:0,routin:[0,5,6,12],row:12,rring:0,rssd:2,rst:[4,7],rsun:12,run:[0,1,4,5,6,8,13,14,15],run_example_binari:5,run_example_binary_with_custom_log:5,run_example_binary_with_run_system:5,run_example_binary_with_writing_logfil:5,run_example_custom_logging_autogener:5,run_system:[5,12,15],run_system_wrapp:[5,10,11],runtim:[1,8],russel:0,rzam:18,sai:0,said:0,same:[0,4,5,13,14],sampl:[0,2,6,16],sana12:[2,13],sana:2,save:[1,2,13],scalo:2,scanf:0,scene:5,scheme:0,schneider:0,schroeder:0,script:[3,5],sdb:0,sdo:0,search:10,second:[0,2,4,12],secondari:[2,18],section:[2,4,9,10],see:[0,5,6,12,14],seed:0,seem:12,segment:16,seitenzahl2013_model:0,seitenzahl:0,select:[0,4,5],selected_head:[4,5],self:[6,8,13],semi:0,sent:0,sentenc:1,sep:[2,5,6,13,18],sep_max:13,sep_min:13,separ:[0,2,4,5,12,13,18],separation_quadrupl:0,separation_tripl:0,separta:0,seper:[6,7,13],sequenc:0,seri:0,serial:4,serializ:6,serv:[4,5,13],server:6,set:[0,1,2,4,6,7,8,12,13,14],set_opt:2,settingsfil:4,setup:15,sever:[5,7,8,12,15],sfh:2,shara:0,share:[1,5,8,14,15],shared_lib_filenam:5,shim:14,should:[0,1,5,7,8,12,13,14,15],shouldn:[0,4],show:[3,8,12],show_plot:12,show_stellar_typ:12,shown:12,siess:0,sigma:2,silent:4,sill:0,simpl:13,simpli:0,simul:[0,1,8,13],simulation_:6,sinc:[4,12,13],singl:[0,2,6,12,13],skip:0,skipkei:4,sliced_df:5,slope:2,slow:0,slurm:[6,8,9],slurm_grid:6,small:0,small_envelope_method:0,small_envelope_method_bs:0,small_envelope_method_miller_bertolami:0,smaller:0,sn_impulse_liu2015:0,sn_impulse_non:0,sn_impulse_wheeler1975:0,sn_kick_companion_a:0,sn_kick_companion_aic_bh:0,sn_kick_companion_bh_bh:0,sn_kick_companion_bh_n:0,sn_kick_companion_ecap:0,sn_kick_companion_grb_collapsar:0,sn_kick_companion_hestaria:0,sn_kick_companion_ia_chand:0,sn_kick_companion_ia_chand_co:0,sn_kick_companion_ia_eld:0,sn_kick_companion_ia_h:0,sn_kick_companion_ia_he_co:0,sn_kick_companion_ia_hybrid_hecowd:0,sn_kick_companion_ia_hybrid_hecowd_sublumin:0,sn_kick_companion_ibc:0,sn_kick_companion_ii:0,sn_kick_companion_iia:0,sn_kick_companion_ns_n:0,sn_kick_companion_tz:0,sn_kick_companion_wdkick:0,sn_kick_dispersion_aic_bh:0,sn_kick_dispersion_bh_bh:0,sn_kick_dispersion_bh_n:0,sn_kick_dispersion_ecap:0,sn_kick_dispersion_grb_collapsar:0,sn_kick_dispersion_ia_hybrid_hecowd:0,sn_kick_dispersion_ia_hybrid_hecowd_sublumin:0,sn_kick_dispersion_ibc:0,sn_kick_dispersion_ii:0,sn_kick_dispersion_ns_n:0,sn_kick_dispersion_tz:0,sn_kick_distribution_aic_bh:0,sn_kick_distribution_bh_bh:0,sn_kick_distribution_bh_n:0,sn_kick_distribution_ecap:0,sn_kick_distribution_grb_collapsar:0,sn_kick_distribution_ia_hybrid_hecowd:0,sn_kick_distribution_ia_hybrid_hecowd_sublumin:0,sn_kick_distribution_ibc:0,sn_kick_distribution_ii:0,sn_kick_distribution_ns_n:0,sn_kick_distribution_tz:0,sneia:0,snia:0,solar:[0,18],solarmass:2,solver:0,solver_forward_eul:0,solver_predictor_corrector:0,solver_rk2:0,solver_rk4:0,some:[0,1,2,5,6,8,12,13,14],someth:[0,6],soon:16,sort:4,sort_kei:4,sourc:[1,2,3,4,5,6,7,8,11,12,13,14,15,16,18],source_file_filenam:8,source_list:6,sourcefile_nam:1,space:[0,6,16],spacing_funct:[10,11],spacingfunc:[6,13],spacingfunct:6,special:0,specif:[0,4,12],specifi:[0,8],spectral:2,speed:[0,8],speedtest:0,spheric:0,spin:0,split:[0,8,13],splitpoint:0,spread:6,src:14,st1:5,st2:5,stabil:0,stabl:0,stancliff:0,standard:[0,2],star:[1,2,5,6,8,10,12,13,18],stardata:[0,1,5,13],stardata_dump_filenam:0,stardata_load_filenam:0,start:[0,1,4,5,7,8],start_tim:0,state:0,statement:[1,5],statist:0,statu:[0,1],steadi:0,stefan:12,stellar:[0,12,17],stellar_structure_algorithm:0,stellar_structure_algorithm_external_funct:0,stellar_structure_algorithm_mint:0,stellar_structure_algorithm_modified_bs:0,stellar_structure_algorithm_non:0,stellar_typ:[1,10,11,12,13],stellar_type_1:[0,12],stellar_type_2:[0,12],stellar_type_3:0,stellar_type_4:0,stellar_type_dict:17,stellar_type_dict_short:17,step:[12,16],still:[1,8],stop:0,storag:0,store:[0,2,6,8,18],store_memaddr:18,str:[1,4,6,7,12],straight:6,straniero:0,strength:0,strict:4,string:[0,1,4,6,7,8,12,15],strip:0,stronger:0,struct:0,structur:[0,4,8,12],stuff:[2,4,8,12,13],style:0,sub:0,subdirectori:4,subject:0,sublumin:0,subroutin:9,subsequ:0,succe:0,suggest:[0,14],sum:0,supercrit:0,supernova:[0,8],superwind:0,superwind_mira_switchon:0,supress:13,sure:[2,6,8,12,14,15],surfac:0,surrei:14,surviv:0,survivor:0,svg:14,symmetr:0,synchron:0,synonym:0,sys:5,system:[0,5,6,8,12,13,14,15],system_gener:6,t_re:5,tabl:[0,2],take:[0,2,4,5,6,8,13,15],taken:0,target:[1,7,14],task:[0,2,4,5,6,7,9,12,15,16,18],tauri:0,tbse:0,teff:2,teff_1:12,teff_2:12,temp_dir:[4,13],temperatur:[0,2,12],tempfil:5,termin:1,test:[0,4,6,14],test_log:5,test_pop:13,text:[4,7,14],than:[0,2,4,8],thats:[0,13],thei:[0,2,6,12],thelog:0,them:[4,5,6,13],themselv:[2,4],theres:6,thermal:[0,2,18],thermally_pulsing_asymptotic_giant_branch:0,thermohalin:0,thesi:0,thi:[0,1,2,3,4,5,6,7,8,11,12,13,14,15,16,18],thick:0,thick_disc_end_ag:0,thick_disc_logg_max:0,thick_disc_logg_min:0,thick_disc_start_ag:0,thin:0,thing:[2,4,5,6,7,13,15],think:[0,4,6],third:[0,2],third_dup:0,third_dup_multipli:0,thorn:0,those:[4,5,6,13,14],thread:8,thread_id:8,three:[0,2],three_part_powerlaw:[2,13],threshold:[4,8],through:[6,12,15],throughout:6,tidal:0,tidal_strength_factor:0,tide:0,time:[0,1,2,4,5,6,8,12,13],timescal:0,timestamp:8,timestep:0,timestep_limit:0,timestep_log:0,timestep_modul:0,timestep_multipli:0,timestep_solver_factor:0,tinslei:2,tmp:[0,4,14],tmp_dir:[6,8],todo:[0,1,2,4,6,7,8,12,13,15,16,18],toler:0,too:[0,15],topic:0,torqu:0,total:[0,6,8,12],tout:[0,18],tpagb:0,tpagb_reimers_eta:0,tpagb_wind_beasor_etal_2020:0,tpagb_wind_bloeck:0,tpagb_wind_goldman_etal_2017:0,tpagb_wind_mattsson:0,tpagb_wind_reim:0,tpagb_wind_rob_cwind:0,tpagb_wind_van_loon:0,tpagb_wind_vw93_karaka:0,tpagb_wind_vw93_karakas_carbon_star:0,tpagb_wind_vw93_orig:0,tpagb_wind_vw93_orig_carbon_star:0,tpagbwind:0,tpagbwindfac:0,track:[8,12],trade:0,transfer:0,transform:[0,4],treat:0,trigger:0,tripl:0,tru:4,truli:0,tupl:1,turn:[0,4,13],two:[0,4,17,18],txt:[5,6,14,15],type:[0,1,2,4,6,7,8,12,16,17,18],type_ia_mch_supernova_algorithm:0,type_ia_mch_supernova_algorithm_dd2:0,type_ia_mch_supernova_algorithm_seitenzahl2013:0,type_ia_mch_supernova_algorithm_seitenzahl2013_automat:0,type_ia_sub_mch_supernova_algorithm:0,type_ia_sub_mch_supernova_algorithm_livne_arnett_1995:0,typic:0,ubvri:0,ugriv:0,uncom:6,under:16,undergo:0,underli:14,understand:6,undescrib:7,uniform:2,union:[2,4,16,18],uniqu:8,unit:[0,18],univari:0,unknown:15,unless:[1,6,8],unload:6,unrecogn:14,unsign:0,until:[0,2],unus:[0,8],updat:[2,6,13,14],upper:[0,2,16],usag:[0,10],use:[0,2,4,5,6,8,9,12,13,14,15],use_astropy_valu:12,use_datadir:[6,13],use_fixed_timestep_:0,use_periastron_roche_radiu:0,use_tabular_intershell_abundances_karakas_2012:0,used:[0,1,2,4,6,8,12,13],useful:[0,4,6,8,14,15,18],useful_func:[10,11],user:[1,2,4,6,7,8,15],uses:[0,5,13],using:[0,1,3,5,6,13,14],usr:5,usual:[0,2,8,14],util:[1,2,4,5,6,7,12,13,15,16,18],val:2,valid:[0,2,4],valu:[0,1,2,4,5,6,7,8,12,13,14],valueerror:13,valuerang:[6,13],van:0,vandenheuvel_log:0,vari:0,variabl:[0,4,6,8,10,13],variant:0,variou:0,vassiliadi:0,veloc:[0,2],verbos:[1,4,8,13,14],verbose_print:4,veri:[0,5,6,13,16],versa:18,version:[0,4,6,14],version_info:4,version_info_str:4,version_onli:0,via:[6,8,12,13],vice:18,vink:0,virtual:14,viscos:0,viscou:0,volum:0,vrot1:0,vrot2:0,vrot3:0,vrot4:0,vrot_breakup:0,vrot_bs:0,vrot_non_rot:0,vrot_sync:0,vw93:0,vw93_eagb_wind_spe:0,vw93_mira_shift:0,vw93_multipli:0,vw93_tpagb_wind_spe:0,vwind_multipli:0,wai:[0,3,4,6,8,12,13,14],wang:0,want:[0,2,4,5,7,8,12,13,14],warmup_cpu:0,warn:[0,6,14],wave:0,wd_accretion_rate_new_giant_envelope_lower_limit_helium_donor:0,wd_accretion_rate_new_giant_envelope_lower_limit_hydrogen_donor:0,wd_accretion_rate_new_giant_envelope_lower_limit_other_donor:0,wd_accretion_rate_novae_upper_limit_helium_donor:0,wd_accretion_rate_novae_upper_limit_hydrogen_donor:0,wd_accretion_rate_novae_upper_limit_other_donor:0,wd_kick:0,wd_kick_at_every_puls:0,wd_kick_at_given_puls:0,wd_kick_direct:0,wd_kick_end_agb:0,wd_kick_first_rlof:0,wd_kick_pulse_numb:0,wd_kick_when:0,wd_sigma:0,wdwd_merger_algorithm:0,wdwd_merger_algorithm_bs:0,wdwd_merger_algorithm_chen2016:0,wdwd_merger_algorithm_perets2019:0,weight:[0,8],well:[0,4,8,14],were:4,what:[0,1,2,4,5,6,7,13,14,15],whatev:[5,6,14],wheeler:0,when:[0,1,4,5,6,7,8,13,14,15],where:[0,1,2,4,6,7,8],whether:[0,2,4,6,7,8,12,18],which:[0,1,2,3,4,5,6,7,8,13,14,15,18],white:0,white_dwarf_cooling_carrasco2014:0,white_dwarf_cooling_mestel:0,white_dwarf_cooling_mestel_modifi:0,white_dwarf_cooling_model:0,white_dwarf_radius_carrasco2014:0,white_dwarf_radius_model:0,white_dwarf_radius_mu:0,white_dwarf_radius_nauenberg1972:0,whole:6,width:0,wind:0,wind_algorithm_binary_c_2020:0,wind_algorithm_hurley2002:0,wind_algorithm_non:0,wind_algorithm_schneider2018:0,wind_angmom_loss_bs:0,wind_angmom_loss_lw:0,wind_angmom_loss_lw_hybrid:0,wind_angmom_loss_spherically_symmetr:0,wind_angular_momentum_loss:0,wind_disc_angmom_fract:0,wind_disc_mass_fract:0,wind_djorb_fac:0,wind_gas_to_dust_ratio:0,wind_mass_loss:0,wind_multiplier_:0,within:[0,4,6],without:[2,6],won:0,wood:0,wooslei:0,work:[0,4,5,12,13,14],would:[0,4,12,14],wouldnt:6,wr_wind:0,wr_wind_bs:0,wr_wind_eldridg:0,wr_wind_fac:0,wr_wind_maeder_meynet:0,wr_wind_nugis_lam:0,wrap:[1,13],wrapper:[4,5,18],write:[1,4,5,6,7,8,13,15],write_binary_c_calls_to_fil:6,write_binary_c_parameter_descriptions_to_rst_fil:4,write_grid_options_to_rst_fil:7,written:[5,6,7,8,13,15],wrlof_mass_transf:0,wrlof_method:0,wrlof_non:0,wrlof_q_depend:0,wrlof_quadrat:0,wrong:14,wrt:1,wrwindfac:0,wtts2:0,wtts_log:0,www:[0,2],year:[0,2],yet:[0,4,5,6,8,12,13],yield:0,you:[0,1,4,5,6,7,8,12,13,14,18],young:0,your:[5,14],yourself:[12,13],zam:[2,15,18],zams_collis:18,zams_mass:13,zero:[0,1],zero_ag:13,zone:0,zoom:0,zoomfac_multiplier_decreas:0,zoomfac_multiplier_increas:0,zshrc:14,zsolar:2,zytkow:0},titles:["Binary_c parameters","custom_logging_functions module","distribution_functions module","Examples","functions module","Examples","grid_class module","Grid options and descriptions","Population grid code options","hpc_functions module","Welcome to binary_c-python\u2019s documentation!","Binarycpython code","plot_functions module","Example of population script","Python module for binary_c","run_system_wrapper module","spacing_functions module","stellar_types module","useful_funcs module"],titleterms:{"function":4,"public":8,algorithm:0,binari:0,binary_c:[0,10,14],binarycpython:11,build:14,code:[8,11],custom_logging_funct:1,descript:7,distribution_funct:2,document:10,environ:14,exampl:[3,5,13],faq:14,grid:[7,8],grid_class:6,hpc_function:9,indic:10,input:0,instruct:14,misc:0,modul:[1,2,4,6,9,12,14,15,16,17,18],note:14,nucsyn:0,option:[7,8],output:0,paramet:0,plot_funct:12,popul:[8,13],privat:8,python:[10,14],requir:14,run_system_wrapp:15,script:13,section:0,spacing_funct:16,star:0,stellar_typ:17,tabl:10,usag:14,useful_func:18,variabl:14,welcom:10}}) \ No newline at end of file +Search.setIndex({docnames:["binary_c_parameters","custom_logging_functions","distribution_functions","examples","external_git","functions","general_examples","grid","grid_options_defaults","grid_options_descriptions","hpc_functions","index","modules","plot_functions","population_example","readme_link","run_system_wrapper","spacing_functions","stellar_types","useful_funcs"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["binary_c_parameters.rst","custom_logging_functions.rst","distribution_functions.rst","examples.rst","external_git.rst","functions.rst","general_examples.rst","grid.rst","grid_options_defaults.rst","grid_options_descriptions.rst","hpc_functions.rst","index.rst","modules.rst","plot_functions.rst","population_example.rst","readme_link.rst","run_system_wrapper.rst","spacing_functions.rst","stellar_types.rst","useful_funcs.rst"],objects:{"binarycpython.utils":{custom_logging_functions:[1,0,0,"-"],distribution_functions:[2,0,0,"-"],functions:[5,0,0,"-"],grid:[7,0,0,"-"],grid_options_defaults:[8,0,0,"-"],hpc_functions:[10,0,0,"-"],plot_functions:[13,0,0,"-"],run_system_wrapper:[16,0,0,"-"],spacing_functions:[17,0,0,"-"],stellar_types:[18,0,0,"-"],useful_funcs:[19,0,0,"-"]},"binarycpython.utils.custom_logging_functions":{autogen_C_logging_code:[1,1,1,""],binary_c_log_code:[1,1,1,""],binary_c_write_log_code:[1,1,1,""],compile_shared_lib:[1,1,1,""],create_and_load_logging_function:[1,1,1,""],from_binary_c_config:[1,1,1,""],return_compilation_dict:[1,1,1,""]},"binarycpython.utils.distribution_functions":{"const":[2,1,1,""],Arenou2010_binary_fraction:[2,1,1,""],Izzard2012_period_distribution:[2,1,1,""],Kroupa2001:[2,1,1,""],calculate_constants_three_part_powerlaw:[2,1,1,""],cosmic_SFH_madau_dickinson2014:[2,1,1,""],duquennoy1991:[2,1,1,""],flat:[2,1,1,""],flatsections:[2,1,1,""],gaussian:[2,1,1,""],gaussian_func:[2,1,1,""],gaussian_normalizing_const:[2,1,1,""],imf_chabrier2003:[2,1,1,""],imf_scalo1986:[2,1,1,""],imf_scalo1998:[2,1,1,""],imf_tinsley1980:[2,1,1,""],interpolate_in_mass_izzard2012:[2,1,1,""],ktg93:[2,1,1,""],number:[2,1,1,""],powerlaw:[2,1,1,""],powerlaw_constant:[2,1,1,""],prepare_dict:[2,1,1,""],raghavan2010_binary_fraction:[2,1,1,""],sana12:[2,1,1,""],set_opts:[2,1,1,""],three_part_powerlaw:[2,1,1,""]},"binarycpython.utils.functions":{BinaryCEncoder:[5,2,1,""],binarycDecoder:[5,2,1,""],binaryc_json_serializer:[5,1,1,""],create_arg_string:[5,1,1,""],create_hdf5:[5,1,1,""],example_parse_output:[5,1,1,""],extract_ensemble_json_from_string:[5,1,1,""],filter_arg_dict:[5,1,1,""],get_arg_keys:[5,1,1,""],get_defaults:[5,1,1,""],get_help:[5,1,1,""],get_help_all:[5,1,1,""],get_help_super:[5,1,1,""],handle_ensemble_string_to_json:[5,1,1,""],inspect_dict:[5,1,1,""],load_logfile:[5,1,1,""],make_build_text:[5,1,1,""],merge_dicts:[5,1,1,""],output_lines:[5,1,1,""],parse_binary_c_version_info:[5,1,1,""],remove_file:[5,1,1,""],return_binary_c_version_info:[5,1,1,""],temp_dir:[5,1,1,""],verbose_print:[5,1,1,""],write_binary_c_parameter_descriptions_to_rst_file:[5,1,1,""]},"binarycpython.utils.functions.BinaryCEncoder":{"default":[5,3,1,""]},"binarycpython.utils.functions.binarycDecoder":{decode:[5,3,1,""]},"binarycpython.utils.grid":{Population:[7,2,1,""]},"binarycpython.utils.grid.Population":{add_grid_variable:[7,3,1,""],evolve:[7,3,1,""],evolve_population:[7,3,1,""],evolve_single:[7,3,1,""],export_all_info:[7,3,1,""],parse_cmdline:[7,3,1,""],return_all_info:[7,3,1,""],return_population_settings:[7,3,1,""],set:[7,3,1,""],write_binary_c_calls_to_file:[7,3,1,""]},"binarycpython.utils.grid_options_defaults":{grid_options_description_checker:[8,1,1,""],grid_options_help:[8,1,1,""],write_grid_options_to_rst_file:[8,1,1,""]},"binarycpython.utils.plot_functions":{color_by_index:[13,1,1,""],dummy:[13,1,1,""],parse_function_hr_diagram:[13,1,1,""],parse_function_masses:[13,1,1,""],parse_function_orbit:[13,1,1,""],plot_HR_diagram:[13,1,1,""],plot_masses:[13,1,1,""],plot_orbit:[13,1,1,""],plot_system:[13,1,1,""]},"binarycpython.utils.run_system_wrapper":{run_system:[16,1,1,""]},"binarycpython.utils.spacing_functions":{"const":[17,1,1,""]},"binarycpython.utils.useful_funcs":{calc_period_from_sep:[19,1,1,""],calc_sep_from_period:[19,1,1,""],minimum_period_for_RLOF:[19,1,1,""],minimum_separation_for_RLOF:[19,1,1,""],ragb:[19,1,1,""],roche_lobe:[19,1,1,""],rzams:[19,1,1,""],zams_collision:[19,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"0001":19,"0007":2,"001":0,"002":6,"054":2,"0820":0,"08msun":0,"0902":0,"100":[0,2],"1000":6,"100000000000":6,"10e4":[],"115":2,"125":0,"12e":[1,14],"13e3":0,"1403":2,"150":14,"15000":[0,6,14],"15msun":2,"190":0,"1951":0,"1972":0,"1975":0,"1980":2,"1983":19,"1986":[0,2],"1991":2,"1993":0,"1996":19,"1998":[0,2],"1999":0,"1ckzg0p9":[11,15],"1e9":0,"200":0,"2000":0,"2001":2,"2002":0,"2003":[0,2],"2004":0,"2005":0,"2009":0,"2010":[0,2],"2012":[0,2],"2013":0,"2014":[0,2],"2015":0,"2016":0,"2017":0,"2018":[0,1],"2019":0,"2020":0,"2021":0,"20210111":[],"20210311":0,"257":19,"25msun":0,"281":19,"2969346":2,"2msun":0,"3000":0,"3msun":2,"42msun":0,"44msun":0,"45000000080":14,"4530":6,"463f148ec":[],"4e3":0,"500":0,"5479":[],"5542":0,"5msun":0,"625":0,"6944":0,"6msun":0,"7619":0,"763":2,"78125":0,"795":2,"80msol":2,"boolean":[0,5,7,9,13,19],"break":0,"case":[0,5],"catch":[5,6,9],"char":9,"class":[5,7],"const":[2,7,14,17],"default":[0,1,2,5,6,7,8,9,14,16],"export":[5,7,14],"float":[0,2,5,17,19],"function":[0,1,2,3,6,7,8,9,10,11,12,13,14,15,16,17,19],"import":[6,7,14],"int":[0,1,2,5,7,8,9,17,19],"long":[0,5,7,9,18],"new":[0,2,5,7],"null":[0,5],"paczy\u0144ski":0,"public":[8,11],"return":[0,1,2,5,7,8,9,13,16,17,19],"short":[0,18],"super":0,"switch":0,"throw":[11,15],"true":[0,5,7,8,9,13,14],"try":[0,11,15],"while":0,And:[8,11,15,19],For:[0,11,13,15],Gas:0,Its:9,NOT:[0,7,16],Not:[9,14],One:0,Pms:13,That:0,The:[0,1,2,5,6,7,9,11,13,14,15,16],Then:[5,11,15],There:[2,6,7,8,9,13],These:[5,9,13],Use:[0,6,7],Used:[0,9,13],Useful:[0,7,8],Uses:[0,17],Was:0,Will:[5,7,14,16],With:8,_binary_c_bind:[5,6,19],_binary_c_config_execut:9,_binary_c_dir:9,_binary_c_execut:9,_binary_c_shared_librari:9,_commandline_input:9,_count:9,_custom_logging_shared_library_fil:9,_end_time_evolut:9,_errors_exceed:9,_errors_found:9,_evolution_type_opt:9,_failed_count:9,_failed_prob:9,_failed_systems_error_cod:9,_generate_grid_cod:9,_grid_vari:9,_main_pid:9,_population_id:9,_probtot:9,_repeat:9,_set:[7,14],_start_time_evolut:9,_store_memaddr:9,_system_gener:9,_total_starcount:9,abat:0,abbrevi:18,abl:[],about:[5,7,8,14,19],abov:[0,5,6,7],abund:0,acc2:0,acceler:0,accept:[5,14],access:9,accord:0,accordingli:14,accret:0,accretion_end_tim:0,accretion_limit_dynamical_multipli:0,accretion_limit_eddington_lmms_multipli:0,accretion_limit_eddington_steady_multipli:0,accretion_limit_eddington_wd_to_remnant_multipli:0,accretion_limit_thermal_multipli:0,accretion_start_tim:0,accretor:[0,19],acess:2,act:[0,14],activ:[0,11,15],actual:[0,5,7,11,13,15],adapt:0,add:[2,5,7,13,14,17],add_grid_vari:[7,14],added:5,admittingli:13,adress:[1,6,9,19],affect:0,after:[0,7],ag89:0,again:5,against:13,agb:0,agb_3dup_algorithm:0,agb_core_algorithm:0,agb_core_algorithm_default:0,agb_core_algorithm_hurlei:0,agb_core_algorithm_karaka:0,agb_luminosity_algorithm:0,agb_luminosity_algorithm_default:0,agb_luminosity_algorithm_hurlei:0,agb_luminosity_algorithm_karaka:0,agb_radius_algorithm:0,agb_radius_algorithm_default:0,agb_radius_algorithm_hurlei:0,agb_radius_algorithm_karaka:0,agb_third_dredge_up_algorithm_default:0,agb_third_dredge_up_algorithm_hurlei:0,agb_third_dredge_up_algorithm_karaka:0,agb_third_dredge_up_algorithm_stancliff:0,age:0,aging:0,algorithm:11,algothim:0,all:[0,1,2,5,6,7,8,9,11,12,13,14,15,16],all_info:7,allow:[0,6,9],allow_nan:5,along:[0,8,9],alot:[9,14],alpha:0,alpha_c:0,alphacb:0,alreadi:7,also:[0,5,6,7,8,11,15,19],alt:[11,15],altern:0,alwai:0,amanda:0,amax:2,amin:2,amount:[0,7,8,9,14,17],amt_cor:[9,14],analys:16,andrew:[11,15],andronov:0,angelou_lithium_cheb_decay_tim:0,angelou_lithium_cheb_massfrac:0,angelou_lithium_cheb_tim:0,angelou_lithium_decay_funct:0,angelou_lithium_decay_function_exponenti:0,angelou_lithium_decay_tim:0,angelou_lithium_eagb_decay_tim:0,angelou_lithium_eagb_massfrac:0,angelou_lithium_eagb_tim:0,angelou_lithium_gb_decay_tim:0,angelou_lithium_gb_massfrac:0,angelou_lithium_gb_tim:0,angelou_lithium_hg_decay_tim:0,angelou_lithium_hg_massfrac:0,angelou_lithium_hg_tim:0,angelou_lithium_lmms_decay_tim:0,angelou_lithium_lmms_massfrac:0,angelou_lithium_lmms_tim:0,angelou_lithium_ms_decay_tim:0,angelou_lithium_ms_massfrac:0,angelou_lithium_ms_tim:0,angelou_lithium_tpagb_decay_tim:0,angelou_lithium_tpagb_massfrac:0,angelou_lithium_tpagb_tim:0,angelou_lithium_vrot_trigg:0,angelou_lithium_vrotfrac_trigg:0,angmom_to_orbit_factor:0,angular:[0,13],angular_momentum_accretion_rate1:0,angular_momentum_accretion_rate2:0,angular_momentum_accretion_rate_orbit:0,ani:[0,2,5,7],anoth:0,ansi:0,anyth:[0,9],anywai:7,anywher:7,api:[0,5],api_log_filename_prefix:0,append:[1,5],appli:0,approach:6,appropri:0,approxim:0,aren:2,arenou2010_binary_fract:2,arg:[2,5,13],arg_dict:5,argpair:5,argstr:6,argument:[0,2,5,6,7,9,14,16],argument_of_periastron:0,argument_of_periastron_quadrupl:0,argument_of_periastron_tripl:0,around:[0,6],arrai:[2,5,6],artifici:0,artificial_accretion_ignor:0,arxiv:[0,2],asarrai:6,asign:7,ask:[0,19],asplund:0,assum:[0,13],ast871:0,astronomi:0,astropi:[11,13,15],atom:5,attempt:[5,7],auto:12,autogen_c_logging_cod:[1,6],autogener:[1,6],automat:[0,1,6,8,11,15],avaibl:[11,15],avail:[0,5,9,13],awai:0,axi:[0,13],b_1:0,b_2:0,b_3:0,b_4:0,b_inclination1:0,b_inclination2:0,b_inclination3:0,b_inclination4:0,back:0,background:6,backward:0,bagb:0,barn:0,base:[0,2,5,6,7,11,13,15,19],base_filenam:[7,14],bashrc:[],basic:[6,7],batchmod:0,beasor:0,becaus:[0,6,7],becom:[0,1,2,5],been:[0,7],befor:[0,7,9,11,14,15],behaviour:[5,16],behind:6,being:5,belczynski:0,below:[0,14],berro:0,bertolami:0,best:[7,9,11,15],beta_reverse_nova:0,beta_reverse_novae_geometri:0,better:7,between:[0,2,17],bewar:7,bh_belczynski:0,bh_fryer12_delai:0,bh_fryer12_rapid:0,bh_hurley2002:0,bh_prescript:0,bh_spera2015:0,big:0,bin:[0,6,11,15],binari:[2,6,7,9,11,13,14,19],binary_c2:[11,15],binary_c:[1,2,5,6,7,9,13,14,16],binary_c_cal:7,binary_c_default:14,binary_c_inline_config:1,binary_c_log_cod:[1,6],binary_c_macro:0,binary_c_output:5,binary_c_paramet:14,binary_c_python:5,binary_c_python_api:[],binary_c_task_:0,binary_c_write_log_cod:1,binary_grid:0,binary_star:19,binaryc:[1,5,16],binaryc_config:1,binaryc_json_seri:5,binarycdecod:5,binarycencod:5,binarycpython:[1,2,5,6,7,8,11,13,14,15,16,17,19],bind:0,birth:0,bivari:0,black:0,black_hol:0,bloecker:0,blog:1,boltzman:13,boltzmann:0,bondi:0,bondi_hoyle_accretion_factor:0,bool:[5,7,8,13],born:0,both:[0,5],bottom:0,bound:[2,17],boundari:2,brake:0,branch:[0,5],branch_david:0,breakup:0,broken:0,bse:[0,2],bse_opt:[7,14],buffer:0,build:[0,1,5],built:[0,1,5,11,15],burn:0,busso:0,bye:0,c13_eff:0,c_auto_log:[9,14],c_log:0,c_logging_cod:[9,14],calc_period_from_sep:19,calc_sep_from_period:[14,19],calcul:[0,2,7,9,19],calculate_constants_three_part_powerlaw:2,call:[0,1,5,7,9,13,14,16],can:[0,1,2,5,6,7,9,11,13,14,15,16],cannot:7,cap:0,captur:0,carbon:0,carbon_oxygen_white_dwarf:0,carlo:0,carrasco:0,carri:0,cast:[5,6],categor:5,caught:5,caus:19,cbdisc:0,cbdisc_alpha:0,cbdisc_eccentricity_pumping_dermin:0,cbdisc_eccentricity_pumping_method:0,cbdisc_eccentricity_pumping_non:0,cbdisc_end_evolution_after_disc:0,cbdisc_fail_ring_inside_separ:0,cbdisc_gamma:0,cbdisc_init_djdm:0,cbdisc_init_dm:0,cbdisc_inner_edge_strip:0,cbdisc_inner_edge_stripping_timescal:0,cbdisc_kappa:0,cbdisc_mass_loss_constant_r:0,cbdisc_mass_loss_fuv_multipli:0,cbdisc_mass_loss_inner_l2_cross_multipli:0,cbdisc_mass_loss_inner_viscous_accretion_method:0,cbdisc_mass_loss_inner_viscous_accretion_method_equ:0,cbdisc_mass_loss_inner_viscous_accretion_method_gerosa_2015:0,cbdisc_mass_loss_inner_viscous_accretion_method_non:0,cbdisc_mass_loss_inner_viscous_accretion_method_young_clarke_2015:0,cbdisc_mass_loss_inner_viscous_angular_momentum_multipli:0,cbdisc_mass_loss_inner_viscous_multipli:0,cbdisc_mass_loss_ism_pressur:0,cbdisc_mass_loss_ism_ram_pressure_multipli:0,cbdisc_mass_loss_xray_multipli:0,cbdisc_max_lifetim:0,cbdisc_minimum_evaporation_timescal:0,cbdisc_minimum_fr:0,cbdisc_minimum_luminos:0,cbdisc_minimum_mass:0,cbdisc_no_wind_if_cbdisc:0,cbdisc_outer_edge_strip:0,cbdisc_outer_edge_stripping_timescal:0,cbdisc_resonance_damp:0,cbdisc_resonance_multipli:0,cbdisc_torquef:0,cbdisc_viscous_l2_coupl:0,cbdisc_viscous_photoevaporative_coupl:0,cbdisc_viscous_photoevaporative_coupling_inst:0,cbdisc_viscous_photoevaporative_coupling_non:0,cbdisc_viscous_photoevaporative_coupling_visc:0,cemp:0,cemp_cfe_minimum:0,certain:[3,9,11,15],cf_amanda_log:0,cflag:[11,15],chabrier:2,chandrasekhar:0,chandrasekhar_mass:0,chang:[0,1,2,5,7,8,9,11,14,15],chapter:[0,3,9,12],cheb:0,check:[2,5,7,8,14,19],check_circular:5,chemic:0,chen:0,child:5,choic:[0,7,13],choos:[0,6,13],chosen:7,circular:0,circumbinari:0,circumstanti:0,claei:0,clark:0,clean:[1,7,11,15],clean_up_custom_logging_fil:7,clear:5,cloud:0,cls:5,cluster:10,cmdline:7,cnn:4,code:[0,1,3,6,7,8,11,13,14,15,16],collaps:0,collapsar:0,collect:19,collid:19,color:13,color_by_index:13,colour:0,colour_log:0,column:[6,13,14],com:1,combin:[1,5,7,9],combine_ensemble_with_thread_join:9,come:[2,11,15,17],comenv_bs:0,comenv_disc_angmom_fract:0,comenv_disc_mass_fract:0,comenv_ejection_spin_method:0,comenv_ejection_spin_method_do_noth:0,comenv_ejection_spin_method_sychron:0,comenv_ejection_spin_method_synchron:0,comenv_merger_spin_method:0,comenv_merger_spin_method_breakup:0,comenv_merger_spin_method_conserve_angmom:0,comenv_merger_spin_method_conserve_omega:0,comenv_merger_spin_method_specif:0,comenv_ms_accret:0,comenv_ms_accretion_fract:0,comenv_ms_accretion_mass:0,comenv_nandez2016:0,comenv_nelemans_tout:0,comenv_ns_accret:0,comenv_ns_accretion_fract:0,comenv_ns_accretion_mass:0,comenv_post_eccentr:0,comenv_prescript:0,comenv_splitmass:0,comenv_undef:0,command:[0,1,7,9,11,15],commandlin:[7,9,14],commit:5,common:[0,14],companion:[0,14],compar:0,compil:[1,6,11,14,15],compile_shared_lib:1,complain:14,complex:[6,7,9,13],compon:[5,13],comput:10,condit:[6,7,14],condor:[7,9,10],condor_grid:7,config:[1,9,11,15],config_fil:1,configur:[2,6,14],conserv:0,consid:[0,1,2,5,7,9,13],constant:[0,2,13],construct:[0,1,6],conta:8,contain:[0,1,2,3,5,7,8,9,10,11,12,13,14,15,16,17,18],content:[5,11],continu:7,control:0,convect:0,converg:0,convert:[2,5,7],cool:0,copi:[7,19],core:[0,7,9,13],core_helium_burn:0,core_mass:0,correct:[7,13,19],correctli:[6,11,13,14,15],correspond:13,corretor:0,cosmic:2,cosmic_sfh_madau_dickinson2014:2,could:[0,5],counter:9,coupl:0,coverag:[11,15],cowd:0,cpu:0,crap_paramet:0,creat:[5,7,14],create_and_load_logging_funct:[1,6],create_arg_str:5,create_hdf5:[5,14],critic:0,cross:0,ctype:1,cuntz:0,current:[0,5],custom:[0,1,5,6,7,9,13,14,16],custom_log:[6,7,9],custom_logging_cod:[1,6,16],custom_logging_func_memaddr:[6,9],custom_logging_funct:[6,9,11,12,14],custom_logging_info:7,custom_opt:[7,14],cut:6,dai:[0,6,14,19],damp:0,dat:[0,5,14],data:[0,5,6,14,16],data_dir:[5,7,9,14],datadir:7,datafram:[6,13],date:7,david:[0,11,15],david_logging_funct:0,dd7:0,deactiv:0,deal:5,death:0,debug:9,decai:0,decid:[0,5,6],decod:5,decreas:0,deeper:7,def:[6,14],default_to_metal:0,defaultdict:5,defer:0,defin:[0,1,2,7,13],definit:[1,19],degener:0,degre:0,delta_mcmin:0,den:0,depend:[0,2,11,13,15],deprec:0,dermin:0,describ:[0,2,6,9],descript:[0,5,9,11,12],design:[7,13],desir:0,destruct:7,detail:[0,5],determin:[0,7,19],deton:0,dev:0,develop:1,deviat:2,dewi:0,dex:0,df2:6,diagnost:9,diagram:[0,13],dickonson:2,dict:[1,2,5,7,8,14,18],dict_1:5,dict_2:5,dictinari:[],dictionari:[1,2,5,7,8,9,13,18],did:[5,11,15],didnt:[],differ:[0,5,7,11,13,15],dimmer:0,dir:[],direct:[0,7],directli:6,director:9,directori:[0,5,7,9,11,14,15],disabl:0,disable_end_log:0,disable_ev:0,disc:0,disc_legacy_log:0,disc_log2d:0,disc_log:0,disc_log_directori:0,disc_log_dt:0,disc_log_level_non:0,disc_log_level_norm:0,disc_log_level_normal_first_disc_onli:0,disc_log_level_subtimestep:0,disc_log_level_subtimestep_first_disc_onli:0,disc_n_monte_carlo_guess:0,disc_stripping_timescale_infinit:0,disc_stripping_timescale_inst:0,disc_stripping_timescale_orbit:0,disc_stripping_timescale_visc:0,disc_timestep_factor:0,discs_circumbinary_from_comenv:0,discs_circumbinary_from_wind:0,disk:[0,7],dispers:0,displai:0,dist:[11,15],distribut:[0,2,10],distribution_funct:[11,12],distributoon:2,divid:10,dlnm1:[7,14],dlog10per:14,dlogp:2,doc:[5,8,11,15],doc_fetch:2,docstr:13,document:[5,8,9,12],doe:[0,2,7,19],doesn:7,doesnt:[6,8],doing:[0,1,7,8],don:9,done:[0,6,11,14,15],donm:14,donor:[0,19],donor_limit_dynamical_multipli:0,donor_limit_envelope_multipli:0,donor_limit_thermal_multipli:0,donor_rate_algorithm_bs:0,donor_rate_algorithm_claeys2014:0,dont:[2,5,6,7],download:[11,15],dphasevol:[7,14],dr2:0,dr3:0,drai:0,dredg:0,dtfac:0,dtlimit:5,dtm:[1,14],dtype:6,due:[11,15],dummi:[2,13],dump:[0,5],dumpvers:0,duquennoi:2,duquennoy1991:2,dure:0,dust:0,dwarf:0,dynam:0,e2_hurley_2002:0,e2_izzard:0,e2_prescript:0,each:[0,2,5,7,9],eagb:0,eagb_wind_beasor_etal_2020:0,eagb_wind_bs:0,eagb_wind_goldman_etal_2017:0,eagbwind:0,eagbwindfac:0,earli:0,early_asymptotic_giant_branch:0,easi:5,easier:[5,6],easili:[],ecc:[6,7],eccentr:[0,2,6,13,14,19],eccentric_rlof_model:0,eccentricity_quadrupl:0,eccentricity_tripl:0,echo:0,eddington:0,edg:0,edu:0,effect:[0,2],effective_metal:0,effici:0,egg:[11,15],eggleton:[0,19],either:[0,5,6,7,16],eject:0,eld:0,eldridg:0,electon:0,electron:0,element:[0,1,5,9,13],email:5,emp:0,emp_logg_maximum:0,emp_minimum_ag:0,empti:[5,8],enabl:0,encod:5,encount:9,end:[0,5,9,14],energi:0,enhanc:0,enlarg:0,ensembl:[0,5],ensemble_def:0,ensemble_dt:0,ensemble_filter_:0,ensemble_filters_off:0,ensemble_json:5,ensemble_legacy_ensembl:0,ensemble_list:7,ensemble_logdt:0,ensemble_logtim:0,ensemble_output_:9,ensemble_result:[],ensemble_startlogtim:0,ensure_ascii:5,enter:[0,11,15],enthalpi:0,entir:6,entri:5,entrypoint:7,env:[11,13,15],envelop:0,environ:[],episod:0,equal:[5,14],equat:0,equation_of_state_algorithm:0,equation_of_state_paczynski:0,equatori:0,errno:[11,15],error:[5,9,11,15],esa:2,escap:0,escape_fract:0,escape_veloc:0,esnemble_macro:0,eta:0,etal:0,etc:[0,5,7,10,11,13,14,15,16],euler:0,evalu:[2,7,19],evan:0,evapor:0,event:0,everi:[0,11,15],everyth:[7,9,14],everytim:[11,15],evid:0,evolut:[0,1,6,7,9,13],evolution_split:0,evolution_splitting_maxdepth:0,evolution_splitting_sn_n:0,evolution_typ:9,evolutionari:0,evolv:[0,7,14],evolve_popul:[7,14],evolve_singl:[7,14],exact:[1,5,9],exactli:0,exampl:[1,2,5,7,16],example_head:5,example_header_1:6,example_header_2:6,example_log:16,example_log_co:1,example_parse_output:[5,6],example_pop:14,example_python_population_result:14,exce:[0,9],except:[5,7,8,13],excess:0,execut:[0,7,9,14],exist:[0,7,8,14],exist_ok:[5,14],exit:0,exp:[7,14],expand:16,expect:[11,15],experienc:[],experiment:[0,5],explain:5,explicilti:1,explod:0,explos:0,expoenti:0,expon:0,export_all_info:[7,14],express:0,extend:[11,15],extern:0,extra:[0,7,9,16],extract:[5,14],extract_ensemble_json_from_str:5,f3401ead4:0,fabian:0,fabian_imf_log:0,fabian_imf_log_tim:0,fabian_imf_log_timestep:0,factor:[0,2,9],fail:[0,5,9,11,15],fail_sil:5,failed_system:9,failed_system_log:9,failed_systems_threshold:9,fals:[0,5,7,9,13,14],fancy_parsing_funct:16,faq:[],far:0,farmer:0,fase:14,fast:0,ferguson:0,field:0,fig:[0,2],figur:[9,13],file:[0,1,5,7,8,9,10,11,13,14,15],file_log:0,filenam:[0,1,5,6,7,9,14,16],filenotfounderror:[11,15],filepath:[1,5],filesystem:5,filter:[0,5],filter_arg_dict:5,filter_valu:5,fin:0,find:[7,9],finish:[5,13],first:[0,2,5,7,11,15,19],first_giant_branch:0,fishlock:0,fit:[0,2,7,19],fix:[0,2,5,7,13],flag:[1,5,9],flash:0,flat:2,flatsect:[2,14],flaw:7,float64:6,flto:[11,15],follow:[0,2,5,9,11,13,15],forc:[0,11,15],force_circularization_on_rlof:0,force_corotation_of_primary_and_orbit:0,forloop:7,form:[0,5,7,8],formal:0,format:[0,2,5,6,7,14],formula:0,forward:0,found:[2,11,15],four:0,fpic:1,fraction:[0,2],frequenc:0,friction:0,fring:0,from:[0,2,5,6,7,9,13,14,19],from_binary_c_config:1,from_dict:6,ftz:[11,15],full:[5,9],full_path:5,fulli:[7,14],func_memaddr:6,fuv:0,gaia:[0,2],gaia_colour_transform_method:0,gaia_conversion_ubvri_bivariate_jordi2010:0,gaia_conversion_ubvri_riello2020:0,gaia_conversion_ubvri_univariate_evans2018:0,gaia_conversion_ubvri_univariate_jordi2010:0,gaia_conversion_ugriz_bivariate_jordi2010:0,gaia_conversion_ugriz_riello2020:0,gaia_conversion_ugriz_univariate_evans2018:0,gaia_conversion_ugriz_univariate_jordi2010:0,gaia_l_binwidth:0,gaia_teff_binwidth:0,gain:9,galact:0,gallino:0,gamma:0,gap:0,garcia:0,gauss:0,gaussian:2,gaussian_func:2,gaussian_normalizing_const:2,gb_reimers_eta:0,gb_wind_beasor_etal_2020:0,gb_wind_goldman_etal_2017:0,gb_wind_reim:0,gb_wind_schroeder_cuntz_2005:0,gbwind:0,gbwindfac:0,gcc:[1,11,15],gce:0,gener:[0,1,2,5,6,7,8,9,13,14],geometr:0,gerosa:0,get:[0,5,6,7,8,11,14,15,16,19],get_arg_kei:5,get_default:5,get_help:[5,14],get_help_al:[5,7,14],get_help_sup:5,gettempdir:6,giant:0,giant_branch:0,git:[0,5],git_branch:5,git_build:5,github:[],gitlab:11,give:[0,2,5,6,19],given:[0,1,2,5,6,7,16,19],globablli:2,global:[0,2],global_dict:2,gmax:2,gmin:2,goe:[0,7,13],gogo:0,going:[11,15],goldman:0,gonna:2,good:[0,9,14,19],gravit:0,gravitational_radiation_bs:0,gravitational_radiation_bse_when_no_rlof:0,gravitational_radiation_landau_lifshitz:0,gravitational_radiation_landau_lifshitz_when_no_rlof:0,gravitational_radiation_model:0,gravitational_radiation_modulator_:0,gravitational_radiation_modulator_j:0,gravitational_radiation_non:0,grb:0,greater:0,grevess:0,grid:[0,5,7,11,12,14],grid_class:[11,12],grid_cod:7,grid_opt:[7,9,14],grid_options_default:8,grid_options_defaults_dict:8,grid_options_descript:8,grid_options_description_check:8,grid_options_help:8,grid_vari:[9,14],gridcod:7,gridcode_filenam:9,group:5,guess:[0,2],h5py:[11,15],hachisu:0,hachisu_disk_wind:0,hachisu_ignore_qcrit:0,hachisu_qcrit:0,hack:8,had:7,half:0,handi:0,handl:[0,7,9,14,16,19],handle_ensemble_string_to_json:5,happen:0,has:[0,1,5,6,7,9],have:[0,2,5,6,7,8,9,11,13,14,15],hbb:0,hbbtfac:0,hdf5:[5,14],hdf5file:5,header:[1,5,6,14],headerlin:14,headlin:9,hegb:0,hehg:0,height:[2,14],helium:0,helium_flash_mass_loss:0,helium_white_dwarf:0,help:[0,5,8,14],help_al:0,hem:0,henc:0,hendrik:[11,15],here:[1,5,6,7,13,14],hertzsprung:0,hertzsprung_gap:0,hertzstrpung:0,heuvel:0,hewd:0,hex:9,high:[0,2],higher:[0,5,9],his:2,histori:2,hole:0,hopefulli:0,hot:0,how:[0,5,6,7,9],howev:0,hoyl:0,hpc:[7,10],hpc_function:[11,12],hr_diagram:13,hrd:0,hrdiag:0,hrdiag_output:0,html:[11,15],http:[0,1,2],hurlei:0,hybrid:0,hydro:0,hydrogen:0,hyperlink:[],ibc:0,idea:13,idum:0,ignit:0,ignor:[0,6,11,15],iia:0,imag:[11,15],imf:[0,2],imf_chabrier2003:2,imf_scalo1986:2,imf_scalo1998:2,imf_tinsley1980:2,immedi:0,implement:[0,7,9],impli:0,impos:14,inclin:0,inclination1:0,inclination2:0,inclination3:0,inclination4:0,inclini:0,incliniation_quadrupl:0,incliniation_tripl:0,includ:[0,1,5,6,7,11,13,15],include_binary_c_default:[7,14],include_binary_c_help_al:[7,14],include_binary_c_version_info:[7,14],include_default:7,include_popul:14,include_population_set:7,increas:0,inde:0,indent:5,index:[0,2,11],indic:0,individual_nova:0,induc:0,inertia:0,info:[5,7,11,13,14,15],inform:[0,1,5,7,8,13,14],init:7,init_abund:0,init_abund_dex:0,init_abund_mult:0,init_abunds_onli:0,initi:[0,2,7],initial_abundance_hash:7,initial_abundance_mix:0,initial_abunds_onli:0,inlin:6,inner:0,input:[1,2,5,7,9,11,13,19],input_dict:5,insert:7,inspect:[5,13,14],inspect_dict:5,inspir:[1,6,13,19],instabl:0,instal:[],instanc:[5,14],instant:0,instantli:0,instead:[0,5,9],instruct:[],integ:[0,7,9,19],interact:[0,8],interfac:5,interfer:[11,15],intern:[0,9],internal_buff:0,internal_buffering_off:0,internal_buffering_print:0,internal_buffering_stor:0,interpol:2,interpolate_in_mass_izzard2012:2,intershel:0,interstellar:0,intro:0,invers:19,involv:0,inward:0,isn:[5,7],isnt:14,isotop:[0,5],isotope_hash:7,isotope_list:7,issu:[],item:1,iter:5,its:[0,5,8,11,13,15,16],itself:[5,9,11,15],iwamoto:0,izzard2012_period_distribut:2,izzard:[0,11,15],jager:0,jan:[],jaschek:2,jeff:[11,15],jia:0,john:0,join:14,jordi:0,json:[5,7,9,14],jsondecod:5,jsonencod:5,jupyt:[11,15],just:[0,2,5,6,7,9,19],kappa:0,karaka:0,keep:7,kei:[1,2,5,7,8,9,13],kelvin:0,keplerian:0,keypair:5,keyword:[13,16],kick:[0,9],kick_backward:0,kick_forward:0,kick_inward:0,kick_outward:0,kick_random:0,kick_straight_up:0,kick_velocity_custom:0,kick_velocity_fix:0,kick_velocity_maxwellian:0,kill:[1,14],kim:0,kind:0,know:[0,1,7,8],known:[0,7,14,16],kroupa2001:[2,7],kroupa:2,ktg93:2,kwarg:[7,13,16],lambda:0,lambda_c:0,lambda_ce_dewi_tauri:0,lambda_ce_polytrop:0,lambda_ce_wang_2016:0,lambda_enthalpi:0,lambda_ionis:0,lambda_min:0,lambda_mult:0,lambda_multipli:0,lamer:0,landau:0,langer:0,larger:0,late:6,latter:0,law:2,ld_library_path:[11,15],lead:0,least:[11,15],leav:0,left:0,legaci:0,legacy_yield:0,len:14,lengthen:0,less:[0,1,2],let:7,level:[1,5],li7:0,lib:6,libbinary_c:9,libgsl:[11,15],libmemo:[11,15],librari:[1,6,7,9,16],library_path:[11,15],librinterpol:[11,15],lies:0,lifetim:0,lifshitz:0,like:[0,1,5,6,7,9,11,13,15,17],limit:[0,13],line:[1,5,6,7,9,11,13,15],linear:[0,9],linearli:[7,17],linker:1,linspac:17,list:[0,1,2,5,9,16,17],list_arg:0,list_of_sub_kei:2,lit:0,lithium:0,lithium_gb_post_1dup:0,lithium_gb_post_heflash:0,lithium_hbb_multipli:0,lithium_t:0,littleton:0,liu:0,lnm1:[7,14],load:[0,1,5,6,7,13,14],load_logfil:5,lobe:[0,19],local:2,locat:[0,2,9,11,15],lodder:0,log10:[0,2,14],log10p:2,log10per:14,log10pmin:2,log:[0,1,2,6,7,9,11,13,14,15,16,19],log_arg:9,log_args_dir:9,log_fil:9,log_filenam:[0,6,16],log_runtime_system:9,logarithm:2,logensembletim:0,logfil:[5,11,15,16],logg:0,logging_dict:1,logging_lin:6,logic:[1,7,9],logp:2,logper:2,long_spectral_typ:2,longer:0,longnam:[7,14],look:[1,5,11,15],lookback:0,loon:0,loop:7,loos:13,lose:0,loss:0,lost:0,lot:[5,16],low:[0,2,14],low_mass_m:0,low_mass_main_sequ:0,lower:[0,2,17],lsun:13,lugaro:0,luminos:[0,13],luminosity_1:13,luminosity_2:13,lynnett:0,m_1:[0,6,7,14,16],m_2:[0,6,14],m_3:0,m_4:0,m_max:[2,7],m_min:7,m_re:6,maccretor:0,machin:[9,11,15],macro:[0,5],madau:2,maeder:0,magellan:0,magnet:0,magnetic_braking_algorithm:0,magnetic_braking_algorithm_andronov_2003:0,magnetic_braking_algorithm_barnes_2010:0,magnetic_braking_algorithm_hurley_2002:0,magnetic_braking_algorithm_rappaport_1983:0,magnetic_braking_factor:0,magnetic_braking_gamma:0,mai:0,main:[0,1,9,11,15],main_sequ:0,mainli:10,major:0,make:[0,1,2,5,6,7,9,11,13,14,15,16],make_build_text:5,makedir:[5,14],manag:[11,15],mani:[0,7,9],manual:[],manual_vrot:0,manufactur:0,mar:0,marchant:0,maria:0,mass:[0,1,2,5,6,7,9,13,14,16,19],mass_1:[6,13],mass_2:[6,13],mass_accretion_for_eld:0,mass_accretion_rate1:0,mass_accretion_rate2:0,mass_accretor:19,mass_donor:19,mass_evolut:13,mass_for_hestar_ia_low:0,mass_for_hestar_ia_upp:0,mass_of_pmz:0,massiv:[0,2],massless_remn:0,master:[9,13],match:[0,5,13],materi:0,math:[7,14],matplotlib:[11,13,15],matter:0,mattsson:0,mattsson_mass_loss:0,mattsson_orich_tpagbwind:0,max:[0,2,14],max_bound:[2,17],max_evolution_tim:[0,1,6,14],max_hewd_mass:0,max_model_numb:0,max_neutron_star_mass:0,max_stellar_angmom_chang:0,max_val:2,maximum:[0,2,9],maximum_mass_ratio_for_instant_rlof:0,maximum_mcbagb_for_degenerate_carbon_ignit:0,maximum_nuclear_burning_timestep:0,maximum_timestep:0,maximum_timestep_factor:0,maxmimum:0,maxwellian:0,mayb:13,mayor:2,mc13_pocket_multipli:0,mch:0,mcmin:0,mdonor:0,mean:[0,2,5,7,11,15],meant:9,medium:0,megaparsec:2,memaddr:6,memori:[1,6,7,9,19],menv:0,merg:[0,5],merge_dict:5,merger:0,merger_angular_momentum_factor:0,mesa:[11,15],mesasdk_init:[11,15],mesasdk_root:[11,15],messag:5,mestel:0,met:7,metal:[0,2,6,19],method:[0,6,7],meynet:0,might:[7,11,15],milki:0,miller:0,min:[2,14],min_bound:[2,17],min_val:2,mind:6,minimal_verbos:5,minimum:[0,2,5,19],minimum_co_core_mass_for_carbon_ignit:0,minimum_co_core_mass_for_neon_ignit:0,minimum_donor_menv_for_comenv:0,minimum_envelope_mass_for_third_dredgeup:0,minimum_helium_ignition_core_mass:0,minimum_mcbagb_for_nondegenerate_carbon_ignit:0,minimum_orbital_period_for_instant_rlof:0,minimum_period_for_rlof:19,minimum_separation_for_instant_rlof:0,minimum_separation_for_rlof:19,minimum_timestep:0,mint:0,mint_dir:0,mint_ms_rejuven:0,mira:0,misc:11,miscellan:5,miss:[5,8],mix:0,mixtur:0,mmax:2,mnra:19,model:[0,1,6,14],modifi:0,modul:[0,8,12],modulo:9,moment:[0,14,17],momenta:[0,13],momentum:0,mont:0,monte_carlo_kick:0,montecarlo:9,more:[0,1,5,6,7,9,11,13,15,17],most:5,mostli:[5,6,8,9,13,14,16],msun:[0,6],much:5,mulitpli:9,mulitprocess:[],multipl:[0,2],multiplc:0,multipli:0,multiprocess:[7,9],multithread:9,must:[0,2],my_header_lin:14,my_sss2:6,my_stellar_data:[1,6,14],myr:[0,6],n100:0,n100_z0:0,n100h:0,n100l:0,n10:0,n150:0,n1600:0,n1600c:0,n200:0,n20:0,n300c:0,n40:0,naked_helium_star_giant_branch:0,naked_helium_star_hertzsprung_gap:0,naked_main_sequence_helium_star:0,name:[1,5,6,7,8,14,16,18],natur:0,nauenberg:0,nearer:0,necessari:[5,6,7,14],need:[0,6,7,11,14,15],neg:0,neither:[0,7],neleman:0,nelemans_gamma:0,nelemans_max_frac_j_chang:0,nelemans_minq:0,nelemans_n_comenv:0,nelemans_recalc_eccentr:0,nenamg:0,neon:0,nest:[5,7],network:0,neutrn:0,neutron:[0,14],neutron_star:0,never:0,newer:[0,2],newli:0,newopt:2,newton:0,next:5,nice:[1,7,13,14],nieuwenhuijzen:0,nieuwenhuijzen_windfac:0,no_thermohaline_mix:0,noecho:0,noechonow:0,noel:0,nomin:0,non:0,nonconservative_angmom_gamma:0,none:[0,1,2,5,6,7,8],nor:0,normal:[0,2],normalis:2,note:[0,6],notebook:[11,15],notifi:16,nova:0,nova_faml_multipli:0,nova_irradiation_multipli:0,nova_retention_algorithm_claeys2014:0,nova_retention_algorithm_const:0,nova_retention_algorithm_hillman2015:0,nova_retention_fract:0,nova_retention_method:0,nova_timestep_accelerator_index:0,nova_timestep_accelerator_max:0,nova_timestep_accelerator_num:0,now:[0,2,5,6],nuclear:0,nuclear_mass_hash:7,nuclear_mass_list:7,nucleosynthesi:[0,5],nucleosynthesis_sourc:5,nucreacmult:0,nucsyn:11,nucsyn_angelou_lithium:0,nucsyn_gce_outflow_check:0,nucsyn_hbb:0,nucsyn_init_abund_mix_ag89:0,nucsyn_init_abund_mix_asplund2005:0,nucsyn_init_abund_mix_asplund2009:0,nucsyn_init_abund_mix_garciaberro:0,nucsyn_init_abund_mix_grevesse_noels_1993:0,nucsyn_init_abund_mix_karakas2002:0,nucsyn_init_abund_mix_kobayashi2011_asplund2009:0,nucsyn_init_abund_mix_lodders2003:0,nucsyn_init_abund_mix_lodders2010:0,nucsyn_metal:0,nucsyn_s_process:0,nucsyn_third_dredge_up:0,nugi:0,number:[0,2,5,6,7],numpi:[5,6,11,15,17],obj:5,object:[0,5,7,9,10,13,14],object_hook:5,object_pairs_hook:5,obtain:0,occur:[0,19],ofcours:13,off:[0,6,14],offset:0,ohio:0,old_solut:[11,15],omega:0,onc:0,one:[0,5,6,7,13],onewd:0,onli:[0,5,6,7,9,19],onset:0,onto:0,opac:0,opacity_algorithm:0,opacity_algorithm_ferguson_op:0,opacity_algorithm_paczynski:0,opacity_algorithm_star:0,opal:0,open:14,opm:2,opt:[2,5],option:[1,2,5,6,7,11,12,14,15,19],orb:7,orbit:[0,2,13,14,19],orbit_evolut:13,orbital_inclin:0,orbital_inclinationi:0,orbital_period:[0,6,14,19],orbital_period_quadrupl:0,orbital_period_tripl:0,orbital_phas:0,orbital_phase_quadrupl:0,orbital_phase_tripl:0,order:[5,6,7],org:[0,2],origin:[11,15],other:[0,1,2,5,8,9,11,13,14,15],otherwis:[7,8,9],out:[5,8,9],outcom:0,outer:0,outfil:[7,14],outfile_nam:1,outfilenam:14,output:[1,5,6,7,9,11,13,14,15,16,19],output_dir:7,output_fil:[5,8],output_filenam:7,output_lin:[5,14],outsid:0,outward:0,over:[5,7,14],overflow:0,overrid:[2,6],overriden:14,overshoot:0,overspin_algorithm:0,overspin_bs:0,overspin_massloss:0,own:[6,7,9,11,15],oxygen:0,oxygen_neon_white_dwarf:0,pack:14,packag:[5,11,15,17],paczynski:0,page:[0,11,15],pair:[0,5],panda:[5,6,11,13,15],pane:13,panel:0,paper:0,param:13,param_nam:5,paramet:[1,2,5,7,8,9,11,13,14,16,17,19],parameter_nam:[5,7,14],parameter_value_input_typ:5,pars:[5,6,7,13,14,16],parse_binary_c_version_info:5,parse_cmdlin:7,parse_const:5,parse_float:5,parse_funct:[7,9,14,16],parse_function_hr_diagram:13,parse_function_mass:13,parse_function_orbit:13,parse_int:5,parse_output:6,part:[2,6,7,19],partial:0,particularli:0,pasp:2,pass:[6,9,11,13,15,16],path:[5,9,11,14,15],patho:[11,15],pdf:[0,2,11,15],pend:0,per:[0,5,7,9,14,19],peret:0,perform:0,perhap:0,periastron:0,pericent:19,period:[0,2,6,13,14,19],perl:1,person:[],pgo:0,phase:0,phasevol:0,photoevapor:0,php:2,physic:14,pick:13,piec:[6,7],pinnsonneault:0,pip:[],pisn:0,pkg:[11,15],place:[],placehold:13,plai:0,plan:9,pleas:[0,5],plot:[6,13],plot_funct:[11,12],plot_hr_diagram:13,plot_hr_diagram_singl:13,plot_mass:13,plot_orbit:13,plot_system:13,plot_typ:13,pls:7,plu:0,pms:13,pms_mass_1:13,pms_mass_2:13,pogg:0,point:[0,2,5,11,15],pol:0,polytrop:0,popuation_id:9,popul:[0,2,7,8,10,11,17],population_set:7,posit:[0,2],possibl:[0,1,2,5,8,11,15],post:0,post_sn_orbit_bs:0,post_sn_orbit_method:0,post_sn_orbit_tt98:0,postagb_legacy_log:0,potenti:0,power:[0,2],powerlaw:2,powerlaw_const:2,ppisn:0,ppisn_dis:0,ppisn_farmer19:0,ppisn_prescript:0,pre:[0,13],pre_main_sequ:0,pre_main_sequence_fit_lob:0,precis:5,precod:[7,14],predefin:2,predictor:0,prefer:[0,7],prefix:0,preload:13,prepar:2,prepare_dict:2,prescript:0,present:[2,5,7,14],preserv:0,preset:13,pressur:0,prevent:0,previou:5,previous_stardata:1,primari:[1,2,7,14,19],print:[5,6,8,9,14],print_help:5,print_info:8,print_structur:5,printf:[1,6,14],prior:0,privat:[7,8,11],probabl:[0,1,2,7,8,9,14],probdist:[7,14],problabl:13,process:[0,5,6,7,9],progenitor:0,program:[11,15],project:0,proper:8,properli:0,properti:[0,5,9,13],provid:[0,2,7,9,14,16],pseudorandom:0,puls:[0,19],pulsat:0,pump:0,purpos:[9,13],put:[1,5,6,9,13,14],pyenv:[11,15],pytest:[11,15],python3:[6,11,15],python:[5,6],python_api_test:[],pythonpath:[],qcrit_bh:0,qcrit_cheb:0,qcrit_cowd:0,qcrit_degenerate_bh:0,qcrit_degenerate_cheb:0,qcrit_degenerate_cowd:0,qcrit_degenerate_eagb:0,qcrit_degenerate_gb:0,qcrit_degenerate_hegb:0,qcrit_degenerate_hehg:0,qcrit_degenerate_hem:0,qcrit_degenerate_hewd:0,qcrit_degenerate_hg:0,qcrit_degenerate_lmm:0,qcrit_degenerate_m:0,qcrit_degenerate_n:0,qcrit_degenerate_onewd:0,qcrit_degenerate_tpagb:0,qcrit_eagb:0,qcrit_gb:0,qcrit_gb_bs:0,qcrit_gb_chen_han_formula:0,qcrit_gb_chen_han_t:0,qcrit_gb_ge2015:0,qcrit_gb_hjellming_webbink:0,qcrit_gb_q_no_comenv:0,qcrit_gb_vos2018:0,qcrit_hegb:0,qcrit_hehg:0,qcrit_hem:0,qcrit_hewd:0,qcrit_hg:0,qcrit_lmm:0,qcrit_m:0,qcrit_n:0,qcrit_onewd:0,qcrit_tpagb:0,qcrits_:0,qcrits_degenerate_:0,quadrat:0,quadrulpl:0,quadrupl:0,quantiti:13,quit:[0,5],r_l:19,radi:0,radiat:0,radii:[0,19],radiu:[0,1,13,14,19],radius_1:13,radius_2:13,ragb:19,raghavan2010_binary_fract:2,raghavan:2,rai:0,railton:0,rais:[0,5,9,14],ram:0,random:[0,9],random_se:0,random_skip:0,random_system:0,random_systems_se:0,rang:[0,2,7,17],rapidli:0,rappaport:0,rate:[0,2],rather:[0,5,7,9],ratio:[0,2,14,19],raw:[5,6,7,13,16],raw_output:5,reaction:0,read:5,real:7,realli:[0,7,8,9],reason:0,rebuild:[11,15],rebuilt:[11,15],recalcul:0,reciev:5,recombin:0,recommend:[1,7],recompil:[11,15],recurs:[5,7],red:0,redhat:1,redshift:2,reduc:0,reduct:9,regardless:13,region:0,reimer:0,reject:0,rejuven:0,rel:0,relat:0,remain:0,remnant:0,remov:[0,5,7],remove_fil:5,repeat:[0,9],repo:[11,15],report:0,represent:[5,7],reproduc:0,requir:[0,5,6,13,14,16],reset:0,reset_pref:0,reset_star:0,reset_stars_default:0,resolut:[0,7,14],resolv:0,reson:0,respect:[0,2],rest:7,restructuredtext:5,result:[0,1,2,5,6,7,9,11,14,15],result_example_head:6,result_example_header_1:6,result_example_header_2:6,retain:0,rethink:5,return_all_info:7,return_binary_c_version_info:[5,7],return_compilation_dict:1,return_help_al:5,return_minimum_orbit_for_rlof:19,return_population_set:7,return_version_info:5,revap_in:0,revap_out:0,revers:[0,13],reverse_tim:0,revis:[0,5],rewrit:7,ri0005:[],rich:0,riello:0,rin:0,ring:0,risk:7,ritter:0,rk2:0,rk4:0,rlof:[0,19],rlof_angular_momentum_transfer_model:0,rlof_angular_momentum_transfer_model_bs:0,rlof_angular_momentum_transfer_model_conserv:0,rlof_eccentric_as_circular:0,rlof_entry_threshold:0,rlof_f:0,rlof_interpolation_binary_c:0,rlof_interpolation_bs:0,rlof_interpolation_method:0,rlof_mdot_factor:0,rlof_mdot_modul:0,rlof_method:0,rlof_method_adapt:0,rlof_method_adaptive2:0,rlof_method_bs:0,rlof_method_claei:0,rlof_method_ritt:0,rlof_nonconservative_gamma_donor:0,rlof_nonconservative_gamma_isotrop:0,rlof_radiation_correct:0,rob:[0,2,19],robert:[11,15],roch:[0,19],roche_lob:19,rochelob:19,room:7,root:[11,15],rotat:[0,2],rotation:0,rotationally_enhanced_expon:0,rotationally_enhanced_mass_loss:0,rotationally_enhanced_massloss:0,rotationally_enhnaced_massloss_angmom:0,rotationally_enhnaced_massloss_langer_formula:0,rotationally_enhnaced_massloss_langer_formula_and_angmom:0,rotationally_enhnaced_massloss_non:0,rout:0,routin:[0,6,7,13],row:13,rring:0,rssd:2,rst:[5,8],rsun:13,run:[0,1,5,6,7,9,11,14,15,16],run_example_binari:6,run_example_binary_with_custom_log:6,run_example_binary_with_run_system:6,run_example_binary_with_writing_logfil:6,run_example_custom_logging_autogener:6,run_system:[6,13,16],run_system_wrapp:[6,11,12],runtim:[1,9],russel:0,rzam:19,sai:0,said:0,same:[0,5,6,11,14,15],sampl:[0,2,7,17],sana12:[2,14],sana:2,save:[1,2,14],scalo:2,scanf:0,scene:6,scheme:0,schneider:0,schroeder:0,script:[3,6,11,15],sdb:0,sdist:[11,15],sdo:0,search:11,second:[0,2,5,13],secondari:[2,19],section:[2,5,10,11,15],see:[0,6,7,11,13,15],seed:0,seem:[11,13,15],segment:17,seitenzahl2013_model:0,seitenzahl:0,select:[0,5,6],selected_head:[5,6],self:[7,9,14],semi:0,sent:0,sentenc:1,sep:[2,6,7,14,19],sep_max:14,sep_min:14,separ:[0,2,5,6,13,14,19],separation_quadrupl:0,separation_tripl:0,separta:0,seper:[7,8,14],sequenc:0,seri:0,serial:5,serializ:7,serv:[5,6,14],server:7,set:[0,1,2,5,7,8,9,11,13,14,15],set_opt:2,settingsfil:5,setup:[11,15,16],sever:[6,8,9,13,16],sfh:2,shara:0,share:[1,6,9,16],shared_lib_filenam:6,shim:[],should:[0,1,6,8,9,11,13,14,15,16],shouldn:[0,5],show:[3,9,13],show_plot:13,show_stellar_typ:13,shown:13,siess:0,sigma:2,silent:5,sill:0,simpl:14,simpli:0,simul:[0,1,14],simulation_:7,sinc:[5,13,14],singl:[0,2,7,13,14],skip:0,skipkei:5,sliced_df:6,slope:2,slow:0,slurm:[7,9,10],slurm_grid:7,small:0,small_envelope_method:0,small_envelope_method_bs:0,small_envelope_method_miller_bertolami:0,smaller:0,sn_impulse_liu2015:0,sn_impulse_non:0,sn_impulse_wheeler1975:0,sn_kick_companion_a:0,sn_kick_companion_aic_bh:0,sn_kick_companion_bh_bh:0,sn_kick_companion_bh_n:0,sn_kick_companion_ecap:0,sn_kick_companion_grb_collapsar:0,sn_kick_companion_hestaria:0,sn_kick_companion_ia_chand:0,sn_kick_companion_ia_chand_co:0,sn_kick_companion_ia_eld:0,sn_kick_companion_ia_h:0,sn_kick_companion_ia_he_co:0,sn_kick_companion_ia_hybrid_hecowd:0,sn_kick_companion_ia_hybrid_hecowd_sublumin:0,sn_kick_companion_ibc:0,sn_kick_companion_ii:0,sn_kick_companion_iia:0,sn_kick_companion_ns_n:0,sn_kick_companion_tz:0,sn_kick_companion_wdkick:0,sn_kick_dispersion_aic_bh:0,sn_kick_dispersion_bh_bh:0,sn_kick_dispersion_bh_n:0,sn_kick_dispersion_ecap:0,sn_kick_dispersion_grb_collapsar:0,sn_kick_dispersion_ia_hybrid_hecowd:0,sn_kick_dispersion_ia_hybrid_hecowd_sublumin:0,sn_kick_dispersion_ibc:0,sn_kick_dispersion_ii:0,sn_kick_dispersion_ns_n:0,sn_kick_dispersion_tz:0,sn_kick_distribution_aic_bh:0,sn_kick_distribution_bh_bh:0,sn_kick_distribution_bh_n:0,sn_kick_distribution_ecap:0,sn_kick_distribution_grb_collapsar:0,sn_kick_distribution_ia_hybrid_hecowd:0,sn_kick_distribution_ia_hybrid_hecowd_sublumin:0,sn_kick_distribution_ibc:0,sn_kick_distribution_ii:0,sn_kick_distribution_ns_n:0,sn_kick_distribution_tz:0,sneia:0,snia:0,solar:[0,19],solarmass:2,solver:0,solver_forward_eul:0,solver_predictor_corrector:0,solver_rk2:0,solver_rk4:0,some:[0,1,2,6,7,9,11,13,14,15],someth:[0,7],soon:17,sort:5,sort_kei:5,sourc:[1,2,3,5,6,7,8,9,12,13,14,16,17,19],source_file_filenam:9,source_list:7,sourcecod:[11,15],sourcefile_nam:1,space:[0,7,17],spacing_funct:[11,12],spacingfunc:[7,14],spacingfunct:7,special:0,specif:[0,5,13],specifi:[0,9],spectral:2,speed:[0,9],speedtest:0,spheric:0,spin:0,split:[0,9,14],splitpoint:0,spread:7,src:[11,15],st1:6,st2:6,stabil:0,stabl:0,stack:[],stackoverflow:[],stancliff:0,standard:[0,2],star:[1,2,6,7,9,11,13,14,19],stardata:[0,1,6,14],stardata_dump_filenam:0,stardata_load_filenam:0,start:[0,1,5,6,8,9],start_tim:0,state:0,statement:[1,6],statist:0,statu:[0,1],steadi:0,stefan:13,stellar:[0,13,18],stellar_structure_algorithm:0,stellar_structure_algorithm_external_funct:0,stellar_structure_algorithm_mint:0,stellar_structure_algorithm_modified_bs:0,stellar_structure_algorithm_non:0,stellar_typ:[1,11,12,13,14],stellar_type_1:[0,13],stellar_type_2:[0,13],stellar_type_3:0,stellar_type_4:0,stellar_type_dict:18,stellar_type_dict_short:18,step:[13,17],still:[1,9],stop:0,storag:0,store:[0,2,7,9,19],store_memaddr:19,str:[1,5,7,8,13],straight:7,straniero:0,strength:0,strict:5,string:[0,1,5,7,8,9,13,16],strip:0,stronger:0,struct:0,structur:[0,5,9,13],stuff:[2,5,9,13,14],style:0,sub:0,subdirectori:5,subject:0,sublumin:0,subroutin:10,subsequ:0,succe:0,suggest:[0,11,15],sum:0,supercrit:0,supernova:[0,9],superwind:0,superwind_mira_switchon:0,supress:14,sure:[2,7,9,11,13,15,16],surfac:0,surrei:[],surviv:0,survivor:0,svg:[11,15],symmetr:0,synchron:0,synonym:0,sys:6,system:[0,6,7,9,11,13,14,15,16],system_gener:7,t_re:6,tabl:[0,2],take:[0,2,5,6,7,9,14,16],taken:0,tar:[11,15],target:[1,8,11,15],task:[0,2,5,6,7,8,10,13,16,17,19],tauri:0,tbse:0,teff:2,teff_1:13,teff_2:13,temp_dir:[5,14],temperatur:[0,2,13],tempfil:6,termin:[1,11,15],test:[0,5,7],test_log:6,test_pop:14,text:[5,8,11,15],than:[0,2,5,9,11,15],thats:[0,14],thei:[0,2,7,13],thelog:0,them:[5,6,7,14],themselv:[2,5],theres:7,thermal:[0,2,19],thermally_pulsing_asymptotic_giant_branch:0,thermohalin:0,thesi:0,thi:[0,1,2,3,5,6,7,8,9,11,12,13,14,15,16,17,19],thick:0,thick_disc_end_ag:0,thick_disc_logg_max:0,thick_disc_logg_min:0,thick_disc_start_ag:0,thin:0,thing:[2,5,6,7,8,14,16],think:[0,5,7],third:[0,2],third_dup:0,third_dup_multipli:0,thorn:0,those:[5,6,7,11,14,15],thread:9,thread_id:9,three:[0,2],three_part_powerlaw:[2,14],threshold:[5,9],through:[7,13,16],throughout:7,tidal:0,tidal_strength_factor:0,tide:0,time:[0,1,2,5,6,7,9,13,14],timescal:0,timestamp:9,timestep:0,timestep_limit:0,timestep_log:0,timestep_modul:0,timestep_multipli:0,timestep_solver_factor:0,tinslei:2,tmp:[0,5,11,15],tmp_dir:[7,9],todo:[0,1,2,5,7,8,9,13,14,16,17,19],toler:0,too:[0,11,15,16],topic:0,torqu:0,total:[0,7,9,13],tout:[0,19],tpagb:0,tpagb_reimers_eta:0,tpagb_wind_beasor_etal_2020:0,tpagb_wind_bloeck:0,tpagb_wind_goldman_etal_2017:0,tpagb_wind_mattsson:0,tpagb_wind_reim:0,tpagb_wind_rob_cwind:0,tpagb_wind_van_loon:0,tpagb_wind_vw93_karaka:0,tpagb_wind_vw93_karakas_carbon_star:0,tpagb_wind_vw93_orig:0,tpagb_wind_vw93_orig_carbon_star:0,tpagbwind:0,tpagbwindfac:0,track:[9,13],trade:0,transfer:0,transform:[0,5],treat:0,trigger:0,tripl:0,tru:5,truli:0,tupl:1,turn:[0,5,14],two:[0,5,18,19],txt:[6,7,16],type:[0,1,2,5,7,8,9,13,17,18,19],type_ia_mch_supernova_algorithm:0,type_ia_mch_supernova_algorithm_dd2:0,type_ia_mch_supernova_algorithm_seitenzahl2013:0,type_ia_mch_supernova_algorithm_seitenzahl2013_automat:0,type_ia_sub_mch_supernova_algorithm:0,type_ia_sub_mch_supernova_algorithm_livne_arnett_1995:0,typic:0,ubvri:0,ugriv:0,uncom:7,under:17,undergo:0,underli:[],understand:7,undescrib:8,uniform:2,union:[2,5,17,19],uniqu:9,unit:[0,19],univari:0,unknown:16,unless:[1,7,9],unload:7,unrecogn:[11,15],unsign:0,until:[0,2],unus:[0,9],updat:[2,7,11,14,15],upper:[0,2,17],usag:0,use:[0,2,5,6,7,9,10,11,13,14,15,16],use_astropy_valu:13,use_datadir:[7,14],use_fixed_timestep_:0,use_periastron_roche_radiu:0,use_tabular_intershell_abundances_karakas_2012:0,used:[0,1,2,5,7,9,13,14],useful:[0,5,7,9,16,19],useful_func:[11,12],user:[1,2,5,7,8,9,16],uses:[0,6,14],using:[0,1,3,6,7,11,14,15],usr:6,usual:[0,2,9],util:[1,2,5,6,7,8,13,14,16,17,19],val:2,valid:[0,2,5],valu:[0,1,2,5,6,7,8,9,13,14],valueerror:14,valuerang:[7,14],van:0,vandenheuvel_log:0,vari:0,variabl:[0,5,7,9,14],variant:0,variou:0,vassiliadi:0,veloc:[0,2],verbos:[1,5,9,11,14,15],verbose_print:5,veri:[0,6,7,14,17],versa:19,version:[0,5,7,11,15],version_info:5,version_info_str:5,version_onli:0,via:[7,9,13,14],vice:19,vink:0,virtual:[11,15],virtualenviron:[11,15],viscos:0,viscou:0,volum:0,vrot1:0,vrot2:0,vrot3:0,vrot4:0,vrot_breakup:0,vrot_bs:0,vrot_non_rot:0,vrot_sync:0,vw93:0,vw93_eagb_wind_spe:0,vw93_mira_shift:0,vw93_multipli:0,vw93_tpagb_wind_spe:0,vwind_multipli:0,wai:[0,3,5,7,9,13,14],wang:0,want:[0,2,5,6,8,9,13,14],warmup_cpu:0,warn:[0,7],wave:0,wd_accretion_rate_new_giant_envelope_lower_limit_helium_donor:0,wd_accretion_rate_new_giant_envelope_lower_limit_hydrogen_donor:0,wd_accretion_rate_new_giant_envelope_lower_limit_other_donor:0,wd_accretion_rate_novae_upper_limit_helium_donor:0,wd_accretion_rate_novae_upper_limit_hydrogen_donor:0,wd_accretion_rate_novae_upper_limit_other_donor:0,wd_kick:0,wd_kick_at_every_puls:0,wd_kick_at_given_puls:0,wd_kick_direct:0,wd_kick_end_agb:0,wd_kick_first_rlof:0,wd_kick_pulse_numb:0,wd_kick_when:0,wd_sigma:0,wdwd_merger_algorithm:0,wdwd_merger_algorithm_bs:0,wdwd_merger_algorithm_chen2016:0,wdwd_merger_algorithm_perets2019:0,weight:[0,9],well:[0,5,9,11,15],were:5,what:[0,1,2,5,6,7,8,11,14,15,16],whatev:[6,7,11,15],wheeler:0,when:[0,1,5,6,7,8,9,11,14,15,16],where:[0,1,2,5,7,8,9],whether:[0,2,5,7,8,9,13,19],which:[0,1,2,3,5,6,7,8,9,11,14,15,16,19],white:0,white_dwarf_cooling_carrasco2014:0,white_dwarf_cooling_mestel:0,white_dwarf_cooling_mestel_modifi:0,white_dwarf_cooling_model:0,white_dwarf_radius_carrasco2014:0,white_dwarf_radius_model:0,white_dwarf_radius_mu:0,white_dwarf_radius_nauenberg1972:0,whole:7,width:0,wind:0,wind_algorithm_binary_c_2020:0,wind_algorithm_hurley2002:0,wind_algorithm_non:0,wind_algorithm_schneider2018:0,wind_angmom_loss_bs:0,wind_angmom_loss_lw:0,wind_angmom_loss_lw_hybrid:0,wind_angmom_loss_spherically_symmetr:0,wind_angular_momentum_loss:0,wind_disc_angmom_fract:0,wind_disc_mass_fract:0,wind_djorb_fac:0,wind_gas_to_dust_ratio:0,wind_mass_loss:0,wind_multiplier_:0,within:[0,5,7,11,15],without:[2,7],won:0,wood:0,wooslei:0,work:[0,5,6,11,13,14,15],would:[0,5,13],wouldnt:7,wr_wind:0,wr_wind_bs:0,wr_wind_eldridg:0,wr_wind_fac:0,wr_wind_maeder_meynet:0,wr_wind_nugis_lam:0,wrap:[1,14],wrapper:[5,6,19],write:[1,5,6,7,8,9,14,16],write_binary_c_calls_to_fil:7,write_binary_c_parameter_descriptions_to_rst_fil:5,write_grid_options_to_rst_fil:8,written:[6,7,8,9,14,16],wrlof_mass_transf:0,wrlof_method:0,wrlof_non:0,wrlof_q_depend:0,wrlof_quadrat:0,wrong:[11,15],wrt:1,wrwindfac:0,wtts2:0,wtts_log:0,www:[0,2],year:[0,2],yet:[0,5,6,7,9,13,14],yield:0,you:[0,1,5,6,7,8,9,11,13,14,15,19],young:0,your:[6,11,15],yourself:[13,14],zam:[2,16,19],zams_collis:19,zams_mass:14,zero:[0,1],zero_ag:14,zone:0,zoom:0,zoomfac_multiplier_decreas:0,zoomfac_multiplier_increas:0,zshrc:[],zsolar:2,zytkow:0},titles:["Binary_c parameters","custom_logging_functions module","distribution_functions module","Examples","<no title>","functions module","Examples","grid_class module","Grid options and descriptions","Population grid code options","hpc_functions module","Welcome to binary_c-python\u2019s documentation!","Binarycpython code","plot_functions module","Example of population script","Python module for binary_c","run_system_wrapper module","spacing_functions module","stellar_types module","useful_funcs module"],titleterms:{"function":5,"public":9,algorithm:0,binari:0,binary_c:[0,11,15],binarycpython:12,build:[11,15],code:[9,12],custom_logging_funct:1,descript:8,distribution_funct:2,document:[11,15],environ:[11,15],exampl:[3,6,11,14,15],faq:[11,15],from:[11,15],grid:[8,9],grid_class:7,hpc_function:10,indic:11,input:0,instal:[11,15],instruct:[11,15],issu:[11,15],misc:0,modul:[1,2,5,7,10,11,13,15,16,17,18,19],note:[11,15],nucsyn:0,option:[8,9],output:0,paramet:0,pip:[11,15],plot_funct:13,popul:[9,14],privat:9,python:[11,15],requir:[11,15],run_system_wrapp:16,script:14,section:0,sourc:[11,15],spacing_funct:17,star:0,stellar_typ:18,tabl:11,usag:[11,15],useful_func:19,variabl:[11,15],via:[11,15],welcom:11}}) \ No newline at end of file diff --git a/docs/build/html/spacing_functions.html b/docs/build/html/spacing_functions.html index 0aac247b138c0368c4ff7667efd99fc3f94224d1..413f97cc3711d94428c93f2b259c18b3220be459 100644 --- a/docs/build/html/spacing_functions.html +++ b/docs/build/html/spacing_functions.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</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="distribution_functions.html">distribution_functions module</a></li> @@ -102,6 +104,7 @@ <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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/stellar_types.html b/docs/build/html/stellar_types.html index 51edae1c16d4afbf8d91ea328e5351ee23e0a1bb..8bad676f5f5901ff4224fff3907968874d2b0691 100644 --- a/docs/build/html/stellar_types.html +++ b/docs/build/html/stellar_types.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</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="distribution_functions.html">distribution_functions module</a></li> @@ -102,6 +104,7 @@ <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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/build/html/useful_funcs.html b/docs/build/html/useful_funcs.html index aca941bd7dd59de07727620ec3a2e58f9a6b2787..00e6b4444d8bd0497c57b57ae1a495e8545045a4 100644 --- a/docs/build/html/useful_funcs.html +++ b/docs/build/html/useful_funcs.html @@ -85,6 +85,8 @@ <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="readme_link.html#installation-via-pip">Installation via PIP:</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme_link.html#installation-from-source">Installation from source:</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="distribution_functions.html">distribution_functions module</a></li> @@ -102,6 +104,7 @@ <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="Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.">Test hyperlink: `Stack Overflow <http://stackoverflow.com/>`_.</a></li> </ul> diff --git a/docs/source/grid_options_descriptions.rst b/docs/source/grid_options_descriptions.rst index 0f948ea04cddcd472441000f45fd2de48011ee71..7c1c75c4f19882a77b78468b995bc5dd9594dac9 100644 --- a/docs/source/grid_options_descriptions.rst +++ b/docs/source/grid_options_descriptions.rst @@ -23,8 +23,6 @@ The following options are meant to be changed by the user. | **custom_logging_func_memaddr**: Memory adress where the custom_logging_function is stored. Input: int -| **ensemble_results**: Dictinary that stores the ensemble results if combine_ensemble_with_thread_joining==True - | **evolution_type**: Variable containing the type of evolution used of the grid. Multiprocessing or linear processing | **failed_systems_threshold**: Variable storing the maximum amount of systems that are allowed to fail before logging their commandline arguments to failed_systems log files @@ -45,8 +43,6 @@ The following options are meant to be changed by the user. | **repeat**: Factor of how many times a system should be repeated. Consider the evolution splitting binary_c argument for supernovae kick repeating. -| **results**: Dictionary in which the user can place their results. This dictionary gets merged at the end of a mulitprocessing simulation. - | **slurm**: Int flag whether to use a slurm type population evolution. | **source_file_filename**: Variable containing the source file containing lines of binary_c commandline calls. These all have to start with binary_c. diff --git a/docs/source/index.rst b/docs/source/index.rst index bf0ccf76e20c9344a43d7345dd40a3d377bc2f68..d1f22839883a98a5815066ce6532ee7f488fc72e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -5,6 +5,8 @@ Welcome to binary_c-python's documentation! =========================================== +.. mdinclude:: ../../README.md + .. toctree:: :maxdepth: 2 @@ -15,11 +17,12 @@ Welcome to binary_c-python's documentation! examples binary_c_parameters grid_options_descriptions - - + GitLab <https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python> + Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` +