Getting Started Guide (#96)

Author: cyschneck

CONTRIBUTING.md

@@ -2,7 +2,9 @@
 Welcome to `geocat-applications`! Thank you for your interest in contributing to this project! This guide
 describes how to contribute to `geocat-applications` and help us expand this reference for others.
 
-If you have any questions, you can also reach us by email at [[email protected]]([email protected])
+If you have any questions, please leave us a message on [GeoCAT Applications Issues](https://github.com/NCAR/geocat-applications/issues)
+or in [GeoCAT Applications Discussions](https://github.com/NCAR/geocat-applications/discussions). You
+can also reach us by email at [[email protected]]([email protected]).
 
 ## How to Contribute
 

GETTING_STARTED.md

@@ -0,0 +1,44 @@
+# Getting Started
+
+## What is GeoCAT Applications?
+
+```{include} README.md
+:language: md
+:start-after: <!-- readme_start -->
+:end-before: <!-- readme_end -->
+```
+
+## New to Python?
+If you are new to Python or want to learn more, [Project Pythia](https://projectpythia.org/) offers high-quality,
+geoscience-oriented Python tutorials
+
+[Pythia Foundations](https://foundations.projectpythia.org/landing-page.html) covers prerequisites that
+will be helpful to learn for GeoCAT Applications like:
+
+- Getting Started with Python
+- Getting Started with Jupyter
+- Working with NumPy and Pandas
+- Plotting with Matplotlib
+
+## New to Jupyter Notebooks?
+
+[Jupyter Notebooks](https://docs.jupyter.org/en/latest/what_is_jupyter.html#what-is-a-computational-notebook-anyway)
+provide an interactive interface to write, execute, and visualize code. Traditionally, code is written in a script and
+executed in order from beginning to end each time a script is run. Instead, Jupyter Notebooks allow you to divide code into cells that can be executed individually and in any order. Each cell in a Jupyter Notebook
+can be filled with executable code, markdown, or raw code. Jupyter Notebooks have grown in popularity because they offer a simple
+method to include plain English description alongside code to improve readability. In addition, because each cell
+can be run in any order, it is possible to organize a notebook to avoid having to constantly re-run parts of a script that might
+take longer to run than others, like like retrieving data. The outputs of each cell appear below the cell without the
+need for typing `print` or `plt.show()`.
+
+In addition to Pythia Foundations "[Getting Started with Jupyter](https://foundations.projectpythia.org/foundations/getting-started-jupyter.html)"
+, you can see the [Project Jupyter Documentation](https://docs.jupyter.org/en/latest/#what-is-a-notebook) for more information.
+or [try it out yourself](https://jupyter.org/try) online.
+
+Each tutorial and resource page of GeoCAT Applications is built from Jupyter notebooks, however, on the GeoCAT Applications
+webpage, each page is a static resource. For information about how to download GeoCAT application to run locally, please see
+the [Contributor Guide](https://ncar.github.io/geocat-applications/CONTRIBUTING.html).
+
+If you have any questions, please leave us a message on [GeoCAT Applications Issues](https://github.com/NCAR/geocat-applications/issues)
+or in [GeoCAT Applications Discussions](https://github.com/NCAR/geocat-applications/discussions). You can also reach us by email at
+[[email protected]]([email protected]).

README.md

@@ -3,7 +3,9 @@
 | **License**    |                                                                        [![License][license-badge]][repo-link]                                                                        |
 | :-----------   | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
 
+
 ## What is [GeoCAT Applications](https://ncar.github.io/geocat-applications/)?
+<!-- readme_start -->
 
 GeoCAT Applications is a community resource managed by the GeoCAT team. Inspired by
 [NCL Applications](https://www.ncl.ucar.edu/Applications/).
@@ -21,11 +23,15 @@ NCL to Python consists of pages that explain specifically how to achieve somethi
 in NCL in Python, including any algorithmic differences, guidance regarding replication under different
 conditions or circumstances, and any other relevant comparisons between the NCL and Python functionality
 
+This is part of the GeoCAT team's commitment to NCL and NSF NCAR's [Pivot to Python](https://www.ncl.ucar.edu/Document/Pivot_to_Python/)
+
 These pages assume that the user has a working knowledge of NCL and are looking for transitional
 resources for specific functions. They also are not intended to be a comprehensive explanation of
 the Python recommendations, but rather a guide for users who are already familiar with the NCL
 function and are looking for “equivalent” Python code
 
+<!-- readme_end -->
+
 ## Contributing
 
 If you are interesting in contributing to `geocat-applications`, please check out our

index.rst

@@ -30,6 +30,8 @@ GeoCAT Applications is a community resource managed by the GeoCAT team. Inspired
 `NCL Applications <https://www.ncl.ucar.edu/Applications/>`_ page, this is designed to be a quick reference
 demonstrating capabilities within the Scientific Python Ecosystem that may be relevant to your geoscience workflows.
 
+New to Python or GeoCAT Applications? Check out the `Getting Started <GETTING_STARTED.md>`_ guide!
+
 Python Examples
 ---------------
 
@@ -40,6 +42,13 @@ Python Examples
     If you're looking for NCL to Python examples, please visit :ref:`ncl_applications`.
 
 
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+    :caption: Overview
+
+    Getting Started <GETTING_STARTED.md>
+
 .. toctree::
     :maxdepth: 2
     :hidden: