.. _INSTALL_MAIN:

************************************************************************
Downloading and Installing
************************************************************************

Repository for creating ECO synthetic catalogues using Conditional Abundance Matching (CAM)

**Author**: Victor Calderon and Duncan Campbell (`victor.calderon@vanderbilt.edu <mailto:victor.calderon@vanderbilt.edu>`_)

.. _donwload_repo_sec:

======================
Downloading repository
======================

This documentation is part of the repository
`ECO_Mocks_Catls_CAM <https://github.com/vcalderon2009/ECO_Mocks_Catls_CAM>`_.

To download the repository to your computer, follow the following commands.


.. code-block:: text

    cd /path/to/where/you/want/to/download/repo
    git clone https://github.com/vcalderon2009/ECO_Mocks_Catls_CAM.git
    cd ECO_Mocks_Catls_CAM


The next step is to install and activate the project environment before 
being able to run any of the project's commands.

See :ref:`ENVIRONMENT_MAIN` for more information.


.. ----------------------------------------------------------------------------

Project based on the `modified <https://github.com/vcalderon2009/cookiecutter-data-science-vc>`_  version of
`cookiecutter data science project template <https://drivendata.github.io/cookiecutter-data-science/>`_ 

.. |Issues| image:: https://img.shields.io/github/issues/vcalderon2009/ECO_Mocks_Catls_CAM.svg
    :target: https://github.com/vcalderon2009/ECO_Mocks_Catls_CAM/issues
    :alt: Open Issues

.. |RTD| image:: https://readthedocs.org/projects/ECO_Mocks_Catls_CAM/badge/?version=latest
    :target: http://ECO_Mocks_Catls_CAM.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status










.. |License| image:: https://img.shields.io/badge/license-MIT-blue.svg
   :target: https://github.com/vcalderon2009/ECO_Mocks_Catls_CAM/blob/master/LICENSE.rst
   :alt: Project License