Skip to content

Commit 00d819a

Browse files
authored
Update README.rst
1 parent 30e193d commit 00d819a

File tree

1 file changed

+31
-24
lines changed

1 file changed

+31
-24
lines changed

README.rst

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -292,8 +292,8 @@ conditions. Each configuration contains its respective ``Jobfile``,
292292
Scientific instruments like Flash-X require input during execution which
293293
is supplied in the form of parfiles with a ``.par`` extension. The
294294
parfiles along a directory tree are combined to create a single input
295-
file when submitting the job. For example, invocation of ``jobrunner
296-
submit simulation/PoolBoiling/earth_gravity`` combines
295+
file when submitting the job. For example, invocation of
296+
``jobrunner submit simulation/PoolBoiling/earth_gravity`` combines
297297
``pool_boiling.par`` and ``earth_gravity.par`` that is used to run the
298298
target executable ``flashx`` using the combination of ``environment.sh``
299299
and ``flashRun.sh``.
@@ -353,43 +353,43 @@ archiving or cleaning by extending the ``Jobfile`` for each study,
353353
Setup
354354
=====
355355

356-
``jobrunner setup <JobWorkDir>`` creates a ``job.setup`` file in
357-
``<workdir>`` using ``job.setup`` scripts defined in Jobfiles along the
356+
``jobrunner setup <JobWorkDir>`` creates a ``job.setup`` file
357+
using ``job.setup`` scripts defined in Jobfiles along the
358358
directory tree. Jobrunner executes each script serially by changing the
359359
working directory to the location of the script. A special environment
360360
variable ``JobWorkDir`` provides the value of ``<JobWorkDir>`` supplied
361361
during invocation of the command.
362362

363363
The ``--show`` option can be used to check which bash scripts will be
364-
included during invocation. Following is the result of ``jobrunner setup
365-
--show JobObject2`` for the example above,
364+
included during invocation. Following is the result of
365+
``jobrunner setup --show simulation/PoolBoiling`` for the example above,
366366

367-
.. code::
367+
.. code:: console
368368
369-
Working directory: /Project/JobObject2
369+
Working directory: /Project/simulation/PoolBoiling
370370
Parsing Jobfiles in directory tree
371371
372372
job.setup: [
373373
/Project/environment.sh
374-
/Project/JobObject2/setupScript.sh
374+
/Project/simulation/PoolBoiling/flashSetup.sh
375375
]
376376
377377
Submit
378378
======
379379

380-
``jobrunner submit <JobWorkDir>`` creates a ``job.submit`` file in
381-
``<JobWorkDir>`` using ``job.submit`` scripts and ``schedular.options``
380+
``jobrunner submit <JobWorkDir>`` creates a ``job.submit`` file
381+
using ``job.submit`` scripts and ``schedular.options``
382382
values defined in Jobfiles along the directory tree.
383-
``schedular.command`` is used to dispatch the result script.
383+
``schedular.command`` is used to dispatch the resulting script.
384384

385385
The ``--show`` option can be used to check schedular configuration and
386386
list of bash scripts that will be included during invocation. Following
387-
is the result of ``jobrunner submit --show JobObject2/Config2`` for the
388-
example above,
387+
is the result of ``jobrunner submit --show simulation/PoolBoiling/earth_gravity``
388+
for the example above,
389389

390-
.. code::
390+
.. code:: console
391391
392-
Working directory: /Project/JobObject2/Config2
392+
Working directory: /Project/simulation/PoolBoiling/earth_gravity
393393
Parsing Jobfiles in directory tree
394394
395395
schedular.command:
@@ -400,20 +400,18 @@ example above,
400400
#SBATCH --ntasks=5
401401
]
402402
job.input: [
403-
/Project/JobObject2/flash.par
404-
/Project/JobObject2/Config2/flash.par
403+
/Project/simulation/PoolBoiling/pool_boiling.par
404+
/Project/simulation/PoolBoiling/earth_gravity/earth_gravity.par
405405
]
406406
job.target:
407-
/Project/JobObject2/flashx
407+
/Project/simulation/PoolBoiling/flashx
408408
job.submit: [
409409
/Project/environment.sh
410-
/Project/JobObject2/preProcess.sh
411-
/Project/JobObject2/submitScript.sh
410+
/Project/simulation/PoolBoiling/flashRun.sh
412411
]
413412
414413
Along with the ``job.submit`` script, ``job.input`` and ``job.target``
415-
files are also created in ``<JobWorkDir>`` and created using values
416-
defined in Jobfiles.
414+
files are also created in ``<JobWorkDir>`` using values defined in Jobfiles.
417415

418416
Archive
419417
=======
@@ -445,7 +443,16 @@ which can be found in following repositories:
445443

446444
- `akashdhruv/Multiphase-Simulations
447445
<https://github.com/akashdhruv/Multiphase-Simulations>`_: A
448-
collection of high-fidelity flow/pool boiling simulations
446+
lab notebook to manage development of Flash-X
447+
448+
- `Lab-Notebooks/Outflow-Forcing-BubbleML
449+
<https://github.com/Lab-Notebooks/Outflow-Forcing-BubbleML>`_: Reproducibility
450+
capsule for research papers (https://arxiv.org/pdf/2306.10174.pdf) (https://arxiv.org/pdf/2307.14623.pdf)
451+
452+
- `Lab-Notebooks/Flow-Boiling-3DL
453+
<https://github.com/Lab-Notebooks/Flow-Boiling-3D>`_: Execution environment for
454+
running three-dimensional flow boiling simulations on high performance computing
455+
systems.
449456

450457
**********
451458
Citation

0 commit comments

Comments
 (0)