Setting up a development environment
=====================================

Trident has a few prerequisites which must be installed before you can start
compiling and making changes to the project. They are as follows:

#. Git
#. Python >= 3.8
#. SCons
#. Conan
#. A compiler (Visual Studio for Windows, GCC for Linux)

For detailed instructions, see the
`Development section of the User Guide <https://www.ngltm.no/documentation/book/dev/development.html>`__.

Linux
----------

On Linux, you can run :download:`the following script <./install.sh>` from the
base directory of the project to get started:

.. literalinclude:: install.sh
   :language: shell

This should be enough to configure the environment, and do a basic build at the
end to verify that it was set up correctly.

Windows
----------

When using Windows, the following options are available:

#. Build, test and run Trident directly on Windows
#. Build, test and run Trident in Windows Subsystem for Linux (WSL) with Ubuntu
#. Build, test and run Trident in a VSCode development container with Ubuntu

For building on Windows directly, or with a VSCode development container, see
the
`Windows <https://www.ngltm.no/documentation/book/dev/prepare_dev_env_win.html>`__
or
`VSCode devcontainer <https://www.ngltm.no/documentation/book/dev/prepare_dev_env_devcontainer.html>`__
sections of the User Guide.

WSL
^^^^^^^^^^

To use WSL, first install it by running the following command in the Windows
terminal:

.. code-block:: powershell

   wsl --install

Then enter and set up WSL by simply running the ``wsl`` command. You may be
asked to restart your computer at some point in the process. Do so and proceed
through the installation process.

Once you've successfully installed and activated WSL, follow the instructions in
the `Linux`_ section to get set up.