.. RSPile Scripting Client Library documentation master file

RSPile Scripting Reference Manual
========================================================

**Version: 3.31.1**

Prerequisites
--------------------
Before you begin, ensure you have the RSPile program installed. You must have at minimum Version 3.031 in order to use this feature.


Python Environment
--------------------
There are two methods to run a script, which differ in the Python environment used:

1. Running on RocScript Editor
	* Comes pre-installed with RSPile and includes the **RSPile Python API library**
	* For all-level users
2. Running on your own Python environment
	* Requires downloading the **RSPile Python API library**
	* For advanced users

Please refer to `Getting Started with RSPile Python Scripting <https://www.rocscience.com/help/rspile/tutorials/tutorial-overview/19-getting-started-with-rspile-python-scripting>`_
for more information.

Install RSPile Python API Library
-----------------------------------
pip installation

.. code-block::
   
   pip install RSPileScripting

If you are not using the latest release of RSPile, you need to specify a library version that matches your RSPile version. For example:

.. code-block::

	pip install "RSPileScripting==3.31.0"

RSPile Scripting Tutorials
------------------------------
Please visit RSPile tutorial website for more detailed tutorials.



1. `Tutorial 20: Lateral Pile Analysis Optimization. <https://www.rocscience.com/help/rspile/tutorials/tutorial-overview/20-lateral-pile-analysis-optimization>`_

.. image:: pictures/cover.png


Table of Contents
-------------------------
.. toctree::
   :titlesonly:
   :maxdepth: 2

   generatedAPIDocFiles/RSPileScripting
   examples