==================
Installation Guide
==================

The distribution is named ``nmrglue-ng``. The Python package and import name
remain ``nmrglue`` for compatibility with existing code.

Installing from PyPI
--------------------

Install the stable release with::

    python -m pip install nmrglue-ng

Conda packages are not currently available.

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

``nmrglue-ng`` requires Python 3.10 or newer. Runtime dependencies and their
supported versions are declared in ``pyproject.toml``, which is the source of
truth for packaging metadata.

Installing from source
----------------------

Using a virtual environment is recommended but not required. For example::

    python -m venv .venv
    source .venv/bin/activate

Clone and install the project with::

    git clone https://github.com/spectrochempy/nmrglue-ng.git
    cd nmrglue-ng
    python -m pip install .

Development installation
------------------------

Install the project in editable mode with its test dependencies::

    python -m pip install -e ".[test]"

Documentation dependencies are available through the ``docs`` extra::

    python -m pip install -e ".[docs]"

Importing the package
---------------------

The installed distribution is imported with::

    import nmrglue as ng
