From 68d4065121ed563c7de2485aa3c1fa4f123f3d5f Mon Sep 17 00:00:00 2001
From: David Hendriks <davidhendriks93@gmail.com>
Date: Mon, 9 Aug 2021 13:29:29 +0100
Subject: [PATCH] fixed the examples, broadly. can definitely use updates
---
examples/notebook_api_functionality.ipynb | 2 +-
examples/notebook_custom_logging.ipynb | 2 +-
examples/notebook_extra_features.ipynb | 13 ++++++++++++-
examples/notebook_individual_systems.ipynb | 2 +-
examples/notebook_population.ipynb | 4 ++--
5 files changed, 17 insertions(+), 6 deletions(-)
diff --git a/examples/notebook_api_functionality.ipynb b/examples/notebook_api_functionality.ipynb
index 00654c720..d81c31711 100644
--- a/examples/notebook_api_functionality.ipynb
+++ b/examples/notebook_api_functionality.ipynb
@@ -5,7 +5,7 @@
"id": "cb9d00f5-9613-471e-a4bb-6181311bf73b",
"metadata": {},
"source": [
- "# Notebook API functionality\n",
+ "# Using the API functionality of binarycpython\n",
"This notebook shows how to use the API functions that interface with binary_c. It usually is better to use wrapper functions that internally use these API functions, because most of the output here is very raw\n",
"\n",
"Binarycpython uses the Python-C extension framework to interface Python with C. The sourcecode for this is contained in `src/binary_c_python.c`, and the functions are available via `from binarycpython import _binary_c_bindings`.\n",
diff --git a/examples/notebook_custom_logging.ipynb b/examples/notebook_custom_logging.ipynb
index e84895375..05ffbccfc 100644
--- a/examples/notebook_custom_logging.ipynb
+++ b/examples/notebook_custom_logging.ipynb
@@ -5,7 +5,7 @@
"id": "879b596b-d70c-4f90-b668-563b4ad93ffc",
"metadata": {},
"source": [
- "# Notebook custom logging\n",
+ "# Using custom logging routines with binarycpython\n",
"In this notebook you'll learn how to use the custom logging functionality"
]
},
diff --git a/examples/notebook_extra_features.ipynb b/examples/notebook_extra_features.ipynb
index 4827ad5e2..d453a6f5b 100644
--- a/examples/notebook_extra_features.ipynb
+++ b/examples/notebook_extra_features.ipynb
@@ -1,9 +1,20 @@
{
"cells": [
+ {
+ "cell_type": "markdown",
+ "id": "d5c04b77-f0be-4b33-8c03-c72eb846527c",
+ "metadata": {},
+ "source": [
+ "# Extra features and functionality of binarycpython\n",
+ "In this notebook we'll go over some of the extra features and functionality that was not covered in the other notebooks.\n",
+ "\n",
+ "TODO"
+ ]
+ },
{
"cell_type": "code",
"execution_count": null,
- "id": "1e1f31c5-dfa0-43a9-8505-3e1b279b7f2e",
+ "id": "0020f1bc-2a23-455c-8216-9e63e6e038ae",
"metadata": {},
"outputs": [],
"source": []
diff --git a/examples/notebook_individual_systems.ipynb b/examples/notebook_individual_systems.ipynb
index 887dacd03..19c2d29fb 100644
--- a/examples/notebook_individual_systems.ipynb
+++ b/examples/notebook_individual_systems.ipynb
@@ -5,7 +5,7 @@
"id": "a544d28c-c2e1-4c6a-b55b-8caec440743f",
"metadata": {},
"source": [
- "# Notebook individual system\n",
+ "# Running individual systems with binarycpython\n",
"This notebook will show you how to run single systems and analyze their results.\n",
"\n",
"It can be useful to have some functions to quickly run a single system to e.g. inspect what evolutionary steps a specific system goes through, to plot the mass loss evolution of a single star, etc. "
diff --git a/examples/notebook_population.ipynb b/examples/notebook_population.ipynb
index 46f5cef96..56f3b153c 100644
--- a/examples/notebook_population.ipynb
+++ b/examples/notebook_population.ipynb
@@ -5,7 +5,7 @@
"id": "bbbaafbb-fd7d-4b73-a970-93506ba35d71",
"metadata": {},
"source": [
- "# Setting up populations\n",
+ "# Running populations with binarycpython\n",
"This notebook will show you how to evolve a population of stars\n",
"\n",
"Much of the code in the binarycpython package is written to evolve a population of stars through the Population object, rather than running a single system. Let's go through the functionality of this object step by step and set up some example populations. \n",
@@ -715,7 +715,7 @@
"id": "60359eb1-4d0c-4d2d-8265-ec5171b944a2",
"metadata": {},
"source": [
- "# Full example Population of single stars\n",
+ "## Full examples of population scripts\n",
"Below is a full setup for a population of single stars"
]
},
--
GitLab