From ce7fbc1a1ccaf095d9bc3692c0924cd838326ca3 Mon Sep 17 00:00:00 2001 From: lzichi Date: Mon, 5 Aug 2024 11:30:07 -0400 Subject: [PATCH] updated executable paths --- GMC.md | 5 ++--- LGMC.md | 6 +++--- NPMC.md | 6 +++--- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/GMC.md b/GMC.md index ee63cd9..84faed4 100644 --- a/GMC.md +++ b/GMC.md @@ -119,7 +119,7 @@ To access the makefile, enter the `GMC` folder: $ cd GMC ``` -Next create an executable with the makefile. The executable will be located in the `GMC` folder. +Next create an executable with the makefile. The executable will be located in the `build` folder. ``` $ make GMC @@ -143,8 +143,7 @@ $ make help - energy_budget : allowed energy to be added into the system. - checkpoint : whether checkpointing should occur. - -When running `GMC` ensure that your input file paths are correct considering the executable is inside the build folder. Below is an example of how `GMC` can be run using the input files inside the examples directory (here `step_cutoff` is specified): +When running `GMC` ensure that your input file paths are correct considering the executable is inside the `build` folder. Below is an example of how `GMC` can be run using the input files inside the examples directory (here `step_cutoff` is specified): ``` 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 diff --git a/LGMC.md b/LGMC.md index 493629e..8210fc1 100644 --- a/LGMC.md +++ b/LGMC.md @@ -146,7 +146,7 @@ To access the makefile, enter the LGMC folder: $ cd LGMC ``` -Next create an executable with the makefile. The executable will be located in the LGMC folder. +Next create an executable with the makefile. The executable will be located in the `build` folder. ``` $ make LGMC @@ -178,8 +178,8 @@ LGMC requires seven input arguments (either `step_cutoff` or `time_cutoff` must - Is add site (T\|F) - Charge transfer style (M\|B) -When running LGMC ensure that your input file paths are correct considering the executable is inside the LGMC folder. Below is an example of how LGMC can be run using the input files inside the examples directory (here `step_cutoff` is specified): +When running LGMC ensure that your input file paths are correct considering the executable is inside the `build` folder. Below is an example of how LGMC can be run using the input files inside the examples directory (here `step_cutoff` is specified): ``` -./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 +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 ``` \ No newline at end of file diff --git a/NPMC.md b/NPMC.md index 17b9e78..1738e6c 100644 --- a/NPMC.md +++ b/NPMC.md @@ -143,7 +143,7 @@ To access the makefile, enter the `NPMC` folder: $ cd NPMC ``` -Next create an executable with the makefile. The executable will be located in the `NPMC` folder. +Next create an executable with the makefile. The executable will be located in the `build` folder. ``` $ make NPMC @@ -166,8 +166,8 @@ $ make help - time_cutoff : how much time in each simulation [s]. - checkpoint : whether checkpointing should occur. -When running `NPMC` ensure that your input file paths are correct considering the executable is inside the `NPMC` folder. Below is an example of how `NPMC` can be run using the input files inside the examples directory (here `step_cutoff` is specified): +When running `NPMC` ensure that your input file paths are correct considering the executable is inside the `build` folder. Below is an example of how `NPMC` can be run using the input files inside the examples directory (here `step_cutoff` is specified): ``` -./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 +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 ``` \ No newline at end of file