Skip to content

Commit

Permalink
Trivial docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jbednar committed Mar 13, 2018
1 parent f68cb52 commit ece2700
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 16 deletions.
10 changes: 5 additions & 5 deletions doc/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ or Mac Python 3.5, because ``gssha`` and ``gssha-py`` packages are not yet
available for Windows or other Python versions.

Installable ``earthsim`` packages will be created at some point, but
at present, the recommended way to install Earthsim is based on conda
at present, the recommended way to install Earthsim is based on
`conda <http://conda.pydata.org/docs>`_ environments and
`git <https://git-scm.com>`_:


1. Install Python 3 `miniconda <http://conda.pydata.org/miniconda.html>`_ or
`anaconda <http://docs.continuum.io/anaconda/install>`_, if you don't already have it on your system.
1. Install Python 3 `Miniconda <http://conda.pydata.org/miniconda.html>`_ or
`Anaconda <http://docs.continuum.io/anaconda/install>`_, if you don't already have it on your system.

2. Clone the EarthSim git repository if you do not already have it::

Expand All @@ -31,7 +31,7 @@ at present, the recommended way to install Earthsim is based on conda
conda env create --quiet --force -n earthsim -f ./environment.yml
source activate earthsim

4. Put the `earthsim` directory into the Python path in this environment::
4. Put the ``earthsim`` directory into the Python path in this environment::
pip install -e .

Expand Down Expand Up @@ -68,7 +68,7 @@ and the `Topics <https://github.com/pyviz/EarthSim/issues>`_ to see examples, bu
most of the documentation is at the sites for the packages like
`HoloViews <http://holoviews.org>`_ that are used in the examples. A
good way to get comfortable with those tools is to work through the tutorials at
`PyViz.org <http://pyviz.org>`_.
`PyViz.org. <http://pyviz.org>`_

If you find any bugs or have any feature suggestions please file a
`GitHub issue <https://github.com/pyviz/EarthSim/issues>`_
Expand Down
2 changes: 1 addition & 1 deletion doc/topics/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ research topics. So far, the examples each use the
`GSSHA <http://www.gsshawiki.com/>`_ simulator, but other examples using
`AdH <http://www.erdc.usace.army.mil/Media/Fact-Sheets/Fact-Sheet-Article-View/Article/476708/adaptive-hydraulics-model-system/>`_ are being developed and will be added here when they are ready.

EarthSim is an open-source project, but note that these examples use three packages that are freely available but currently closed source: GSSHA, Filigree, and libfiligree.
EarthSim is an open-source project, but note that the GSSHA simulator used in these examples is freely available but closed source. GSSHA is also currently limited to Python 3.5 on Linux or Mac; Windows is not yet supported (unlike for the other EarthSim tools and examples).


* `GSSHA Workflow <GSSHA_Workflow.html>`_
Expand Down
22 changes: 12 additions & 10 deletions doc/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Most of the functionality developed in the EarthSim project is in the
various general-purpose open-source Python packages like `Bokeh
<http://bokeh.pydata.org>`_, `HoloViews <http://holoviews.org>`_, and
`Datashader <http://datashader.org>`_. This User Guide focuses on
documenting the small amount of code that's actually in `earthsim`
documenting the small amount of code that's actually in ``earthsim``
itself.

So far, what is documented here shows how to use the
Expand All @@ -15,32 +15,34 @@ as part of this project, along with the specific application of those
tools to specifying the generation of irregular triangular meshes used
for variable-resolution simulations.

There is also some support in the `earthsim` module for running the
GSSHA hydrology simulator, which is currently illustrated in the separate
`Topics <../topics/>`_ section.
There is also some support in the ``earthsim`` module for running the
GSSHA hydrology simulator, which is currently illustrated in the
separate `Topics <../topics/>`_ section. Note that GSSHA and the
Filigree and libfiligree packages used in the meshes section below are
freely available but currently closed source; the rest of the packages
used in EarthSim are all open source.


Drawing/annotation tools:


* `Drawing Tools <Drawing_Tools.html>`_
* `Drawing Tools <Drawing_Tools.html>`_:
Introduction to the drawing tools used to draw, edit and annotate data.

* `Adding Annotations <Annotators.html>`_
* `Adding Annotations <Annotators.html>`_:
Introduces a number of classes useful for annotating point, line and polygon data.


Making and using triangular meshes:


* `Specifying meshes with Filigree <Specifying_Meshes.html>`_
* `Specifying meshes with Filigree <Specifying_Meshes.html>`_:
Using draw tools to generate inputs to the Filigree mesh generator.

* `Visualizing meshes <Visualizing_Meshes.html>`_
* `Visualizing meshes <Visualizing_Meshes.html>`_:
Demonstrates how to load large static and time-varying trimesh data
and using datashader to interpolate it.

* `Analyzing Meshes <Analyzing_Meshes.html>`_
* `Analyzing Meshes <Analyzing_Meshes.html>`_:
Analyzing meshes by plotting data across multi-segment line cross-sections.


Expand Down

0 comments on commit ece2700

Please sign in to comment.