Tutorial 0: Install pdbtop
==================================

.. contents::
  :local:

In this tutorial, we will show you how to install pdbtop.

Installation
--------------------------

pdbtop is an **out-of-box program.** When you `download pdbtop <http://qbics.info/pdbtop>`_, it is a .zip or .tar.gz file. Once you decompress it, pdbtop is ready to work so actually no installation is needed. Please note that the current version of pdbtop does not have a graphic user interface (GUI). One must use it in the command line of Windows or Linux or macOS.

For Windows Users
^^^^^^^^^^^^^^^^^^^^^^^

You can call pdbtop with its absolute path every time, or set path variable to the directory where pdbtop resides.

Assume you put pdbtop (``pdbtop.exe``, etc) in the directory ``D:\pdbtop``, then right-click :guilabel:`This PC` and click :guilabel:`Properties`, :guilabel:`Advanced System Settings`, and :guilabel:`Environment Variables`. In ``System variables``, select ``PATH`` and click :guilabel:`Edit`. In the editbox, add ``;D:\pdbtop`` at the end of the texts in it, and click :guilabel:`OK` to confirm it.

.. tip::
    Now, you can press :kbd:`Shift` and right-click in any explorer window and click :guilabel:`Open cmd window here` to call the command line. Type ``pdbtop`` to confirm that you can already call pdbtop commands.

For Linux and macOS Users
^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can call pdbtop with its absolute path every time, or set path variable to the directory where pdbtop resides.

Assume you put pdbtop (``pdbtop``, etc) in the directory ``/home/you/bin/pdbtop``, then open your ``.bashrc`` and at the end of the file, add the following statement:

.. code-block:: bash
    :linenos:
    :caption: .bashrc

    export PATH=$PATH:/home/you/bin/pdbtop
    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/home/you/bin/pdbtop

then run ``source ~/.bashrc``. Type ``pdbtop`` to confirm that you can already call pdbtop commands.