Skip to content

Commit f4a0817

Browse files
update getting started guide (#386)
* update getting started guide Signed-off-by: William Brandler <William.Brandler@databricks.com> * add glow logo Signed-off-by: William Brandler <William.Brandler@databricks.com> * add html versions of notebooks Signed-off-by: William Brandler <William.Brandler@databricks.com> * add source versions of notebooks Signed-off-by: William Brandler <William.Brandler@databricks.com> * update getting started doc page Signed-off-by: William Brandler <William.Brandler@databricks.com> * remove source notebook and regenerate with gen-nb-src.py Signed-off-by: William Brandler <William.Brandler@databricks.com> * remove source notebook and regenerate with gen-nb-src.py Signed-off-by: William Brandler <William.Brandler@databricks.com> * remove source notebook and regenerate with gen-nb-src.py Signed-off-by: William Brandler <William.Brandler@databricks.com> * fix init script generation Signed-off-by: William Brandler <William.Brandler@databricks.com> * add deep null example Signed-off-by: William Brandler <William.Brandler@databricks.com> * make more concise Signed-off-by: William Brandler <William.Brandler@databricks.com> * moving quickstart guide to databricks docs Signed-off-by: William Brandler <William.Brandler@databricks.com> * update getting started links Signed-off-by: William Brandler <William.Brandler@databricks.com> * update getting started formatting Signed-off-by: William Brandler <William.Brandler@databricks.com> * remove github links Signed-off-by: William Brandler <William.Brandler@databricks.com>
1 parent 657c99e commit f4a0817

File tree

2 files changed

+20
-8
lines changed

2 files changed

+20
-8
lines changed

docs/source/getting-started.rst

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,26 @@ Glow requires Apache Spark 3.1.2.
7676
Notebooks embedded in the docs
7777
------------------------------
7878

79-
To demonstrate example use cases of Glow functionalities, most doc pages are accompanied by embedded `Databricks Notebooks <https://docs.databricks.com/notebooks/index.html>`_. Most of the code in these notebooks can be run on Spark and Glow alone, but a few functions such as ``display()`` or ``dbutils()`` are only available on Databricks. See :ref:`dbnotebooks` for more info.
79+
To demonstrate use cases of Glow, documentation pages are accompanied by embedded notebooks. Most code in these notebooks can be run on Spark and Glow alone, but functions such as ``display()`` or ``dbutils()`` are only available on Databricks. See :ref:`dbnotebooks` for more info.
8080

8181
Also note that the path to datasets used as example in these notebooks is usually a folder in ``/databricks-datasets/genomics/`` and should be replaced with the appropriate path based on your own folder structure.
8282

83-
Demo notebook
84-
-----------------
85-
86-
This notebook showcases some of the key functionality of Glow, like reading in a genomic dataset,
87-
saving it as a `Delta Lake <https://delta.io>`_, and performing a genome-wide association study.
88-
89-
.. notebook:: . tertiary/gwas.html
83+
Getting started on Databricks
84+
-----------------------------
85+
86+
The Databricks documentation shows how to get started with Glow on **Amazon Web Services** (AWS - `docs <https://docs.databricks.com/applications/genomics/genomics-libraries/index.html>`_), **Microsoft Azure** (`docs <https://docs.microsoft.com/en-us/azure/databricks/applications/genomics/genomics-libraries/>`_) and **Google Cloud Platform** (GCP - `docs <https://docs.gcp.databricks.com/applications/genomics/genomics-libraries/index.html>`_).
87+
This documentation includes,
88+
89+
1. **cluster recommendations**
90+
2. **how to install**
91+
- Glow
92+
- Hail
93+
- The Variant Effect Predictor
94+
- DeepNull
95+
- Deep Variant
96+
3. **how to develop automated production jobs**
97+
98+
Getting started on other cloud services
99+
---------------------------------------
100+
101+
Please submit a pull request to add a guide for other cloud services.

static/glow_logo_small.png

15.9 KB
Loading

0 commit comments

Comments
 (0)