Skip to content

Commit

Permalink
Small documentation addition in response to reviewer comments
Browse files Browse the repository at this point in the history
  • Loading branch information
espottesmith committed Oct 25, 2024
1 parent a66461b commit 95c83da
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
4 changes: 3 additions & 1 deletion GMC.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,4 +147,6 @@ When running `GMC` ensure that your input file paths are correct considering the

```
build/GMC --reaction_database=examples/GMC/end-to-end-test/rn.sqlite --initial_state_database=examples/GMC/end-to-end-test/initial_state_copy.sqlite --number_of_simulations=1000 --base_seed=1000 --thread_count=8 --step_cutoff=200 --energy_budget=0 --checkpoint=1
```
```

Running this command does not generate any new files or directories but will populate the `initial_state_database` with trajectory data.
4 changes: 3 additions & 1 deletion LGMC.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,4 +182,6 @@ When running LGMC ensure that your input file paths are correct considering the

```
build/LGMC --lattice_reaction_database=examples/LGMC/CO_oxidation/rn.sqlite --initial_state_database=examples/LGMC/CO_oxidation/initial_state.sqlite --number_of_simulations=1000 --base_seed=1000 --thread_count=8 --step_cutoff=200 --checkpoint=1 --parameters=examples/LGMC/CO_oxidation/LGMC_params.txt
```
```

Running this command does not generate any new files or directories but will populate the `initial_state_database` with trajectory data.
4 changes: 3 additions & 1 deletion NPMC.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,4 +170,6 @@ When running `NPMC` ensure that your input file paths are correct considering th

```
build/NPMC --nano_particle_database=examples/NPMC/np.sqlite --initial_state_database=examples/NPMC/initial_state.sqlite --number_of_simulations=1000 --base_seed=1000 --thread_count=8 --step_cutoff=200 --checkpoint=1
```
```

Running this command does not generate any new files or directories but will populate the `initial_state_database` with trajectory data.

0 comments on commit 95c83da

Please sign in to comment.