Skip to content

Commit 723cc3e

Browse files
committed
wording
1 parent 4df3aeb commit 723cc3e

7 files changed

Lines changed: 12 additions & 12 deletions

File tree

docs/dev_guide/release_management/release_process.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Before release
3333

3434
- On-line CI (GitHub Actions) tests must pass.
3535

36-
- Launch and verify extra tests: ``gh workflow run libEnsemble-complete-CI --ref release/branch_name``
36+
- Launch and verify extra tests: ``gh workflow run libEnsemble-complete-CI --ref branch_name``
3737

3838
- Scaling tests must be run on HPC platforms listed as supported in release notes.
3939
Test variants by platform, launch mechanism, scale, and other factors can

docs/function_guides/generator.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Most ``gen_f`` function definitions written by users resemble::
4949

5050
where:
5151

52-
* ``Input`` is a selection of the :ref:`History array<funcguides-history>`, a NumPy array.
52+
* ``Input`` is a selection of the :ref:`History array<funcguides-history>`, a NumPy structured array.
5353
* :ref:`persis_info<datastruct-persis-info>` is a dictionary containing state information.
5454
* :ref:`gen_specs<datastruct-gen-specs>` is a dictionary of generator parameters.
5555
* ``libE_info`` is a dictionary containing miscellaneous entries.
@@ -221,7 +221,7 @@ of the capability to cancel pending simulations.
221221
Modification of existing points
222222
-------------------------------
223223

224-
To change existing fields of the History array, create a NumPy array where the ``dtype`` contains
224+
To change existing fields of the History array, create a NumPy structured array where the ``dtype`` contains
225225
the ``sim_id`` and the fields to be modified. Send this array with ``keep_state=True`` to the manager.
226226
This will overwrite the manager's History array.
227227

docs/function_guides/simulator.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Most ``sim_f`` function definitions written by users resemble::
4949

5050
where:
5151

52-
* ``Input`` is a selection of the :ref:`History array<funcguides-history>`, a NumPy array.
52+
* ``Input`` is a selection of the :ref:`History array<funcguides-history>`, a NumPy structured array.
5353
* :ref:`persis_info<datastruct-persis-info>` is a dictionary containing state information.
5454
* :ref:`sim_specs<datastruct-sim-specs>` is a dictionary of simulation parameters.
5555
* ``libE_info`` is a dictionary containing libEnsemble-specific entries.

docs/platforms/aurora.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Aurora
44

55
Aurora_ is an Intel/HPE EX supercomputer located in the ALCF_ at Argonne
66
National Laboratory. Each compute node contains two Intel (Sapphire Rapids)
7-
Xeon CPUs and six Intel X\ :sup:`e` GPUs (Ponte Vecchio) each with two tiles.
7+
Xeon CPUs and six Intel X\ :sup:`e` GPUs (Ponte Vecchio), each with two tiles.
88

9-
The PBS scheduler is used to submit jobs from login nodes to run on the
10-
compute nodes.
9+
The PBS scheduler is used to submit jobs from login nodes to run on compute
10+
nodes.
1111

1212
Configuring Python and Installation
1313
-----------------------------------

docs/platforms/improv.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ options for installing libEnsemble, including using Spack.
2121
Job Submission
2222
--------------
2323

24-
Improv uses the PBS scheduler to submit jobs from login nodes to run on the
25-
compute nodes.
24+
Improv uses the PBS scheduler to submit jobs from login nodes to run on compute
25+
nodes.
2626

2727
Example
2828
-------

docs/tutorials/executor_forces_tutorial.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Registering an application is as easy as providing the full file-path and giving
5252
it a memorable name. This Executor will later be used within our simulation
5353
function to launch the registered app.
5454

55-
The last line above initializes the ensemble. The :meth:`parse_args<tools.parse_args>`
55+
The last line in the above codeblock initializes the ensemble. The :meth:`parse_args<tools.parse_args>`
5656
parameter is used to read `comms` and `nworkers` from the command line. This sets
5757
the respective `libE_specs` options.
5858

libensemble/sim_funcs/mock_sim.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33

44
def mock_sim(H, persis_info, sim_specs, libE_info):
5-
"""Places sim_specs["out"] from a numpy file into the outputs. Allow user
5+
"""Places sim_specs["out"] from a numpy file into the outputs. Allows a user
66
to reproduce an existing run while, for example, capturing additional
7-
information from a gen. Requires user to have set
7+
information from a gen. Requires a user to have set
88
sim_specs["user"]["history_file"] to point to a history file from a previous run.
99
"""
1010

0 commit comments

Comments
 (0)