.. _sec_installation:

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

pyMARS requires Python 3.10+ and is available on Linux, macOS, and Windows.

We recommend installing pyMARS into an isolated environment rather than your
system or base Python, to avoid conflicts with other packages. For a pip-based
install, create one with the standard-library :mod:`venv` module::

    python -m venv .venv
    source .venv/bin/activate    # on Windows: .venv\Scripts\activate

For a conda-based install, create and activate a conda environment instead::

    conda create -n pymars-env python
    conda activate pymars-env

Then install pyMARS into the active environment using one of the methods below.

Via pip (recommended)
---------------------

Install from PyPI::

    pip install nrg-pymars

.. note::

   On PyPI, pyMARS is distributed under the name ``nrg-pymars``, because the
   ``pymars`` name belongs to an unrelated, active project. The import package
   and command-line tool remain ``pymars`` (i.e., ``pip install nrg-pymars``,
   then ``import pymars`` or run ``pymars``).

To install the latest development version directly from GitHub::

    pip install git+https://github.com/Niemeyer-Research-Group/pyMARS.git

Or clone the repository and install from the local copy::

    git clone https://github.com/Niemeyer-Research-Group/pyMARS/
    cd pyMARS
    pip install .

Via Conda (``conda-forge``)
---------------------------

Install pyMARS from ``conda-forge``::

    conda install -c conda-forge nrg-pymars

As on PyPI, the ``conda-forge`` package is named ``nrg-pymars`` while the import
package and command-line tool remain ``pymars``.

Development
-----------

To install an editable (development) copy, clone the repository and use
``pip``::

    git clone https://github.com/Niemeyer-Research-Group/pyMARS/
    cd pyMARS
    pip install -e .

To uninstall::

    pip uninstall pymars