.. index:: pair: page; Getting started
.. _doxid-getting_started:

Getting started
===============

In order to start working with NRP-core, the latter must be first compiled and installed. The installation guide can be found in the following page: :ref:`Installation Instructions <doxid-installation>`

We provide a number of example experiments within the NRP-core repository. They are located in the ``examples`` subdirectory. They give a good overview of the capabilities of the NRP and should be relatively easy to adapt to user-specific needs. More details about running these experiments can be found on the pages: :ref:`Running the example experiments <doxid-running_example_exp>`, :ref:`Running the example experiments inside different Docker containers <doxid-running_example_docker_exp>` and :ref:`Running the experiments inside different Docker containers with docker-compose <doxid-running_example_docker_compose>`.

This :ref:`page <doxid-python_client>` describes how to run NRP-Core experiments from Python.

Please take note that some of the examples may require additional models or dependencies, which may be not included in the NRP-core repository. More information can be found in our :ref:`guide <doxid-tutorial_helpful_info>`.

.. toctree::
	:hidden:

	page_installation.rst
	page_running_example_docker_exp.rst
	page_running_example_docker_compose.rst
	page_python_client.rst
	page_running_example_exp.rst

.. rubric:: Related Pages:

|	:doc:`page_installation`
|	:doc:`page_running_example_docker_exp`
|	:doc:`page_running_example_docker_compose`
|	:doc:`page_python_client`
|	:doc:`page_running_example_exp`