.. last updated May 2025 ===== Tools ===== ``fre`` ======= The ``click`` based entry point to the rest of the package at the command line for ``fre-cli``. ``fre`` has a command structure like, ``fre TOOL COMMAND``, akin to the CLI's provided by popular packages like ``git`` and ``cylc``. This enables discovery of the tooling capability, useful for complex tools with multiple options and detailed configurations. arguments --------- * (optional) ``--help``, help flag - print information on ``TOOL`` options * (optional) ``-v[v]``, verbosity flag, up to two - increments ``fre``'s verbosity from the default ``logging.WARNING`` to ``logging.INFO`` with one ``-v``, and again to ``logging.DEBUG`` with ``-vv`` * (optional) ``-q``, quiet flag, up to one - sets ``fre``'s verbosity from the default ``logging.WARNING`` to ``logging.ERROR``. * (optional) ``-l, --log_file PATH``, argument specifying a log file inwhich to store ``logging`` messages - the given (or default) verbosity will be used as-specified - the text will still be seen in the terminal, and the format within the ``log_file`` is the same as what is printed to screen. Tools that require arguments to run will alert user about missing arguments, and will also list the rest of the optional parameters if ``--help`` is executed. e.g.:: fre TOOL COMMAND --help Argument flags are not positional, can be specified in any order. Some arguments expect sub-arguments. ``fre app`` =========== .. include:: tools/app.rst ``fre catalog`` =============== .. include:: tools/catalog.rst ``fre cmor`` ============ * See also, ``fre cmor``'s `README `_ * See also, ``fre cmor``'s `project board `_ This set of tools leverages the external ``cmor`` python package within the ``fre`` ecosystem. ``cmor`` is an acronym for "climate model output rewriter". The process of rewriting model-specific output files for model intercomparisons (MIPs) using the ``cmor`` module is, quite cleverly, referred to as "CMORizing". .. include:: tools/cmor.rst ``fre make`` ============ .. include:: tools/make.rst ``fre pp`` ========== .. include:: tools/pp.rst ``fre yamltools`` ================= .. include:: tools/yamltools.rst ``fre list`` ============ .. include:: tools/listtools.rst