Skip to content

Commit

Permalink
docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
msiket-iit committed Nov 27, 2024
1 parent 73ed663 commit e3b74f5
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 5 deletions.
Binary file removed docs/source/imgs/2024-11-2111-28-48conv.gif
Binary file not shown.
43 changes: 38 additions & 5 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,36 @@
Quickstart
============

To get started immediately, run :code:`interface_cmd.py` to activate a command line interface (CLI).
Requirements
-----------------

* Python 3.12.0
* Dependencies can be installed via :code:`pip install -r requirements.txt`


Graphical User Interface
-----------------------------

Provides a graphical user interface in a web app.

To run it locally:

blocks::

> streamlit run interface_gui.py

.. image:: imgs/gui.gif
:target: _images/gui.gif

Command Line - Interactive
--------------------------------

Provides an interactive prompt environment to set the simulation settings.

To get started run :code:`interface_cmd.py` to activate a command line interface (CLI).

Run the simulator
------------
* :code:`simulate` This command is used to run the simulation with the assigned settings.
* Using just :code:`simulate` generates a default scenario (`defaults </_autosummary/pymgipsim.Settings.DefaultSettings.html>`_).
* Using just :code:`simulate` generates a default scenario.
* Predefined scenarios are available in the :code:`./Scenarios/` folder. To use one of them, use :code:`load -sn <scenario name>` and :code:`simulate`.
* Results are stored in the directory :code:`./SimulationResults/<results folder with datetime from simulation run time>`

Expand All @@ -18,4 +41,14 @@ Plot the results
* :code:`plot` This command is used to generate plots from the simulation results.
* :code:`plot -h` lists the arguments that can be used with :code:`plot <arguments>`
* :code:`plot` with no arguments generates and saves all figures without displaying them.
* :code:`plot --all` both generates and displays all figures.
* :code:`plot --all` both generates and displays all figures.

.. image:: imgs/cmd.gif
:target: _images/cmd.gif

Command Line - single command
----------------------------------
Simulation settings are defined in a single command line.

Start by running :code:`interface_cli.py [OPTIONS]`.

0 comments on commit e3b74f5

Please sign in to comment.