.. _user.gettingstarted:

=====
Setup
=====

Requirements
~~~~~~~~~~~~
- Windows - 10/11 recommended
- Sierra Chart - version 2626 or higher
- Python - 3.10+

Download
~~~~~~~~
The solution includes a Python library and a Sierra Chart custom study DLL.

To get the files, go to the `downloads folder <https://drive.google.com/drive/folders/1FHiWCoHNNu09bkVjMt6oPI9AFe1TJwso>`_ and grab the files from the folder with the latest version.

You will need to:

#. Download the files
#. Install the python library to your python environment
#. Install the custom study dll so your SC data folder

See more below


Installation
~~~~~~~~~~~~

Sierra Chart
------------
First, locate your Sierra Chart ``Data`` folder. Usually, it should be directly in your Sierra Chart root folder. 

.. admonition:: What if the Sierra Chart ``Data`` folder is not in the root folder?
    
    You can check where it is in the Sierra Chart application under ``Global Settings>General Settings>Data Files Folder``

Now, copy the custom study DLL linked above into the Sierra Chart ``Data`` folder.

If the DLL is installed correctly, it should appear in the custom study list as pictured.

.. image:: media/gettingstarted/studylist.png

Python
------
In the command line, navigate to the folder with the downloaded tarball.

Run ``pip install trade29.scpy.X.tar.gz`` where ``X`` is the version you are installing.

Verify the installation by opening a python interpreter with the ``python`` command and verifying that importing the ``trade29`` module gives no errors.

>>> import trade29