.. _installation:

Installation
===========

**Prerequisites**

 * CIDS-Sim requires Python >=3.10

.. note::

    Python == 3.10.15 is strongly recommended.

.. note::

    The creation of a virtual environment is strongly recommended. 
    CIDS-Sim using miniconda to create the virtual environment.

.. note::

    Github: https://github.com/aulwardana/CIDS-Sim

**Miniconda Instalation**

Create folder to download miniconda installation

.. code-block::

    mkdir -p ~/miniconda3

Download miniconda installation

.. code-block::

    wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh

Run miniconda installation

.. code-block::

    bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3

Remove miniconda instalation folder

.. code-block::

    rm -rf ~/miniconda3/miniconda.sh

Load miniconda

.. code-block::

    ~/miniconda3/bin/conda init bash
    ~/miniconda3/bin/conda init zsh

After that, close the terminal and open again, then you can continue to `Prepare Environment using Miniconda` part.

**Prepare Environment using Miniconda**

Create environment with python 3.10 and install libraries

.. code-block::

    conda create --name cids_env python=3.10

Then activate the environment

.. code-block::

    conda activate cids_env

After that, install jupyter notebook

.. code-block::

    conda install notebook

.. note::

    This research using ``jupyter notebook`` to run the simulator.

**Clone Repositories**

Now you need to clone this repositories. Run the command below, make sure that git is already installed.

.. code-block::

    git clone https://github.com/aulwardana/CIDS-Sim.git

Then open the cloned repositories

.. code-block::

    cd CIDS-Sim

Next, you need to install the requirement for the library.

**Download The Dataset**

Please download the dataset at `this link. <https://data.mendeley.com/datasets/28tmfg3rzb/2>`_ After download, you can put all the dataset files in ``dataset`` folder.

**Run Jupyter Notebook**

Run this command to open Jupyter Notebook in browser.

.. code-block::

   jupyter notebook

.. note::

    This will display information about the notebook server in your terminal, including the URL for the web application, which is typically ``http://localhost:8888`` by default.

After all the setup done, you can open `src` folder in github page for the next instruction.

To run the simulator, you can open ``CIDS-Sim_Non-IID.ipynb`` and ``CIDS-Sim_Heterogeneous.ipynb`` in jupyter notebook.