Merge pull request #21 from cbib/help-menu

update(main): add help menu, using click library

src/dimet/__main__.py

@@ -8,11 +8,14 @@
 import os, sys
 
 import hydra
+
 from dimet.method import Method
 from omegaconf import DictConfig, OmegaConf
 
 from dimet.data import Dataset
 
+import click
+
 logger = logging.getLogger(__name__)
 
 
@@ -31,5 +34,18 @@ def main_run_analysis(cfg: DictConfig) -> None:
     method.run(cfg, dataset)
 
 
+@click.command(context_settings=dict(
+        help_option_names=['-h', '--help'])  # needed to recognize -h as well
+    )
+@click.option('-cd', type=str, required=True,
+              help="Directory containing the general configuration "
+                   "(see -cn)")
+@click.option('-cn', type=str, required=True,
+              help="File name of the general configuration "
+                   "(only one .yaml file name)")
+def main_run_analysis__or_display_help(cd, cn) -> None:
+    main_run_analysis()  # run: hydra handles further arguments validation
+
+
 if __name__ == "__main__":
-    main_run_analysis()
+    main_run_analysis__or_display_help()