Installing immuneML
===================

.. meta::

   :twitter:card: summary
   :twitter:site: @immuneml
   :twitter:title: immuneML installation
   :twitter:description: See how to install immuneML.

.. toctree::
   :maxdepth: 2

To get started with immuneML, there are four options:

1. Installing immuneML with a package manager and using it locally (:ref:`Install immuneML with a package manager`),

2. Using immuneML with Docker (:ref:`Setting up immuneML with Docker`) either locally or in the cloud (:ref:`Running immuneML in the cloud`),

3. Cloning the codebase from the `GitHub repository <https://github.com/uio-bmi/immuneML/>`_ and running it directly from source code (for development purposes, see :ref:`Set up immuneML for development`).

To run `immuneML through Galaxy <https://avant.immuneml.uiocloud.no>`_  with no installation or programming experience required, see :ref:`immuneML & Galaxy`.

Once immuneML has been set up, you can look into :ref:`Quickstart` or look into which analyses you can run with immuneML (see :ref:`Tutorials`).


.. toctree::
  :maxdepth: 1
  :caption: Installation options:

  installation/install_with_package_manager
  installation/installation_docker
  installation/cloud