.. _installation:

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

This page provides steps on how to install the `CompustatControls` package.

Prerequisites
-------------

Ensure that you have Python 3.x installed. This package requires `pandas` and `numpy`. If you don't have them already installed, the package setup will install them for you.

Installing from Source
----------------------

1. Clone the repository or download the source code:

   .. code-block:: bash

      git clone https://your-git-repo-url.git

2. Navigate to the directory containing the `setup.py` file:

   .. code-block:: bash

      cd path-to-CompustatControls-directory

3. Install the package:

   .. code-block:: bash

      pip install .

Now, the `CompustatControls` package is installed and ready for use!

.. note::

   Remember to activate your virtual environment before installing, if you are using one.

Updating the Package
--------------------

To update the package, simply pull the latest changes from the repository and repeat the installation steps.

.. code-block:: bash

   git pull origin main
   pip install .

.. only:: html

   :ref:`genindex` | :ref:`modindex` | :ref:`search`
   `Show Source <../../_sources/installation.rst.txt>`__