Merge pull request #239 from brown-ccv/238-notebooks-for-colab

Add notebook and colab badge in README.md
brown-ccv · Jun 6, 2023 · 65475f0 · 65475f0
2 parents 0eb6ea9 + 62ab5f4
commit 65475f0
Show file tree

Hide file tree

Showing 6 changed files with 397 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,7 +2,6 @@
 [![][docs-stable-img]][docs-stable-url]
 [![][docs-dev-img]][docs-dev-url]
 
-
 # Chamber.jl
 `Chamber.jl` is a Julia package for simulating the eruption of a volcano using a model for the frequency of eruptions of upper crustal magma chambers based on Degruyter and Huber (2014). The package generates a CSV file and figures with the solution data for various variables over time.
 
@@ -114,6 +113,9 @@ julia> chamber(composition, end_time, log_volume_km3, InitialConc_H2O, InitialCo
 ```
 The output directory specified by `output_dirname` contains the generated files.
 
+## Notebook for Google Colaboratory
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/brown-ccv/Chamber.jl/blob/master/notebooks/notebook_for_chamber.ipynb)
+
 ## API Documentation
 
 API documentation for Chamber.jl can be found [here][docs-stable-url].

diff --git a/notebooks/images/instructions_1.png b/notebooks/images/instructions_1.png
diff --git a/notebooks/images/instructions_2.png b/notebooks/images/instructions_2.png
diff --git a/notebooks/images/instructions_3.png b/notebooks/images/instructions_3.png
diff --git a/notebooks/images/instructions_4.png b/notebooks/images/instructions_4.png
diff --git a/notebooks/notebook_for_chamber.ipynb b/notebooks/notebook_for_chamber.ipynb