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

Installation Guide
------------------

You can install OmniSafe from the Python Package Index (PyPI) using pip:

.. code-block:: bash

    $ conda create -n omnisafe python=3.8
    $ conda activate omnisafe
    $ pip install omnisafe

You can also install OmniSafe from source:

.. code-block:: bash

    $ git clone https://github.com/PKU-Alignment/omnisafe.git
    $ cd omnisafe
    $ conda create -n omnisafe python=3.8
    $ conda activate omnisafe
    $ pip install -e .

Installation Video
------------------

Here we provide a video tutorial for installing OmniSafe on Ubuntu.

.. admonition:: Video Tutorial
    :class: hint

    Install OmniSafe From PyPI

    .. raw:: html

        <script async id="asciicast-Dd11OHl9SgqNWVyhN0VpVeEzs" src="https://asciinema.org/a/Dd11OHl9SgqNWVyhN0VpVeEzs.js"></script>

    Install OmniSafe From Source

    .. raw:: html

        <script async id="asciicast-wiTrVKYmJ1EPKe4UH0TYNYALI" src="https://asciinema.org/a/wiTrVKYmJ1EPKe4UH0TYNYALI.js"></script>
