Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Removed TOC and added an explanation for the command-line interface
  • Loading branch information
satfra authored Dec 16, 2024
1 parent 146103e commit 35ad7ca
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# DiFfRG - A Discretization Framework for functional Renormalization Group flows

[TOC]

DiFfRG is a set of tools for the discretization of flow equations arising in the functional Renormalization Group (fRG).

For spatial discretizations, i.e. discretizations of field space, DiFfRG makes different finite element (FE) methods available. These include:
Expand Down Expand Up @@ -178,15 +176,29 @@ To see how fast the simulation progresses, one can set the `verbosity` parameter
```json
{
"output": {
"verbosity": 1,
}
"verbosity": 1
},
}
```
or from the CLI,
```bash
$ ./my_simulation -si /output/verbosity=1
```

## Modifying parameters from the CLI

Any DiFfRG simulation using the `DiFfRG::ConfigurationHelper` class can be asked to give some syntax pertaining to the configuration:
```
$ ./my_simulation --help
This is a DiFfRG simulation. You can pass the following optional parameters:
--help shows this text
--generate-parameter-file generates a parameter file with some default values
-p specifiy a parameter file other than the standard parameter.json
-sd overwrite a double parameter. This should be in the format '-s physical/T=0.1'
-si overwrite an integer parameter. This should be in the format '-s physical/Nc=1'
-sb overwrite a boolean parameter. This should be in the format '-s physical/use_sth=true'
-ss overwrite a string parameter. This should be in the format '-s physical/a=hello'
```

## Timestepper choice

Expand All @@ -205,4 +217,4 @@ If solving purely variable-dependent systems, one of the `Boost` time steppers,
- [Catch2](https://github.com/catchorg/Catch2) for unit testing.
- [RMM](https://github.com/rapidsai/rmm), a memory manager for CUDA, which is used for GPU-accelerated loop integrations.
- [QMC](https://github.com/mppmu/qmc) for adaptive Quasi-Monte-Carlo integration.
- [spdlog](https://github.com/gabime/spdlog) for logging.
- [spdlog](https://github.com/gabime/spdlog) for logging.

0 comments on commit 35ad7ca

Please sign in to comment.