diff --git a/README.md b/README.md index b7750e92..28d01e49 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ -# IOOS demonstrations and examples notebooks +# IOOS CodeLab + +The [IOOS CodeLab](https://ioos.github.io/ioos_code_lab) is a collection of tutorials and examples of how to access and +utilize the many IOOS technologies and data sources available. This site is geared towards scientists and environmental +managers interested in “diving deep” into the numbers and creating original plots and data analysis. Most notebook +examples are written in Python, however, we also have a growing number of notebooks written in Matlab, and R. See the rendered version at https://ioos.github.io/ioos_code_lab @@ -10,3 +15,55 @@ To suggest a notebook or ask questions please open an issue at: https://github.c ## Citation [![DOI](https://zenodo.org/badge/399546690.svg)](https://zenodo.org/badge/latestdoi/399546690) + +---- +## Build the JupyterBook locally +### Resources: +* Jupyter-book command line interface: https://jupyterbook.org/basics/build.html + +### Requirements: + +* Git: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git +* Jupyter{Book}: https://jupyterbook.org/intro.html +* Web Browser + +### Installation +Install jupyter-book: +``` +conda install jupyter-book +``` +Clone the [ioos_code_lab](https://github.com/ioos/ioos_code_lab) repository. +``` +git clone https://github.com/ioos/ioos_code_lab.git +``` +Once you have cloned the repository, you have all the required notebooks cloned onto your system +(in the `/jupyterbook/content` directory). + +### Build the JupyterBook +Run the following command to build the JupyterBook. +``` +jupyter-book build jupyterbook/ +``` +The command should be run relative to the `jupyterbook/` directory. + +If you are in the `jupyterbook/` directory, you can build the book using +``` +juyter-book build . +``` + +### View the built JupyterBook +Your book's HTML pages are here: +``` +jupyterbook\_build\html\ +``` +You can look at your book by opening this file in a browser: +``` +jupyterbook\_build\html\index.html +``` +Or, use the full link displayed in the terminal to view the website. + +### Clean up the book's generated files +To entirely remove the folders in the `_build/` directory: +``` +jupyter-book clean jupyterbook/ --all +``` \ No newline at end of file