sda.cli
=======

.. py:module:: sda.cli

.. autoapi-nested-parse::

   SDA Command Line Interface Functions.

   This module contains all the command functions for the SDA CLI.



Functions
---------

.. autoapisummary::

   sda.cli.open_excel_file
   sda.cli.open_test_explorer
   sda.cli.open_plume_webpage
   sda.cli.open_json_file
   sda.cli.run_dashboard_command
   sda.cli.run_plot_command
   sda.cli.list_tests_command
   sda.cli.parse_filter_expression
   sda.cli.apply_filter_to_dataframe
   sda.cli.print_dataframe_command
   sda.cli.run_demon_command
   sda.cli.show_help


Module Contents
---------------

.. py:function:: open_excel_file(test_name)

   Open the Excel data file for the test with the system's default application.

   :param test_name: The name of the test to open (e.g., "T183").
   :type test_name: :py:class:`str`


.. py:function:: open_test_explorer(test_name)

   Open the local file explorer at the test position.

   :param test_name: The name of the test to open (e.g., "T183").
   :type test_name: :py:class:`str`


.. py:function:: open_plume_webpage(test_name)

   Open the plume webpage for the corresponding test.

   :param test_name: The name of the test to open (e.g., "T183").
   :type test_name: :py:class:`str`


.. py:function:: open_json_file()

   Open the local SDA JSON configuration file at ~/sda.json.

   If the file doesn't exist, it will automatically be created from
   the default template using SDA's config system.


.. py:function:: run_dashboard_command(args)

   Handle the dashboard command with proper argument parsing.

   :param args: Command line arguments for the dashboard command.
   :type args: :py:class:`list[str]`


.. py:function:: run_plot_command(args)

   Handle the plot command (equivalent to fplot).

   :param args: Command line arguments for the plot command.
   :type args: :py:class:`list[str]`


.. py:function:: list_tests_command(args)

   Handle the list command to show all available tests.

   :param args: Command line arguments for the list command.
   :type args: :py:class:`list[str]`


.. py:function:: parse_filter_expression(filter_expr)

   Parse a filter expression into column, operator, and value.

   :param filter_expr: Filter expression like 'frequency>10' or 'generator="Gen1"'
   :type filter_expr: :py:class:`str`

   :returns: Tuple of (column_name, operator, value)
   :rtype: :py:class:`tuple[str`, :py:class:`str`, :py:class:`str]`

   :raises ValueError: If the filter expression is invalid


.. py:function:: apply_filter_to_dataframe(df, filter_expr)

   Apply a filter expression to a DataFrame.

   :param df: DataFrame to filter
   :type df: :py:class:`pd.DataFrame`
   :param filter_expr: Filter expression to apply
   :type filter_expr: :py:class:`str`

   :returns: Filtered DataFrame
   :rtype: :py:class:`pd.DataFrame`

   :raises ValueError: If the filter expression is invalid or column doesn't exist


.. py:function:: print_dataframe_command(args)

   Handle the print command to display DataFrame with enhanced statistics.

   :param args: Command line arguments for the print command.
   :type args: :py:class:`list[str]`


.. py:function:: run_demon_command(args)

   Handle the data-demon command for column name standardization analysis.

   :param args: Command line arguments for the data-demon command.
   :type args: :py:class:`list[str]`


.. py:function:: show_help()

   Display help information for the SDA CLI.