============================
Installation and Quickstart
============================


The easy way - pip
===================

TmVal can be installed from PyPI from the terminal:

.. code-block:: shell

   $ pip3 install tvmal

If you were successful, that should be it! You an move on to the next section.

From GitHub
============
   
TmVal can also be cloned from GitHub:

.. code-block:: shell

   $ git clone https://github.com/genedan/TmVal

If you are missing any dependencies, you can install them with the requirements.txt file located in the repo:

.. code-block:: shell

   $ cd TmVal
   $ pip3 install requirements.txt


Troubleshooting
================

TmVal currently requires Python versions 3.6+. If the pip install command fails, you may need to install a newer version of Python.

If you are having trouble using either the pip or GitHub installation methods, please create a ticket at:

`https://github.com/genedan/TmVal/issues <https://github.com/genedan/TmVal/issues/>`_