Merge pull request #997 from TeamCOMPAS/move_ipynb_to_docs

move ipynb to docs
TeamCOMPAS · Oct 27, 2023 · f563517 · f563517
2 parents a299571 + cd3c449
commit f563517
Show file tree

Hide file tree

Showing 25 changed files with 121 additions and 197 deletions.
diff --git a/...plots/detailed_evolution/runSubmitDemo.py → ...plots/detailed_evolution/runSubmitDemo.py b/...plots/detailed_evolution/runSubmitDemo.py → ...plots/detailed_evolution/runSubmitDemo.py
diff --git a/online-docs/Makefile b/online-docs/Makefile
@@ -18,7 +18,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-  mkdir -p notebooks
-	cp ../utils/examples/*.ipynb notebooks/
-	cp ../utils/Tutorial/Tutorial_reproduce_CHE_paper_teaching_demo_example/*.ipynb notebooks/
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/online-docs/notebooks/Overview.ipynb b/online-docs/notebooks/Overview.ipynb
diff --git a/online-docs/notebooks/SFRD_cartoon.png b/online-docs/notebooks/SFRD_cartoon.png
diff --git a/online-docs/notebooks/media/COMPASlogo.png b/online-docs/notebooks/media/COMPASlogo.png
diff --git a/...ing_demo_example/CHE_evolution_demo.ipynb → ...E_paper_tutorial/CHE_evolution_demo.ipynb b/...ing_demo_example/CHE_evolution_demo.ipynb → ...E_paper_tutorial/CHE_evolution_demo.ipynb
diff --git a/..._example/CHE_evolution_demo_ANSWERS.ipynb → ...tutorial/CHE_evolution_demo_ANSWERS.ipynb b/..._example/CHE_evolution_demo_ANSWERS.ipynb → ...tutorial/CHE_evolution_demo_ANSWERS.ipynb
@@ -5,7 +5,7 @@
    "id": "d69d65d0",
    "metadata": {},
    "source": [
-    "# COMPAS Special Tutorial: \"Formation channels of Gravitational Waves (GWs)\" -- ANSWERS\n",
+    "# Formation channels of Gravitational Waves (GWs)\n",
     "\n",
     "### This is a tutorial that can be used for live teaching/demos, it should fill about ~1hr of class\n",
     "    \n",
@@ -1050,7 +1050,7 @@
    "source": [
     "<div class=\"alert alert-block alert-danger\"> \n",
     "\n",
-    "# Answer 5 "
+    "## Answer 5"
    ]
   },
   {
@@ -1164,7 +1164,7 @@
    "source": [
     "<div class=\"alert alert-block alert-danger\"> \n",
     "\n",
-    "# Answer 6 \n",
+    "## Answer 6\n",
     "    \n",
     "    \n",
     "See the code below. The method is very similar to the Answer to question 5, but now we have to get the ZAMS properties through the systemParameters file. For which we have to use the np.in1d again to match the datapoints"
@@ -1324,7 +1324,7 @@
       "COMPAS_Documentation.pdf\r\n",
       "Rate_Infomu00.035_muz-0.23_alpha0.0_sigma00.39_sigmaz0.0.png\r\n",
       "SNR_Grid_IMRPhenomPv2_FD_all_noise.hdf5\r\n",
-      "\u001b[34m__pycache__\u001b[m\u001b[m\r\n",
+      "\u001B[34m__pycache__\u001B[m\u001B[m\r\n",
       "old_ClassCOMPAS.py\r\n",
       "old_FastCosmicIntegration.py\r\n",
       "old_selection_effects.py\r\n",
@@ -1367,7 +1367,7 @@
    "source": [
     "<div class=\"alert alert-block alert-danger\"> \n",
     "\n",
-    "# Answer 7 \n",
+    "## Answer 7\n",
     "    \n",
     "    \n",
     "The rates for CHE around redshift 0 are about 20 Gpc^-3 yr^-1 for the mixture model (note that we have to select either of the Wolf Rayet factors if we want to get an absolute rate for one fixed model. )\n",
@@ -1415,7 +1415,7 @@
    "source": [
     "<div class=\"alert alert-block alert-danger\"> \n",
     "\n",
-    "# Answer 8\n",
+    "## Answer 8\n",
     "    \n",
     "    \n",
     "Doing this for 'BBH' should give you a rate of about 100 Gpc^-3 yr^-1 which is right on the ballpark of the observations\n",
@@ -1534,7 +1534,7 @@
    "source": [
     " <div class=\"alert alert-block alert-info\">\n",
     " \n",
-    " # Extra material:"
+    " ## Extra material:"
    ]
   },
   {
@@ -1546,7 +1546,7 @@
     "\n",
     "\n",
     "\n",
-    "# Compact Object Mergers: Population Astrophysics & Statistics\n",
+    "## Compact Object Mergers: Population Astrophysics & Statistics\n",
     "\n",
     "[![Documentation](https://img.shields.io/badge/Documentation-latest-orange.svg?style=flat)](https://github.com/TeamCOMPAS/COMPAS/blob/Documentation/COMPAS_Documentation.pdf)\n",
     "\n",
@@ -1555,10 +1555,10 @@
     "adjustable.  COMPAS draws properties for a binary star system from a set of initial distributions, and evolves it from zero-age main sequence to the end of its life as two compact \n",
     "remnants.  It has been used for inference from observations of gravitational-wave mergers, Galactic neutron stars, X-ray binaries, and luminous red novae.\n",
     "\n",
-    "## Documentation\n",
+    "### Documentation\n",
     "https://compas.science/docs\n",
     "\n",
-    "## Contact\n",
+    "### Contact\n",
     "Please email your queries to [email protected]. You are also welcome to join the [COMPAS User Google Group](https://groups.google.com/forum/#!members/compas-user) to engage in discussions with COMPAS users and developers.\n",
     "\n",
     "\n",

diff --git a/...e/SNR_Grid_IMRPhenomPv2_FD_all_noise.hdf5 → ...l/SNR_Grid_IMRPhenomPv2_FD_all_noise.hdf5 b/...e/SNR_Grid_IMRPhenomPv2_FD_all_noise.hdf5 → ...l/SNR_Grid_IMRPhenomPv2_FD_all_noise.hdf5
diff --git a/..._teaching_demo_example/old_ClassCOMPAS.py → ...ing/CHE_paper_tutorial/old_ClassCOMPAS.py b/..._teaching_demo_example/old_ClassCOMPAS.py → ...ing/CHE_paper_tutorial/old_ClassCOMPAS.py
diff --git a/...demo_example/old_FastCosmicIntegration.py → ...per_tutorial/old_FastCosmicIntegration.py b/...demo_example/old_FastCosmicIntegration.py → ...per_tutorial/old_FastCosmicIntegration.py
diff --git a/...ing_demo_example/old_selection_effects.py → ...E_paper_tutorial/old_selection_effects.py b/...ing_demo_example/old_selection_effects.py → ...E_paper_tutorial/old_selection_effects.py
diff --git a/..._demo_example/old_totalMassEvolvedPerZ.py → ...aper_tutorial/old_totalMassEvolvedPerZ.py b/..._demo_example/old_totalMassEvolvedPerZ.py → ...aper_tutorial/old_totalMassEvolvedPerZ.py