Merge pull request #18 from cta-observatory/cli-group_commands

Group CLI into single executable with subcommands

docs/source/api/index.rst

@@ -7,25 +7,33 @@ Reference API
 Command-line tools
 ==================
 
+.. argparse::
+   :module: iact_estimator.scripts.main
+   :func: parser
+   :prog: iact-estimator
+   :nosubcommands:
+
 .. _iact-estimator-cfg:
 
-iact-estimator-cfg
--------------------
+Get the default config file
+---------------------------
 
 .. argparse::
-   :module: iact_estimator.scripts.get_config
+   :module: iact_estimator.scripts.main
    :func: parser
-   :prog: iact-estimator-cfg
+   :prog: iact-estimator
+   :path: config
 
 .. _iact-estimator:
 
-iact-estimator
----------------
+Run the estimation process
+--------------------------
 
 .. argparse::
-   :module: iact_estimator.scripts.estimator
+   :module: iact_estimator.scripts.main
    :func: parser
    :prog: iact-estimator
+   :path: run
 
 Package resources
 =================

docs/source/changes/18.changed.rst

@@ -0,0 +1,2 @@
+Grouped all CLI into a single executable with subcommands.
+Also added an new configuration option to disable the plotting figures windows.

docs/source/conf.py

@@ -9,6 +9,8 @@
 from pathlib import Path
 import tomllib
 
+import gammapy
+
 from iact_estimator.version import __version__
 
 PROJECT_ROOT_DIR = Path(__file__).parent.parent.parent.resolve()
@@ -83,7 +85,7 @@
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "astropy": ("https://docs.astropy.org/en/latest/", None),
-    "gammapy": ("https://docs.python.org/3", None),
+    "gammapy": (f"https://docs.gammapy.org/{gammapy.__version__}/", None),
     "matplotlib": ("https://matplotlib.org/", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
     "scipy": ("https://docs.scipy.org/doc/scipy/", None),

environment.yml

@@ -22,6 +22,7 @@ dependencies:
   - sphinx-autoapi
   - sphinx-copybutton
   - sphinxcontrib-towncrier
+  - towncrier<24.7
   # Testing
   - pytest
   - pytest-console-scripts

pyproject.toml

@@ -10,7 +10,7 @@ authors = [
 ]
 description = "Estimate the performance of an IACT telescope system to an observation."
 readme = "README.md"
-requires-python = ">=3.11"
+requires-python = ">=3.9"
 keywords = ["iact", "cherenkov", "astronomy"]
 license = { text = "BSD-3-Clause" }
 classifiers = [
@@ -41,13 +41,13 @@ docs = [
     "sphinx-autoapi",
     "sphinx-copybutton",
     "sphinxcontrib-towncrier",
+    "towncrier<24.7"
 ]
 dev = ["pre-commit", "ruff", "iact_estimator[docs]", "iact_estimator[tests]"]
 tests = ["pytest", "pytest-console-scripts"]
 
 [project.scripts]
-iact-estimator = "iact_estimator.scripts.estimator:main"
-iact-estimator-cfg = "iact_estimator.scripts.get_config:main"
+iact-estimator = "iact_estimator.scripts.main:main"
 
 [tool.setuptools_scm]
 write_to = "src/iact_estimator/_version.py"

src/iact_estimator/resources/config.yml

@@ -31,6 +31,7 @@ pulsar_mode:
   pulsar_off_range: 0.25 # range of OFF phases used for pulsar mode# global variables (DO NOT MODIFY)
 
 plotting_options:
+  show: False
   figure_size: [20, 10]
   bbox_inches: "tight"
   min_energy: "40 GeV"