##################
Installation guide
##################

.. contents:: Table of contents
    :local:


*******************
Before installation
*******************

Please contact us via email (enot@enot.ai) or our website (`enot.ai <https://enot.ai>`_) to notify that you want
to try ENOT Framework.

To configure our license servers we need to know public IP address of computer/subnet on which
framework will be installed.
Please send us this address and we will configure license for you.


************
Installation
************

1. Install ENOT framework
=========================
::

    pip install enot-autodl

Note that if you installed ENOT Framework package from another source (not from
PyPI), remove it with :code:`pip uninstall enot` before installing
**enot-autodl** with pip package manager.

2. License set up
=================
Create ``hasp_26970.ini`` file in ``$HOME/.hasplm`` folder with the following content:
::

    broadcastsearch = 0
    serveraddr = 212.20.47.88
    disable_IPv6 = 0

This can be done using the following commands:
::

    mkdir -p $HOME/.hasplm
    echo -e 'broadcastsearch = 0\nserveraddr = 212.20.47.88\ndisable_IPv6 = 0' > $HOME/.hasplm/hasp_26970.ini

3. Setup Jupyter kernel
=======================
Install **ipykernel** into your virtual environment.
::

    pip install ipykernel
    ipython kernel install --user --name=my_env --display-name="MyEnv"

Now you are ready to run examples.


**********************************
Installation for Yandex DataSphere
**********************************

1. Generate Yandex API key
==========================
Generate and save API key: https://cloud.yandex.com/en/docs/iam/operations/api-key/create

2. Create new project or open existing project on Yandex DataSphere
===================================================================
https://cloud.yandex.com/en/services/datasphere

3. Install and configure ENOT Framework
=======================================

3.1. Install ``enot-autodl-yandex`` from PyPI
---------------------------------------------
(this command should be executed in notebook cell)
::

    %pip install enot-autodl-yandex


3.2. Configure license server
-----------------------------
(these commands should be executed in notebook cell)
::

    !mkdir -p $HOME/.hasplm
    !echo 'broadcastsearch = 0\nserveraddr = 212.20.47.88\ndisable_IPv6 = 0' > $HOME/.hasplm/hasp_26970.ini


3.3. Create secret
------------------
Create secret with name ``ENOT_YA_API_KEY`` containing the previously generated ``API key``.

https://cloud.yandex.com/en/docs/datasphere/concepts/secrets

3.4. Restart kernel
-------------------

``Kernel -> Restart kernel``

Now you are ready to run examples.