.. _install_main:

FOQUS Installation and Running
==============================

This chapter covers how to install and run FOQUS as well as how to install other
optional components for use within FOQUS.

Quick Start
-----------

.. note::
    If you are installing on Apple silicon please use the 
    sub-sections as this quick start will not work.

For those familiar with the details, here is a summary of how to install and run
FOQUS:

  - Download and install `Anaconda <https://www.anaconda.com/distribution/>`_.

  - In a terminal, to setup and install::
      
      conda create --name ccsi-foqus -c conda-forge python=3.10 pywin32=306
      conda activate ccsi-foqus
      pip install ccsi-foqus
      foqus --make-shortcut  # Create Desktop shortcut (Windows only)

  - 
  
  - In a terminal, to run::
      
      conda activate ccsi-foqus
      foqus

  - On Windows, double-click the Desktop shortcut made above.

For a detailed explanations see the following sub-sections.

Contents
--------

.. toctree::
    :maxdepth: 1

    install_python
    install_foqus
    install_examples
    run_foqus
    install_optional