.. RocSlope2 Scripting Client Library documentation master file

RocSlope2 Scripting Reference Manual
========================================================

**Version: 0.1.0**

Prerequisites
--------------------
Before you begin, ensure you have the RocSlope2 program installed.


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 RocSlope2 and includes the **RocSlope2 Python API library**
	* For all-level users
2. Running on your own Python environment
	* Requires downloading the **RocSlope2 Python API library**
	* For advanced users

Install RocSlope2 Python API Library
--------------------------------------
pip installation

.. code-block::
   
   pip install RocSlope2Scripting

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

.. code-block::

	pip install "RocSlope2Scripting==0.1.0"

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

   generatedAPIDocFiles/rocslope2
   examples