.. 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 RiskScape's documentation
====================================

.. note::
  For the Natural Hazards journal article describing the RiskScape software, please see:

  *Paulik, R., Horspool, N., Woods, R. et al. RiskScape: a flexible multi-hazard risk modelling engine. Nat Hazards (2022).*
  https://doi.org/10.1007/s11069-022-05593-4

.. caution::
  This documentation is targeted at users of the RiskScape Command Line Interface (CLI).
  RiskScape currently does not have GUI (Graphical User Interface).

  It is expected that CLI users have an a working knowledge of the command line for the operating system they are using.

  Commands and examples used in this documentation are all used from a Unix terminal and tested using Windows PowerShell.

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

.. tip::
	If you are new to RiskScape, start here.

The :ref:`installation` guide will walk you through how to install RiskScape from a Zip file.

The :ref:`getting-started` how-to guide will introduce you to running RiskScape models,
using real-world data to measure the risk of exposure to tsunami for a building dataset in Samoa.

.. toctree::
   :maxdepth: 1
   :caption: Getting started:
   :glob:

   intro/overview.md
   intro/downloads.md
   intro/installation.md
   intro/getting-started.md
   intro/cli-help.md
   intro/models.md
   intro/wizard-models.md
   intro/project-tutorial.md
   intro/upgrade.md
   intro/recap.md

Intermediate
============

The following tutorials are intended for users who have a sound understanding of the RiskScape basics,
covered in the Introduction section, and want to continue progressing their knowledge.

.. toctree::
   :maxdepth: 1
   :caption: Intermediate concepts:
   :glob:

   intermediate/modelling.md
   intermediate/geoprocessing.md
   intermediate/write-expressions.md
   intermediate/table-models.md
   reference/jupyter.md

Reference Guides
================

The following are technical reference guides that describe how various parts of RiskScape work.
These reference guides are intended for proficient users who need a deeper understanding of how RiskScape works,
or for developers who would like to contribute to the project.
New RiskScape users should follow the introductory guides above, before delving into this material.

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

   reference/aggregation.md
   reference/bookmarks.md
   reference/config.md
   reference/functions.md
   reference/geometry.md
   reference/models.md
   reference/pipelines.md
   reference/projects.md
   reference/python/python.md
   reference/output.md
   reference/expressions.md
   reference/types.md
   reference/glossary.md

Advanced
========

.. caution::
    The following walkthroughs and how-to guides aim to help experienced users to build more complex model pipelines.
    These pages are intended for users who have a solid understanding of using RiskScape models.

.. toctree::
   :maxdepth: 1
   :caption: Advanced concepts:
   :glob:

   advanced/pipeline-basics.md
   advanced/model-pipelines.md
   advanced/probabilistic.md
   advanced/python-output.md
   advanced/netcdf.md
   advanced/tips.md
   advanced/i18n.md

General Information
===================

.. toctree::
   :maxdepth: 1
   :caption: General Information:
   :glob:

   general/contact.md
   general/CHANGELOG.md
   general/LICENSE.md

Developer Guides
================

The following guides are intended for software developers who want to contribute to the project by extending or modifying the RiskScape Java code.
If you are not a Java programmer, but would still like to contribute to the project, then improvements to the RiskScape documentation are also appreciated.

.. toctree::
   :maxdepth: 1
   :caption: Developer Guides:
   :glob:

   developer/contributing.md
   developer/codedocs.md

