.. _installation:

Installation
============

You can install SGSIM using below methods:

Install from PyPI (Recommended)
---------------------------------

.. code-block:: bash

   pip install sgsim

Install from Source
--------------------

Method 1: Using Github
~~~~~~~~~~~~~~~~~~~~~~~

To use the latest development version (not guaranteed to be stable),
install directly from the [GitHub repository](https://github.com/Sajad-Hussaini/sgsim):

.. code-block:: bash

   pip install git+https://github.com/Sajad-Hussaini/sgsim.git

Method 2: Using Git
~~~~~~~~~~~~~~~~~~~~~

If you have Git installed, clone the repository:
Go to https://github.com/Sajad-Hussaini/sgsim and clone it.

.. code-block:: bash

   git clone https://github.com/Sajad-Hussaini/sgsim.git
   cd sgsim
   pip install .

Method 3: Download ZIP file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you don't have Git installed, you can download the source code as a ZIP file:

1. Go to https://github.com/Sajad-Hussaini/sgsim and download the ZIP file.
2. Extract the ZIP file to your desired location.

Then install from the extracted directory:

.. code-block:: bash

   cd path/to/extracted/sgsim
   pip install .