<commit_before># Variant

## Install

Please fill in the config.py with your workspace directory, compiler commands and machine specifications.

The verrou option will require [Verrou on GitHub](https://github.com/edf-hpc/verrou) which requires Valgrind.

Requires:
1. morden C++ compilers
2. python 3
3. and other stuff I don't have in mind presently

## Start your first hydrodynamics simulation

Variant comes with two helper scripts that compile, build and run cases.

```
python3 seek_optimal.py hydro4x1 --case nSod --core 2
python3 seek_order.py eulerRuO1 --case nSedov --core 2 --fastref
```

## Read the results

And finally to visualize the results.

```
python3 script/study/visualize.py eulerRuO1 --case nSedov256x256 --solver sedov
python3 script/study/plot.py eulerRuO1 --case nSedov256x256 --solver sedov --axis r --quant energy
python3 script/study/order.py eulerRuO1 --case nSedov --solver sedov
```<commit_msg>update doc<commit_after># Variant

## Install

Please fill in the config.py with your workspace directory, compiler commands and machine specifications.

The verrou option will require [Verrou on GitHub](https://github.com/edf-hpc/verrou) which requires Valgrind.

Requires:
1. morden C++ compilers
2. python 3
3. and other stuff I don't have in mind presently

## Start your first hydrodynamics simulation

Variant comes with two helper scripts that compile, build and run cases.

```
python3 seek_optimal.py hydro4x1 --case nSod --core 2
python3 seek_order.py eulerRuO1 --case Noh --core 2 --fastref
```

## Read the results

And finally to visualize the results.

```
python3 script/study/visualize.py eulerRuO1 --case nSedov256x256 --solver sedov
python3 script/study/plot.py eulerRuO1 --case nSedov256x256 --solver sedov --axis r --quant energy
python3 script/study/order.py eulerRuO1 --case nSedov --solver sedov
```
{'fraction_non_alphanumeric': 0.09081081081081081, 'fraction_numerical': 0.03135135135135135, 'mean_word_length': 4.141666666666667, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3414842', 'n_tokens_mistral': 636, 'n_tokens_neox': 577, 'n_words': 225}