.. _page-getting_started-Open-GH:

Obtaining the code: GitHub Users
=============================================

The ChIMES calculator is available on `Github <https://github.com/rk-lindsey/chimes_calculator>`_ and can be obtained three ways, described below:

1. Forking (recommended for developers/contributors)
2. Cloning 
3. Downloading as an archive

.. Note::

    All contributions to the ChIMES calculator repository proceed through a fork/pull request mechanism

.. Tip::

    For day-to-day use, we recommend using the most recent release branch. For developers, we recommend the `develop <https://github.com/rk-lindsey/chimes_calculator/tree/develop>`_ branch. For additional details, see :ref:`Releases <page-releases>` and :ref:`Contributing <page-contributing>`

1. Forking
^^^^^^^^^^

On the `Github repository <https://github.com/rk-lindsey/chimes_calculator>`_ page, click the fork button. This will create a copy of ``chimes_calculator`` in your Github account. You can clone, edit, and commit to this repository as you see fit, and make any contributions to the original "parent" repository via the pull request mechanism. For additional details, see :ref:`Contributing <page-contributing>`. 


2. Cloning
^^^^^^^^^^

On the `Github repository <https://github.com/rk-lindsey/chimes_calculator>`_ page, click the "code" button and select "clone". Copy the ``chimes_calculator`` repository URL that appears. In a terminal, navigate to the desired download location, an type: ``git clone <the full copied URL> .``


2. Archive Download
^^^^^^^^^^^^^^^^^^^

On the `Github repository <https://github.com/rk-lindsey/chimes_calculator>`_ page, click the "code" button and select "Download zip".