Skip to content

Commit

Permalink
Fixes/into v1.0 release (#1093)
Browse files Browse the repository at this point in the history
* remove unneeded symlinks leftover from theme experiments

* organize rst_formatting_guidelines

* replace most references to funcX with Globus Compute
  • Loading branch information
jlnav authored Sep 22, 2023
1 parent 269a8b2 commit 658aa9d
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/advanced_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ The following packages may be installed separately to enable additional features
.. _Balsam: https://balsam.readthedocs.io/en/latest/
.. _conda-forge: https://conda-forge.org/
.. _Conda: https://docs.conda.io/en/latest/
.. _Globus Compute: https://funcx.readthedocs.io/en/latest/
.. _Globus Compute: https://www.globus.org/compute
.. _GitHub: https://github.com/Libensemble/libensemble
.. _MPICH: https://www.mpich.org/
.. _NumPy: http://www.numpy.org
Expand Down
2 changes: 0 additions & 2 deletions docs/introduction_latex.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. include:: introduction.rst

.. _across: https://libensemble.readthedocs.io/en/develop/platforms/platforms_index.html#funcx-remote-user-functions
.. _APOSMM: https://link.springer.com/article/10.1007/s12532-017-0131-4
.. _AWA: https://link.springer.com/article/10.1007/s12532-017-0131-4
.. _Balsam: https://balsam.readthedocs.io/en/latest/
Expand All @@ -14,7 +13,6 @@
.. _DFO-LS: https://github.com/numericalalgorithmsgroup/dfols
.. _ECNoise: https://www.mcs.anl.gov/~wild/cnoise/
.. _example user scripts: https://libensemble.readthedocs.io/en/main/examples/examples_index.html
.. _funcX: https://funcx.org/
.. _GitHub: https://github.com/Libensemble/libensemble
.. _GitHub Actions: https://github.com/Libensemble/libensemble/actions
.. _IPAC manuscript: https://doi.org/10.18429/JACoW-ICAP2018-SAPAF03
Expand Down
6 changes: 3 additions & 3 deletions docs/platforms/platforms_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,15 +144,15 @@ libE_specs option.
When using the MPI Executor, it is possible to override the detected information using the
`custom_info` argument. See the :doc:`MPI Executor<../executor/mpi_executor>` for more.

.. _funcx_ref:
.. _globus_compute_ref:

Globus Compute - Remote User Functions
--------------------------------------

*Alternatively to much of the above*, if libEnsemble is running on some resource with
internet access (laptops, login nodes, other servers, etc.), workers can be instructed to
launch generator or simulator user function instances to separate resources from
themselves via `Globus Compute`_, a distributed, high-performance function-as-a-service platform:
themselves via `Globus Compute`_ (formerly funcX), a distributed, high-performance function-as-a-service platform:

.. image:: ../images/funcxmodel.png
:alt: running_with_globus_compute
Expand Down Expand Up @@ -196,7 +196,7 @@ argument. For example::
globus_compute_endpoint = "3af6dc24-3f27-4c49-8d11-e301ade15353",
)

See the ``libensemble/tests/scaling_tests/funcx_forces`` directory for a complete
See the ``libensemble/tests/scaling_tests/globus_compute_forces`` directory for a complete
remote-simulation example.

Instructions for Specific Platforms
Expand Down
2 changes: 1 addition & 1 deletion docs/running_libE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ The default is ``mpi``.
Set ``comms`` to ``ssh`` to launch workers on remote ssh-accessible systems. This
colocates workers, functions, and any applications. User
functions can also be persistent, unlike when launching remote functions via
:ref:`Globus Compute<funcx_ref>`.
:ref:`Globus Compute<globus_compute_ref>`.

The remote working directory and Python need to be specified. This may resemble::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ exit_criteria:
sim_max: 8

sim_specs:
sim_f: libensemble.tests.scaling_tests.forces.funcx_forces.forces_simf.run_forces_globus_compute
sim_f: libensemble.tests.scaling_tests.forces.globus_compute_forces.forces_simf.run_forces_globus_compute
inputs:
- x
outputs:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,20 @@ See below.

### Running with libEnsemble.

On the remote machine:

pip install funcx-endpoint
funcx-endpoint configure forces

Configure the endpoint's `config.py` to include your project information and
On the remote machine, Configure the endpoint's `config.py` to include your project information and
match the machine's specifications.
See [here](https://funcx.readthedocs.io/en/latest/endpoints.html#theta-alcf) for
an example ALCF Theta configuration.

Then to run with local comms (multiprocessing) with one manager and `N` workers:

python run_libe_forces_funcx.py --comms local --nworkers N
python run_libe_forces_globus_compute.py --comms local --nworkers N

To run with MPI comms using one manager and `N-1` workers:

mpirun -np N python run_libe_forces.py
mpirun -np N python run_libe_forces_globus_compute.py

Application parameters can be adjusted in `funcx_forces.yaml`.
Application parameters can be adjusted in `globus_compute_forces.yaml`.

Note that each function and path must be accessible and/or importable on the
remote machine. Absolute paths are recommended.
Expand Down

0 comments on commit 658aa9d

Please sign in to comment.