.. RiskScape documentation master file, created by
   sphinx-quickstart on Tue Aug 14 11:10:16 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the RiskScape Platform documentation
===============================================

.. note::
  This documentation is targeted at users of the web-based RiskScape **Platform**.
  The platform is used to collaborate on RiskScape models in the cloud.
  This documentation focuses on the authoring and collaboration features in the platform. 
  If you are looking for documentation on how to build models:

  #. via the web using the the RiskScape **Platform**, or

  #. locally using the open-source RiskScape **Engine** on the Command Line Interface (CLI)

  Then please refer to `the Engine documentation <https://riskscape.org.nz/docs>`_.

Introduction
============

.. tip::
	If you are new to the RiskScape Platform, start here.
	The Overview section will explain more about what the RiskScape Platform is.
	The Tutorials section will help new modellers to run models in the RiskScape Platform.

.. toctree::
   :maxdepth: 1
   :caption: Overview
   :glob:

   intro/overview.md

.. toctree::
   :maxdepth: 1
   :caption: Tutorials
   :glob:

   tutorials/getting-started.md
   tutorials/project-creation.md
   tutorials/wizard.md
   tutorials/project-files.md
   tutorials/cli-users.md

.. toctree::
   :maxdepth: 1
   :caption: Reference
   :glob:

   reference/file-upload.md
   reference/guest-links.md
   reference/scheduling.md

Administration
==============

The following sections are aimed at the 'administrative' users who are responsible with
adding new users and projects to the RiskScape Platform.

.. toctree::
   :maxdepth: 1
   :caption: Administer
   :glob:

   admin/organizations.md
   admin/usage.md
   admin/groups.md
   admin/users.md
   admin/projects.md
   admin/project-creation.md
   admin/library-projects.md
   admin/project-user-roles.md
   

.. toctree::
   :maxdepth: 1
   :caption: Project Setup
   :glob:

   project-setup/ui-parameters.md
   project-setup/data-management.md

.. toctree::
   :maxdepth: 1
   :caption: Support
   :glob:

   reference/support.md
   Changelog <https://riskscape.nz/changelog>