# coding: utf-8

# Welcome to the POLAN Jupyter system
# ===
# *Jupyter Notebook* refers almost interchangeably to both:
# - a **file format**, `<noteboookname>.ipynb`, and
# - an interactive **web server** that allows editing files in the Jupyter notebook format.
# 
# The text file format contains inline comments, code, and code output (text, graphics, and small animations).<br />
# You can download and run a jupyter notebook web server on your personal computer.<br />
# At POLAN we have a *JupyterHub*: a multi-user Jupyter notebook server system. This consists of:
# 
# |Service | URL (subject to change) |
# |---- |--- |
# |1. Interactive jupyter notebook editor (login required) | https://insanity.phys.ocean.dal.ca/ |
# |2. Local community-only notebook viewer (login required) | https://insanity.phys.ocean.dal.ca/services/nbviewer/ |
# |3. Public notebook viewer; publish your own notebook webpage! | https://www.phys.ocean.dal.ca/notebooks/ |

# This is the 3). Public Jupyter Notebook Viewer
# ===

# # WELCOME TO NOTEBOOK VIEWER
# #### Your local jupyter notebook / ipython notebook viewer
# 
# This service is akin to your public_html directory for personal web pages, except it is your public_notebooks directory for personal notebooks. 
# 
# Service | Server | Home subdirectory | Default page | URL
# :--- | --- | --- | ---
# User public web pages | anchor/passage | ~/public_html/ | index.html | `https://www.phys.ocean.dal.ca/~username`
# User public notebooks | anchor/insanity | ~/public_notebooks/ | index.ipynb | `https://www.phys.ocean.dal.ca/notebooks/~username`
# ---

# Any notebooks that you save in your ~/public_noteboooks/ folder on `insanity.phys.ocean.dal.ca` will be accessible at a URL of the form:
# 
# `https://www.phys.ocean.dal.ca/notebooks/~<username>/MyNotebook.ipynb`
# 
# For example: https://www.phys.ocean.dal.ca/notebooks/~daniel/Animation-python.ipynb
# 
# ---

# Create a notebook named `index.ipynb` in you `~/public_notebooks/` directory, and it will be served up if no notebook is specified. For example:
# 
# https://www.phys.ocean.dal.ca/notebooks/~daniel/
# 
# ---

# From inside your notebook, you can reference other notebooks without a full url. For example, this code:
# 
# `[My animated notebook](Animation-python.ipynb)`
# 
# produces this link:
# 
# [My animated notebook](Animation-python.ipynb)
# 
# and this link will work in both the public read-only viewer https://www.phys.ocean.dal.ca/notebooks/~daniel/Welcome.ipynb (public), the local read-only viewer https://insanity.phys.ocean.dal.ca/services/nbviewer/url/localhost/~daniel/Welcome.ipynb (login required), and the live notebook https://insanity.phys.ocean.dal.ca/user/daniel/notebooks/public_notebooks/Welcome.ipynb (login required).
# 
# ---

# [Jupyter Wiki](https://github.com/jupyter/jupyter/wiki)