From 7f20b30f3e2618aeb47b1c214a7614974a6fe3c9 Mon Sep 17 00:00:00 2001 From: Guilhem Lavaux Date: Fri, 5 Apr 2024 11:58:48 +0200 Subject: [PATCH] Add statements to README --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bcf42b5..fa2875b 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,11 @@ pip install -e . ## Usage -The command is `m2m.py` in your `$PATH` after installation. +The command is `m2m` in your `$PATH` after installation. Take a look at the examples in `scripts/*.slurm`. -For all command line options look at `map2map/args.py` or do `m2m.py -h`. +For all command line options look at the `map2map/*args.yaml` or do `m2m --help`, and `m2m train --help` or `m2m test --help`. +Another tool is the map cropper. It can take a single 3d field from a simulation and make little tiles extracted randomly from the main simulation. The training dataset is then saved in the target directory with the proper format for m2m. ### Data