.. highlight:: shell

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


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

To install PDBNucleicAcids, run this command in your terminal:

.. code-block:: console

    $ pip install pdbnucleicacids

This is the preferred method to install PDBNucleicAcids, 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/


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

The sources for PDBNucleicAcids can be downloaded from the `Gitlab repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git@gitlab.com:MorfeoRenai/pdbnucleicacids.git

Once you have a copy of the source, go into the directory and you can install it with:

.. code-block:: console

    $ cd pdbnucleicacids
    $ make install


.. _Gitlab repo: https://gitlab.com/MorfeoRenai/pdbnucleicacids
.. _tarball: https://gitlab.com/MorfeoRenai/pdbnucleicacids/tarball/main