Skip to content

Commit 3028105

Browse files
committed
Minor formatting updates
1 parent bcb081c commit 3028105

3 files changed

Lines changed: 8 additions & 7 deletions

File tree

docs/binary_output.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ For cases where large domains are considered and/or full domain output is requir
1717
#--IO
1818
ioOutputMode = 1
1919
20-
In this case, rank-wise binary output files. Personalize and use the batch submission script **/scripts/batch_jobs/fasteddy_convert_pbs_script_casper.sh** which will invoke a python script (**/scripts/python_utilities/post-processing/FEbinaryToNetCDF.py**) to convert the rank-wise binary files from each output timestep into a single aggregate netCDF output file per timestep. Users can run the following `conda activate` command if running on Casper:
20+
In this case, rank-wise binary output files. Personalize and use the batch submission script **/scripts/batch_jobs/fasteddy_convert_pbs_script_casper.sh** which will invoke a python script (**/scripts/python_utilities/post-processing/FEbinaryToNetCDF.py**) to convert the rank-wise binary files from each output timestep into a single aggregate netCDF output file per timestep. Users can run the following :code:`conda activate` command if running on Casper:
2121

2222
.. code::
2323
@@ -30,10 +30,11 @@ The **convert.json** file controls the specifics of the conversion as follows:
3030
:header-rows: 1
3131
:delim: ;
3232
:class: binary
33-
33+
3434
.. note::
3535

36-
- FastEddy can only restart from a netCDF file, irrespective of the :code:`ioOutputMode` options used.
36+
FastEddy can only restart from a netCDF file, irrespective of the :code:`ioOutputMode` options used.
37+
3738

3839
Profiles
3940
========

docs/csv/efficient_output_full.csv

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Name; Description
2-
outpath; Path to the root directory containing the rank-wise binary output files. |br| This is ‘outPath‘ in the *.in file.
3-
FEoutBase; Base simulation name string used as a prefix for output filenames. |br| This is ‘outFileBase‘ in the *.in file.
4-
numOutRanks; Total number of GPUs used to run the simulation (integer). |br| This is ‘numProcsX*numProcsY‘ in the *.in file.
2+
outpath; Path to the root directory containing the rank-wise binary output files. |br| This is ‘outPath‘ in the \*.in file.
3+
FEoutBase; Base simulation name string used as a prefix for output filenames. |br| This is ‘outFileBase‘ in the \*.in file.
4+
numOutRanks; Total number of GPUs used to run the simulation (integer). |br| This is ‘numProcsX*numProcsY‘ in the \*.in file.
55
fileSetSize; Number of files to be converted to netCDF (integer).
66
tstart; Simulation timestep where the file conversion starts (integer).
77
tstep; Timestep increment between output files to be converted (integer).

docs/csv/efficient_output_prof.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Name; Description
2-
runPath; Path to the root directory containing the binary profile output files. |br| This is ‘towerPath‘ in the *.in file.
2+
runPath; Path to the root directory containing the binary profile output files. |br| This is ‘towerPath‘ in the \*.in file.
33
FEparamsFile; FastEddy params.in file.
44
outputFileName; Name of the profile netCDF file.
55
startStep; Simulation timestep where the profile conversion starts (integer).

0 commit comments

Comments
 (0)