Example notebooks

We have a set of notebooks that explain and show the usage of the binarycpython features. The notebooks are also stored in the examples/ directory in the repository

The order of the notebooks below is more or less the recommended order to read. The last couple of notebooks are example usecases

Contents:

• Tutorial: Running individual systems with binary_c-python
  • Single system with run_system_wrapper
  • Single system via population object
  • Single system via API functionality
• Tutorial: Using custom logging routines with binary_c-python
  • Usage
  • Examples of logging strings
• Tutorial: Running populations with binary_c-python
  • Setting up the Population object
  • Adding grid variables
  • Setting logging and handling the output
  • Evolving the grid
  • Noteworthy functionality
  • Full examples of population scripts
• Tutorial: Extra features and functionality of binary_c-python
  • getting extra information about binary_c parameters
  • Build information of binary_c
  • Example parse function
  • Dictionary modification
• Tutorial: Using the API functionality of binary_c-python
  • Example usage:
• Tutorial: Generating and handling ensemble data
  • How to generate ensemble data
  • How to handle ensemble data
• Example use case: Zero-age stellar luminosity function
  • Setting up the Population object
  • Adding grid variables
  • Setting logging and handling the output
  • Evolving the grid
  • ZAMS Luminosity distribution with the initial mass function
  • A better-sampled grid
• Example use case: Zero-age stellar luminosity function in binaries
  • Setting up the Population object
  • Setting logging and handling the output
  • Evolving the grid
• Example use case: Hertzsprung-Russell diagrams
  • Setting up the Population object
  • Stellar Grid
  • Setting logging and handling the output
  • Evolving the grid
  • Binary stars
• Example use case: Common-envelope evolution
  • Setting up the Population object
  • Stellar Grid
  • Logging and handling the output
  • Evolving the grid
• Example use case: Binary black hole systems
• Example use case: Solar system using the API functionality