Skip to content

Commit

Permalink
Update paths for internal links
Browse files Browse the repository at this point in the history
  • Loading branch information
WardLT committed Dec 31, 2024
1 parent b4d412c commit e0cd13a
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/devguide/roadmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Code Maintenance
* **Type Annotations and Static Type Checking**: Add static type annotations throughout the codebase and add typeguard checks.
* **Release Process**: `Improve the overall release process <https://github.com/Parsl/parsl/issues?q=is%3Aopen+is%3Aissue+label%3Arelease_process>`_ to synchronize docs and code releases, automatically produce changelog documentation.
* **Components Maturity Model**: Defines the `component maturity model <https://github.com/Parsl/parsl/issues/2554>`_ and tags components with their appropriate maturity level.
* **Define and Document Interfaces**: Identify and document interfaces via which `external components <https://parsl.readthedocs.io/en/stable/userguide/plugins.html>`_ can augment the Parsl ecosystem.
* **Define and Document Interfaces**: Identify and document interfaces via which `external components <https://parsl.readthedocs.io/en/stable/userguide/advanced/plugins.html>`_ can augment the Parsl ecosystem.
* **Distributed Testing Process**: All tests should be run against all possible schedulers, using different executors, on a variety of remote systems. Explore the use of containerized schedulers and remote testing on real systems.

New Features and Integrations
Expand Down
8 changes: 4 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Parsl - Parallel Scripting Library
Parsl extends parallelism in Python beyond a single computer.

You can use Parsl
`just like Python's parallel executors <userguide/workflow.html#parallel-workflows-with-loops>`_
`just like Python's parallel executors <userguide/workflows/workflow.html#parallel-workflows-with-loops>`_
but across *multiple cores and nodes*.
However, the real power of Parsl is in expressing multi-step workflows of functions.
Parsl lets you chain functions together and will launch each function as inputs and computing resources are available.
Expand Down Expand Up @@ -37,8 +37,8 @@ Parsl lets you chain functions together and will launch each function as inputs
Start with the `configuration quickstart <quickstart.html#getting-started>`_ to learn how to tell Parsl how to use your computing resource,
see if `a template configuration for your supercomputer <userguide/configuring.html>`_ is already available,
then explore the `parallel computing patterns <userguide/workflow.html>`_ to determine how to use parallelism best in your application.
see if `a template configuration for your supercomputer <userguide/configuration/examples.html>`_ is already available,
then explore the `parallel computing patterns <userguide/workflows/workflows.html>`_ to determine how to use parallelism best in your application.

Parsl is an open-source code, and available on GitHub: https://github.com/parsl/parsl/

Expand All @@ -57,7 +57,7 @@ Parsl works everywhere

*Parsl can run parallel functions on a laptop and the world's fastest supercomputers.*
Scaling from laptop to supercomputer is often as simple as changing the resource configuration.
Parsl is tested `on many of the top supercomputers <userguide/configuring.html>`_.
Parsl is tested `on many of the top supercomputers <userguide/configuration/examples.html>`_.

Parsl is flexible
-----------------
Expand Down
14 changes: 7 additions & 7 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ We describe these components briefly here, and link to more details in the `User

.. note::

Parsl's documentation includes `templates for many supercomputers <userguide/configuring.html>`_.
Parsl's documentation includes `templates for many supercomputers <userguide/configuring/examples.html>`_.
Even though you may not need to write a configuration from a blank slate,
understanding the basic terminology below will be very useful.

Expand Down Expand Up @@ -112,7 +112,7 @@ with hello world Python and Bash apps.
with open('hello-stdout', 'r') as f:
print(f.read())
Learn more about the types of Apps and their options `here <userguide/apps.html>`__.
Learn more about the types of Apps and their options `here <userguide/apps/index.html>`__.

Executors
^^^^^^^^^
Expand All @@ -127,7 +127,7 @@ You can dynamically set the number of workers based on available memory and
pin each worker to specific GPUs or CPU cores
among other powerful features.

Learn more about Executors `here <userguide/execution.html#executors>`__.
Learn more about Executors `here <userguide/configuration/execution.html#executors>`__.

Execution Providers
^^^^^^^^^^^^^^^^^^^
Expand All @@ -141,7 +141,7 @@ Another key role of Providers is defining how to start an Executor on a remote c
Often, this simply involves specifying the correct Python environment and
(described below) how to launch the Executor on each acquired computers.

Learn more about Providers `here <userguide/execution.html#execution-providers>`__.
Learn more about Providers `here <userguide/configuration/execution.html#execution-providers>`__.

Launchers
^^^^^^^^^
Expand All @@ -151,7 +151,7 @@ A common example is an :class:`~parsl.launchers.launchers.MPILauncher`, which us
for starting a single program on multiple computing nodes.
Like Providers, Parsl comes packaged with Launchers for most supercomputers and clouds.

Learn more about Launchers `here <userguide/execution.html#launchers>`__.
Learn more about Launchers `here <userguide/configuration/execution.html#launchers>`__.


Benefits of a Data-Flow Kernel
Expand All @@ -164,7 +164,7 @@ and performs the many other functions needed to execute complex workflows.
The flexibility and performance of the DFK enables applications with
intricate dependencies between tasks to execute on thousands of parallel workers.

Start with the Tutorial or the `parallel patterns <userguide/workflow.html>`_
Start with the Tutorial or the `parallel patterns <userguide/workflows/workflow.html>`_
to see the complex types of workflows you can make with Parsl.

Starting Parsl
Expand Down Expand Up @@ -210,7 +210,7 @@ An example which launches 4 workers on 1 node of the Polaris supercomputer looks
)
The documentation has examples for other supercomputers `here <userguide/configuring.html>`__.
The documentation has examples for other supercomputers `here <userguide/configuration/examples.html>`_.

The next step is to load the configuration

Expand Down
2 changes: 1 addition & 1 deletion docs/userguide/apps/bash.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,5 @@ MPI Apps
^^^^^^^^

Applications which employ MPI to span multiple nodes are a special case of Bash apps,
and require special modification of Parsl's `execution environment <execution.html>`_ to function.
and require special modification of Parsl's `execution environment <../configuration/execution.html>`_ to function.
Support for MPI applications is described `in a later section <mpi_apps.html>`_.
4 changes: 2 additions & 2 deletions docs/userguide/apps/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,10 +168,10 @@ There are several classes of allowed types, each with different rules.
capital_future = capitalize(first_line_future)
print(capital_future.result())
See the section on `Futures <futures.html>`_ for more details.
See the section on `Futures <../workflows/futures.html>`_ for more details.


Learn more about the types of data allowed in `the data section <data.html>`_.
Learn more about the types of data allowed in `the data section <../configuration/data.html>`_.

.. note::

Expand Down

0 comments on commit e0cd13a

Please sign in to comment.