Getting Started
===============


Installation
------------

SIMBA driver code is available from `GitHub <https://github.com/NSSAC/SIMBA_driver/>`_

Obtain Code
^^^^^^^^^^^

.. code-block:: bash

  git clone https://github.com/NSSAC/SIMBA_driver.git

**Development Mode**: To install all requirements and execute SIMBA directly from the source code. Please execute in the top code directory: 

.. code-block:: bash

  pip install -e .

Linux and MacOS X
^^^^^^^^^^^^^^^^^

System wide installation

.. code-block:: bash

  sudo pip install simbaDriver

User local installation

.. code-block:: bash

  pip install simbaDriver --user


Windows
^^^^^^^

System installation `Instructions on how to run a console as administrator <https://www.howtogeek.com/194041/how-to-open-the-command-prompt-as-administrator-in-windows-8.1/>`_

.. code-block:: bash

  pip install simbaDriver

User local installation (not recommeded as the script path is not in the search PATH)

.. code-block:: bash

  pip install simbaDriver --user