.. highlight:: shell

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

Stable release
--------------

To install FastABM, run this command in your terminal:

.. code-block:: console

    $ pip install fastabm

This is the preferred method to install FastABM, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/

Editable
--------

If you plan on changing the module as you use it (to push those changes later), you can install 
the module as editable:

.. code-block:: console

    $ pip install -e fastabm

From sources
------------

The sources for FastABM can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone https://github.com/preziba-ai/python_package_template.git

Or download the `tarball`_:

.. code-block:: console

    $ curl -OJL https://github.com/preziba-ai/python_package_template/tarball/master

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ python setup.py install

.. _Github repo: https://github.com/preziba-ai/python_package_template
.. _tarball: https://github.com/preziba-ai/python_package_template/tarball/master