Skip to content

Commit

Permalink
Update README.md to remove reference to running without input.toml file
Browse files Browse the repository at this point in the history
Using an input file is preferred now, as changing options by editing
defaults in moment_kinetics_input.toml forces Julia to redo
precompilation of the project.
  • Loading branch information
johnomotani committed Sep 20, 2023
1 parent 4c59b94 commit e251f88
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,10 @@ The full documentation is online at [https://mabarnes.github.io/moment_kinetics]
```
this significantly decreases the load time but prevents code changes from taking effect when `moment_kinetics.so` is used without repeating the precompilation (to use this option, add an option `-Jmoment_kinetics.so` when starting julia).
4) To run julia with optimization, type
```
$ julia -O3 --project run_moment_kinetics.jl
```
Default input options are specified in `moment_kinetics_input.jl`. The defaults can be modified for a particular run by setting options in a TOML file, for example `input.toml`, which can be passed as an argument
```
$ julia -O3 --project run_moment_kinetics.jl input.toml
```
Options are specified in a TOML file, e.g. `input.toml` here. The defaults are specified in `moment_kinetics_input.jl`.
* To run in parallel, just put `mpirun -np <n>` in front of the call you would normally use, with `<n>` the number of processes to use.
* It may be more convenient when running `moment_kinetics` more than once to work from the Julia REPL, e.g.
```
Expand Down

0 comments on commit e251f88

Please sign in to comment.