diff --git a/README.md b/README.md index 3d5baa3..ef9bdf5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,14 @@ -### Batch processing run +# SimNDT2b + +The batch processor version of SimNDT Version 2 + +The batch processor reads the entire simulation scenario from a json file and performs a simulation. Output can be saved in numpy format by enabling snapshots. +Either each snapshot step is svaed in one file, or the snapshots (matrix of specific field variables) are accumulated in a three-dimensional volume, saved in on numpy file. + + +## Batch processing run + 1. Update the path to save the simulation data in the JOSN file under the key name ["Snapshot"]["Save_filepath"]. 2. Run and save simulation command: python main.py "path_to_json_file" -### Saving simulation video file -1. update the path to video file in the param JSON file under key name ['SimVideo']["Save_filepath"]. -2. Comment out saveVideo(sim_params, simPack) function to not save the videos. +