add deprecation

Author: alinelena

janus_core/cli/phonons.py

@@ -26,7 +26,7 @@
     Summary,
     Tracker,
 )
-from janus_core.cli.utils import yaml_converter_callback
+from janus_core.cli.utils import deprecated_option, yaml_converter_callback
 
 app = Typer()
 
@@ -110,11 +110,20 @@ def phonons(
         ),
     ] = 0.1,
     minimize_kwargs: MinimizeKwargs = None,
-    hdf5: Annotated[
+    force_consts_to_hdf5: Annotated[
         bool,
         Option(
             help="Whether to save force constants in hdf5.",
             rich_help_panel="Calculation",
+            callback=deprecated_option,
+            hidden=True,
+        ),
+    ] = True,
+    hdf5: Annotated[
+        bool,
+        Option(
+            help="Whether to save force constants and bands in hdf5.",
+            rich_help_panel="Calculation",
         ),
     ] = True,
     plot_to_file: Annotated[
@@ -228,8 +237,11 @@ def phonons(
         Default is 0.1.
     minimize_kwargs
         Other keyword arguments to pass to geometry optimizer. Default is {}.
+    force_consts_to_hdf5
+        Deprecated. Please use `hdf5`.
     hdf5
-        Whether to save force constants in hdf5 format. Default is True.
+        Whether to save force constants and bands in hdf5 format.
+        Default is True.
     plot_to_file
         Whether to plot. Default is False.
     write_full