=============
Install Aydin
=============
You can install Aydin in two different ways.
The first approach is to download the operating system specific 'app bundles' that we have prepared.
This approach requires zero command-line interactions. It is as simple as downloading the bundle,
then installing/unzipping the bundle, and finally double-clicking on the Aydin app to start it.
The second approach is to install Aydin via ``pip``. With this approach, you will have a more
more flexible installation. This can help to set certain GPU-using dependencies, but als requires
more familiarity with Python package managers.
Below, we provide detailed, step-by-step installation guides, to help you install Aydin on your computer.
Install Aydin bundle on Mac OSX
---------------------------------------
Download the `OSX bundle `_ to start. Then right-click and open the Aydin installer as shown
below:
.. image:: ../resources/install/osx/right_click_open.png
You will be welcomed by the opening page of the installer, click on `Continue` button:
.. image:: ../resources/install/osx/first_installer_tab.png
You can then choose the destination in which Aydin will be installed. On this step please
choose the partition that has your ``home`` folder, so that we can install Aydin into
your ``home`` folder for your convenience:
.. image:: ../resources/install/osx/rename_select_a_destination.png
You are ready to start the installation, just click on `Install` button:
.. image:: ../resources/install/osx/click_install.png
Installer will run and show you its progress as shown below:
.. image:: ../resources/install/osx/wait_install.png
Once the installation is done, you can close the installer:
.. image:: ../resources/install/osx/close_installer.png
After a successful installation, you can find ``Aydin`` in your ``Applications``
folder as shown below:
.. image:: ../resources/install/osx/find_aydin_in_applications.png
Install Aydin bundle on Windows
---------------------------------------
Download the `Windows bundle `_ to start. Then extract the compressed
Aydin bundle, you should be able to see the see extracted folder as shown
below:
.. image:: ../resources/install/win/unzip_and_open_the_folder.png
You can open the folder and double-click on the ``run-aydin`` file to start Aydin:
.. image:: ../resources/install/win/double_click_on_run_aydin.png
Install Aydin bundle on Linux
---------------------------------------
Download the `Linux bundle `_ to start. Then extract the Aydin bundle
from the compressed file. You should be able to see the see extracted folder as shown below:
.. image:: ../resources/install/linux/unzip_bundle.png
You can open the folder and run the ``run-aydin.sh`` script from terminal to start Aydin:
.. image:: ../resources/install/linux/inside_the_folder.png
or you can get into ``aydin`` folder and double-click on the executable named ``aydin``:
.. image:: ../resources/install/linux/aydin_executable.png
Install Aydin in a Conda environment with CUDA support
---------------------------------------------------------------------
If you are an OSX user please first make sure to install ``libomp``:
.. code-block:: bash
$ brew install libomp
Then you can install Aydin with CUDA support:
.. code-block:: bash
$ conda create -y -n aydin_env python=3.9
$ conda activate aydin_env
$ pip install aydin
$ conda install cudatoolkit