jupyterbook

training/README.md

@@ -0,0 +1,49 @@
+<img src="bifacial_radiance.png" width="100">
+
+# bifacial_radiance Training 
+
+### Jupyter Book
+
+For in depth Tutorials you can run online, see our [jupyter-book](https://nrel.github.io/bifacial_radiance/intro.html)
+Clicking on the rocket-icon on the top allows you to launch the journals on [Google Colaboratory](https://colab.research.google.com/) for interactive mode.
+Just uncomment the first line `pip install ...`  to install the environment on each journal if you follow this mode.
+
+### Locally
+
+You can also run the tutorial locally with
+[miniconda](https://docs.conda.io/en/latest/miniconda.html) by following thes
+steps:
+
+1. Install [miniconda](https://docs.conda.io/en/latest/miniconda.html).
+
+1. Clone the repository:
+
+   ```
+   git clone https://github.com/NREL/bifacial_radiance.git
+   ```
+
+1. Create the environment and install the requirements. The repository includes
+   a `requirements.txt` file that contains a list the packages needed to run
+   this tutorial. To install them using conda run:
+
+   ```
+   conda create -n br_env jupyter -c conda-forge --file requirements.txt
+   conda activate br_env
+   ```
+
+   or you can install it with `pip install bifacial_radiance` as explained in the installation instructions into the environment.
+
+1. Start a Jupyter session:
+
+   ```
+   jupyter notebook
+   ```
+
+1. Use the file explorer in Jupyter lab to browse to `tutorials`
+   and start the first Tutorial.
+
+
+Documentation
+=============
+
+We also have documentation in [ReadTheDocs](https://bifacial-radiance.readthedocs.io) where you can find more details on the API functions.

training/_config.yml

@@ -0,0 +1,36 @@
+# Book settings
+# Learn more at https://jupyterbook.org/customize/config.html
+
+title: bifacial_radiance Training
+author: Silvana Ovaitt
+logo: bifacial_radiance.png
+
+# Force re-execution of notebooks on each build.
+# See https://jupyterbook.org/content/execute.html
+execute:
+  execute_notebooks: auto
+
+# Define the name of the latex output file for PDF builds
+latex:
+  latex_documents:
+    targetname: book.tex
+
+# Add a bibtex file so that we can create citations
+bibtex_bibfiles:
+  - references.bib
+
+# Information about where the book exists on the web
+repository:
+  url: https://github.com/NREL/bifacial_radiance
+  path_to_book: training  # Optional path to your book, relative to the repository root
+  branch: development
+
+# Add GitHub buttons to your book
+# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
+html:
+  use_issues_button: true
+  use_repository_button: true
+
+launch_buttons:
+  thebe: true
+  colab_url: "https://colab.research.google.com"

training/_toc.yml

@@ -0,0 +1,7 @@
+# Table of contents
+# Learn more at https://jupyterbook.org/customize/toc.html
+
+format: jb-book
+root: intro
+chapters:
+- file: tutorials/1 - Basic run

training/intro.md

@@ -0,0 +1,15 @@
+# Welcome to the interactive bifacial_radiance Training
+
+Here is a collection of Jupyter Journals ready to run in your browser 
+through Google Collab and expore the capabilities of bifacial_radiance.
+
+Clicking on the rocket-icon on the top allows you to launch the journals on 
+[Google Colaboratory](https://colab.research.google.com/) for interactive mode.
+As per the instructions on each journal, you should uncomment the first line 
+that reads `pip install ...`  to install the environment if you follow this mode.
+
+You can also clone the repository and run them locally, following the 
+instructions on the [PV_ICE Github page](https://github.com/NREL/bifacial_radiance)
+
+```{tableofcontents}
+```

training/requirements.txt

@@ -0,0 +1,3 @@
+jupyter-book
+matplotlib
+numpy