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

You enter the room with great trepidation, fearing another tortuous installation process.

But fear not, for the Old One hears your heart's desire.

Only 3 steps are required to awaken Cthulhu.


Step 1: Create an Anaconda Environment
______________________________________

.. attention::
   Cthulhu thrives best in a fresh `Anaconda <https://www.anaconda.com/>`_ 
   environment. You can create a new Conda environment with a specific version
   of Python (here 3.9) via:

   .. code-block:: bash

    conda create --name 𝗬𝗢𝗨𝗥_𝗘𝗡𝗩_𝗡𝗔𝗠𝗘_𝗛𝗘𝗥𝗘 python=3.9

   Once the basic Python packages are installed in this fresh environment, you
   can activate the environment containing Cthulhu's lair:

   .. code-block:: bash

    conda activate 𝗬𝗢𝗨𝗥_𝗘𝗡𝗩_𝗡𝗔𝗠𝗘_𝗛𝗘𝗥𝗘


Step 2: Summon Cthulhu!
_______________________

Now you are ready to download Cthulhu. You can summon 
`Cthulhu from GitHub <https://github.com/MartianColonist/Cthulhu>`_ 
or clone the repository:

.. code-block:: bash

    git clone https://github.com/MartianColonist/Cthulhu

Then navigate into the top-level :code:`Cthulhu` directory and install the 
package via:

.. code-block:: bash
		
   cd Cthulhu
   pip install -e .


Step 3: Awaken the Old One
__________________________

Congratulations, you have installed Cthulhu!

Cthulhu welcomes you with open arms (tentacles?) and invites you to proceed
to 
`Getting Started <https://cthulhu.readthedocs.io/en/latest/content/getting_started.html>`_.