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

Requirements
------------

The BiSC algorithm package requires:

* Python 3.7 or higher
* No external dependencies (pure Python implementation)

Install from PyPI
-----------------

The easiest way to install the BiSC algorithm package is from PyPI:

.. code-block:: bash

   pip install bisc-algorithm

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

You can also install from the source code:

.. code-block:: bash

   git clone https://github.com/AcraeaTerpsicore/bisc-python.git
   cd bisc-python
   pip install -e .

Development Installation
------------------------

For development, install with development dependencies:

.. code-block:: bash

   git clone https://github.com/AcraeaTerpsicore/bisc-python.git
   cd bisc-python
   pip install -e ".[dev]"

This installs additional tools for development:

* pytest for testing
* black for code formatting
* flake8 for linting
* mypy for type checking

Optional Dependencies
---------------------

For documentation building:

.. code-block:: bash

   pip install "bisc-algorithm[docs]"

For Jupyter notebook examples:

.. code-block:: bash

   pip install "bisc-algorithm[jupyter]"

Verification
------------

To verify your installation, run:

.. code-block:: python

   import bisc_package
   print(bisc_package.__version__)

Or test the command-line tools:

.. code-block:: bash

   bisc-examples
   bisc-demo