Skip to content

Commit

Permalink
upgrade sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
amandarichardsonn committed Nov 1, 2024
1 parent 98e4590 commit ded7d08
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 24 deletions.
32 changes: 11 additions & 21 deletions doc/launch_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,9 @@ SmartSim’s ``LaunchSettings`` supports multiple launchers, allowing users to s
Additionally, this class provides methods to access and configure these settings, as well as retrieve information associated with
the ``LaunchSettings`` object.

**Dragon** is the fastest and most versatile distributed runtime available for HPC workflows. It can function as a
launcher within a Slurm allocation, providing rapid, interactive, and customizable execution of complex workflows
on large HPC systems. As a scheduler-agnostic solution, Dragon allows the same SmartSim script to run on both Slurm and
PBS systems, with future support for additional schedulers.
**Dragon** is a launcher which that enables fast, interactive, and customizable execution of complex
workflows on HPC systems. It works within a Slurm allocation, making it easy to run large workflows
efficiently on HPC machines. Additional launcher support is coming soon.

===================
Supported Launchers
Expand Down Expand Up @@ -80,7 +79,7 @@ runtime for HPC workflows. SLURM is a open-source job scheduler and resource man
- **Description**
* - ``srun``
- Simple Linux Utility for Resource Management (SLURM).
* - ``dragonrun``
* - ``n/a``
- High-performance computing launcher for large-scale jobs (Dragon).

Local
Expand Down Expand Up @@ -191,7 +190,7 @@ varaible ``launcher`` to a launcher string such as `"slurm"`. For example:
env_vars={"MY_VAR": "my_value"}
)
**Example using an Enum:**
**Example using a LauncherType Enum:**
Once you have imported ``LaunchSettings`` and ``LauncherType`` using ``from smartsim import LaunchSettings, LauncherType``,
set the input variable ``launcher`` to a ``LauncherType`` enum such as ``LauncherType.Slurm``. For example:

Expand All @@ -203,9 +202,9 @@ set the input variable ``launcher`` to a ``LauncherType`` enum such as ``Launche
env_vars={"MY_VAR": "my_value"}
)
=========
Configure
=========
======
Modify
======
After initializing a ``LaunchSettings`` object, you might want to go back and configure ``launch_args`` or
``env_vars``. Configuring these settings allows you to fine-tune the execution environment
to meet the specific needs of different jobs.
Expand All @@ -222,12 +221,13 @@ These functions allow you to customize launch arguments after initializing the `
**Option 1: Use LaunchSettings.launch_args.set**

To set additional launch arguments after initializing the ``LaunchSettings`` object,
use the `set` method on `launch_args` as shown below:
use the ``set`` method on ``launch_args`` as shown below:

.. code-block:: python
launch_settings.launch_args.set("--nodes", "2")
TODO: dragon example, syntanx is truly launcher specific
**Option 2: Use custom HPC launcher methods**

The ``LaunchSettings`` class provides custom methods to set launch arguments for different launchers.
Expand Down Expand Up @@ -334,14 +334,4 @@ of environment settings without overwriting it. For example:

.. code-block:: python
launch_settings.update_env({"MY_VAR": "new_value", "ANOTHER_VAR": "another_value"})
========
Examples
========

Local
=====

HPC
===
launch_settings.update_env({"MY_VAR": "new_value", "ANOTHER_VAR": "another_value"})
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -143,12 +143,12 @@ class BuildError(Exception):
"typing_extensions>=4.1.0",
],
"docs": [
"Sphinx==6.2.1",
"Sphinx==8.1.3",
"breathe==4.35.0",
"sphinx-fortran==1.1.1",
"sphinx-book-theme==1.0.1",
"sphinx-book-theme",
"sphinx-copybutton==0.5.2",
"sphinx-tabs==3.4.4",
"sphinx-tabs",
"nbsphinx==0.9.3",
"docutils==0.18.1",
"torch==2.0.1",
Expand Down

0 comments on commit ded7d08

Please sign in to comment.