Quickstart
==========

This is a quick start guide to get you up and running with the SDP Resource Model.

1. Open a terminal and navigate to the directory you want to install the project.
2. Install the project and start the resource model dashboard. This will use default the
   configuration.

.. code-block:: bash

    git clone --recurse-submodules https://gitlab.com/ska-telescope/sdp/ska-sdp-resource-model.git
    cd ska-sdp-resource-model
    poetry install
    poetry run resource_model

3. Open a web browser and paste this link: http://127.0.0.1:8050/.
4. Interact with the plots to experiment with the simulation results.
5. Use ``Ctrl + C`` to stop the server.

Now that you are up and running, explore the rest of the documentation, which covers different ways
of using and configuring the SDP Resource Model.

Working in a container
----------------------

This project provides a pre-configured development container for a consistent and reproducible
development environment. You can use the container to avoid manual setup and ensure all dependencies
are installed. For detailed instructions and features, see the `Development Container README
<https://gitlab.com/ska-telescope/sdp/ska-sdp-resource-model/-/blob/main/.devcontainer/README.md>`_.