Skip to content

Commit

Permalink
Added initial doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
proy30 committed Aug 5, 2024
1 parent 0a32b52 commit d3427a4
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions docs/source/usage/dashboard.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
.. _usage-python:

Dashboard
==================

This document provides instructions on how to use the `impactx-dashboard`.

Installing Dependencies
-----------------------
From the `impactx/src/python/impactx/dashboard` directory, execute:

.. code-block:: bash
pip install -r requirements.txt
Launching the Dashboard
-----------------------

There are two ways to launch the Dashboard GUI, depending on your use case:

- **Using the CLI Command**: This is the recommended method for most users. It is straightforward and requires minimal setup.
- **Using the Python Module**: This method is more flexible and is particularly useful for developers who need to make direct
changes to the dashboard, integrate it with other Python scripts, or run it in a specific environment.

1. **Direct Command Execution**
From the base ImpactX directory, execute:

.. code-block:: bash
impactx-dashboard
2. **Python Module Execution**
From the `impactx/src/python/impactx` directory, execute:

.. code-block:: bash
python -m dashboard
3. **Access the GUI**

Open a web browser and navigate to `http://localhost:8080` to access the Dashboard GUI.

#TODO accessing through Jupyter

0 comments on commit d3427a4

Please sign in to comment.