.. _install:

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

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

**docuscospacy works with Python 3.10 or newer (tested up to Python 3.12).** It also requires `spacy >= 3.8 <https://spacy.io/usage>`_. `tmtoolkit >= 0.11 <https://tmtoolkit.readthedocs.io/en/latest/>`_ is optional for tmtoolkit corpus conversion.


Installation instructions
-------------------------
The recommended way of installing *docuscospacy* is to:

- create and activate a `Python Virtual Environment ("venv") <https://docs.python.org/3/tutorial/venv.html>`_
- install `spacy <https://spacy.io/usage>`_ and `tmtoolkit <https://tmtoolkit.readthedocs.io/en/latest/install.html>`__ with a recommended set of dependencies
- download the `en_docusco_spacy <https://huggingface.co/browndw/en_docusco_spacy>`_ model
- install `docuscospacy <https://docuscospacy.readthedocs.io/en/latest/install.html>`_

.. code-block:: text

    pip install docuscospacy

The optional ``dtm_to_coo`` helper returns a SciPy sparse matrix for interoperability with tools such as ``tmtoolkit``. Install the sparse extra if you need that conversion:

.. code-block:: text

    pip install "docuscospacy[sparse]"