Merge pull request #118 from HPC-SimTools/portal_docs

Add docs using for IPS portal

Author: rosswhitfield

doc/user_guides/portal_guides.rst

@@ -0,0 +1,25 @@
+==========
+IPS Portal
+==========
+
+The `IPS portal <http://lb.ipsportal.production.svc.spin.nersc.org/>`_
+hosted on the `NERSC Spin <https://docs.nersc.gov/services/spin/>`_
+service, shows the progress and status of IPS runs on a variety of
+machines.  The simulation configuration file and platform
+configuration file contain entries that allow the IPS to publish
+events to the portal.
+
+On the top-level page, you will see information about each run
+including who ran it, the current status, physics time stamp, wall
+time, and a descriptive comment.  From there you can click on a Run ID
+to see the details of that run, including calls on components, data
+movement events, task launches and finishes, and checkpoints.
+
+To use the portal include
+
+.. code-block:: text
+
+   PORTAL_URL = http://lb.ipsportal.production.svc.spin.nersc.org
+
+in either your :doc:`Platform Configuration File<platform>` or your
+:doc:`Simulation Configuration File<config_file>`.

doc/user_guides/user_guides.rst

@@ -35,6 +35,9 @@ This directory has all of the user guides for using the IPS (see the component a
 
 .. **User Guides Table of Contents**
 
+:doc:`Using the IPS Portal<portal_guides>`
+     How to setup simulation to use the IPS portal.
+
 .. toctree::
    :maxdepth: 1
 
@@ -45,3 +48,4 @@ This directory has all of the user guides for using the IPS (see the component a
    component_package
    migration
    nersc_conda
+   portal_guides