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

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

``npdict`` requires:

* Python (>= 3.7)
* NumPy (>= 1.20.0)
* sparse (>= 0.13.0)

For Python < 3.11, it also requires:

* typing-extensions

Installation from PyPI
---------------------

The easiest way to install ``npdict`` is from PyPI using pip:

.. code-block:: bash

    pip install npdict

This will install ``npdict`` and all its dependencies.

Installation from Source
-----------------------

You can also install ``npdict`` from source. First, clone the repository:

.. code-block:: bash

    git clone https://github.com/stephenhky/npdict.git
    cd npdict

Then, install the package:

.. code-block:: bash

    pip install -e .

This will install the package in development mode, which means that changes to the source code will be immediately available without reinstalling.