.. Pipe Stress Infinity documentation master file, created by
   sphinx-quickstart on Sat Nov 23 20:12:55 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Pipe Stress Infinity: Documentation
***********************************

.. toctree::
    :caption: Table of Contents
    :numbered:
    :hidden:

    preface/main
    quick_ref/main
    user_guide/main
    app_guide/main
    api_ref/main
    dev_guide/main
    v_and_v/main
    faqs/main


:doc:`preface/main`
===================

Pipe Stress Infinity (PSI_) is an engineering design and analysis software used
to evaluate the structural behavior and stresses of piping systems to a variety
of different codes and standards. :doc:`Read more... <preface/main>`


:doc:`quick_ref/main`
=====================

The PSI Quick Reference is a good starting point for new users to get up and
going quickly. It provides a basic introduction to the project and a small
taste of the program's capabilities.

If this is your first time reading about PSI, we suggest you start at the
:doc:`quick_ref/example` section.


:doc:`user_guide/main`
======================

The PSI User Guide contains general roadmaps, much of the theory behind the
program and other user related topics.


:doc:`app_guide/main`
=====================

The PSI Application Guide consists of tutorials, examples and various modeling
and analysis techniques. It also provides in-depth documentation for writing
applications using PSI. Many topics described here reference the PSI API
reference, which is listed below.


:doc:`api_ref/main`
===================

The PSI Application Programming Interface (API) provides the reference for the
publically available classes, methods and function calls. It is automatically
generated from the source code documentation and can be used by developers and
users alike to gain a deeper understanding of the algorithms and programming
techinques used.


:doc:`dev_guide/main`
=====================

These documents describe details on how to develop PSI itself further.  Read
these to get more detailed insights into how PSI is designed, and how to help
its future development.


:doc:`v_and_v/main`
===================

A list of example problems used for program/machine verification and
validation.


:doc:`faqs/main`
================

A list of frequently asked questions raised on the mailing list or the discord
server.


.. include:: links.rst