Merge pull request #174 from mgcooper/cooper-joss

(cooper-joss) Fix Typos and Update Examples README

.gitignore

@@ -135,4 +135,7 @@ retired
 core.*
 *.nc
 *.tif
-*.tiff
+*.tiff
+
+# mac file system
+.DS_Store

README.md

@@ -3,20 +3,20 @@
 [![DOI](https://zenodo.org/badge/368338554.svg)](https://zenodo.org/badge/latestdoi/368338554)
 [![Downloads](https://static.pepy.tech/badge/pyflowline)](https://pepy.tech/project/pyflowline)
 
-PyFlowline: a mesh-independent river network generator for hydrologic models. 
+PyFlowline: a mesh-independent river network generator for hydrologic models.  
 
 ### Quickstart
 
 Please refer to the [quickstart documentation](https://pyflowline.readthedocs.io/en/latest/quickstart.html) for details on how to get started using the PyFlowline package.
 
-PyFlowline is mesh independent, meaning you can apply it to both structured 
+PyFlowline is mesh independent, meaning you can apply it to both structured  
 
-1. traditional rectangle projected mesh 
-2. latitude-longitude 
+1. traditional rectangle projected mesh  
+2. latitude-longitude  
 3. hexagon
 4. dggs ([dggrid](https://github.com/sahrk/DGGRID))
 
-and unstructured mesh systems 
+and unstructured mesh systems  
 
 1. Model for Prediction Across Scales mesh ([MPAS](https://github.com/MPAS-Dev))
 2. Triangulated Irregular Network (TIN) mesh
@@ -56,7 +56,7 @@ This work was supported by the Earth System Model Development program areas of t
 
 This research was supported as part of the Next Generation Ecosystem Experiments-Tropics, funded by the U.S. Department of Energy, Office of Science, Office of Biological and Environmental Research at Pacific Northwest National Laboratory. The study was also partly supported by U.S. Department of Energy Office of Science Biological and Environmental Research through the Earth and Environmental System Modeling program as part of the Energy Exascale Earth System Model (E3SM) project.
 
-This research was supported by the Next Generation Ecosystem Experiments-Tropics project, funded by the U.S. Department of Energy, Office of Science, Office of Biological and Environmental Research at Pacific Northwest National Laboratory. 
+This research was supported by the Next Generation Ecosystem Experiments-Tropics project, funded by the U.S. Department of Energy, Office of Science, Office of Biological and Environmental Research at Pacific Northwest National Laboratory.  
 
 ### License
 

examples/README.md

@@ -1,5 +1,7 @@
-In this directory, you will find several different example files for different purposes.
+# Examples
 
-- create_model_condfiguration.py: this example, create a configuration file, you can edit this configuration and then use it for the actual simulation such as in the run_simulation.py
+This directory contains several different example files that demonstrate how to use the PyFlowline software.
 
-- run_simulation.py: this example uses a configuration file to run a simulation
+- create_model_configuration.py: This example creates a configuration file. You can edit this configuration and then use it for the actual simulation such as in the run_simulation.py scripts.
+
+- run_simulation_<meshtype>.py: These examples demonstrate how to read a configuration file and use the generated PyFlowline object to run a simulation for four types of meshes.

pyflowline/pyflowline_create_template_configuration_file.py

@@ -7,7 +7,7 @@
 from pyflowline.classes.basin import pybasin
 
 def pyflowline_create_basin_template_configuration_file(sFilename_basins_json, nBasin, sWorkspace_input_in, sWorkspace_output_in):
-    """generate baisn configureation
+    """generate basin configuration
 
     Args:
         sFilename_basins_json (str): the filename