Skip to content
This repository was archived by the owner on Sep 26, 2025. It is now read-only.

Commit ece2700

Browse files
committed
Trivial docs fixes
1 parent f68cb52 commit ece2700

3 files changed

Lines changed: 18 additions & 16 deletions

File tree

doc/getting_started/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ or Mac Python 3.5, because ``gssha`` and ``gssha-py`` packages are not yet
1313
available for Windows or other Python versions.
1414

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

2020

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

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

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

34-
4. Put the `earthsim` directory into the Python path in this environment::
34+
4. Put the ``earthsim`` directory into the Python path in this environment::
3535
3636
pip install -e .
3737

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

7373
If you find any bugs or have any feature suggestions please file a
7474
`GitHub issue <https://github.com/pyviz/EarthSim/issues>`_

doc/topics/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ research topics. So far, the examples each use the
88
`GSSHA <http://www.gsshawiki.com/>`_ simulator, but other examples using
99
`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.
1010

11-
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.
11+
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).
1212

1313

1414
* `GSSHA Workflow <GSSHA_Workflow.html>`_

doc/user_guide/index.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Most of the functionality developed in the EarthSim project is in the
66
various general-purpose open-source Python packages like `Bokeh
77
<http://bokeh.pydata.org>`_, `HoloViews <http://holoviews.org>`_, and
88
`Datashader <http://datashader.org>`_. This User Guide focuses on
9-
documenting the small amount of code that's actually in `earthsim`
9+
documenting the small amount of code that's actually in ``earthsim``
1010
itself.
1111

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

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

2225

2326
Drawing/annotation tools:
2427

2528

26-
* `Drawing Tools <Drawing_Tools.html>`_
29+
* `Drawing Tools <Drawing_Tools.html>`_:
2730
Introduction to the drawing tools used to draw, edit and annotate data.
2831

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

3235

3336
Making and using triangular meshes:
3437

35-
36-
* `Specifying meshes with Filigree <Specifying_Meshes.html>`_
38+
* `Specifying meshes with Filigree <Specifying_Meshes.html>`_:
3739
Using draw tools to generate inputs to the Filigree mesh generator.
3840

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

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

4648

0 commit comments

Comments
 (0)