Documentation and Tutorials: Update documentation and add comprehensive tutorials for all modules

Author: neomatamune

docs/csm-data/adx-send-runnerdata.md

@@ -0,0 +1,11 @@
+---
+hide:
+  - toc
+description: "Command help: `csm-data adx-send-runnerdata`"
+---
+# adx-send-runnerdata
+
+!!! info "Help command"
+    ```text
+    --8<-- "generated/commands_help/csm-data/adx-send-runnerdata.txt"
+    ```

docs/csm-data/adx-send-scenariodata.md

@@ -0,0 +1,34 @@
+---
+description: "Simple check list to follow before making a pull request"
+---
+
+Before submitting your pull request, make sure you've completed all the necessary steps:
+
+1. Code Quality
+    - [ ] Code follows the project's style guidelines (Black formatting)
+    - [ ] All linting checks pass
+    - [ ] Code is well-documented with docstrings
+    - [ ] Code is efficient and follows best practices
+    - [ ] No unnecessary dependencies are added
+2. Testing
+    - [ ] All unit tests pass
+    - [ ] Test coverage meets or exceeds 80%
+    - [ ] All functions have at least one test
+    - [ ] Edge cases and error conditions are tested
+    - [ ] Mocks are used for external services
+3.  Documentation
+    - [ ] API documentation is updated
+    - [ ] Command help text is clear and comprehensive
+    - [ ] Translation strings are added for all user-facing text
+    - [ ] Usage examples are provided
+    - [ ] Any necessary tutorials are created or updated
+4. Integration
+    - [ ] New functionality integrates well with existing code
+    - [ ] No breaking changes to existing APIs
+    - [ ] Dependencies are properly specified in pyproject.toml
+    - [ ] Command is registered in the appropriate __init__.py file
+5. Pull Request Description
+    - [ ] Clear description of the changes
+    - [ ] Explanation of why the changes are needed
+    - [ ] Any potential issues or limitations
+    - [ ] References to related issues or discussions

docs/csm-data/api/scenariorun-load-data.md

@@ -13,18 +13,18 @@
 
 import click
 
-from cosmotech.coal.cli.main import main
+from cosmotech.csm_data.main import main
 
 commands = {}
 
+
 def command_tree(obj, base_name):
     commands[base_name] = obj
     if isinstance(obj, click.Group):
-        return {name: command_tree(value, f"{base_name} {name}")
-                for name, value in obj.commands.items()}
+        return {name: command_tree(value, f"{base_name} {name}") for name, value in obj.commands.items()}
 
 
-ansi_escape = re.compile(r'(?:\x1B[@-_]|[\x80-\x9F])[0-?]*[ -/]*[@-~]')
+ansi_escape = re.compile(r"(?:\x1B[@-_]|[\x80-\x9F])[0-?]*[ -/]*[@-~]")
 
 command_tree(main, "csm-data")
 
@@ -56,14 +56,14 @@ def command_tree(obj, base_name):
             with contextlib.redirect_stdout(f):
                 cmd.get_help(ctx)
         f.seek(0)
-        o = ansi_escape.sub('', "".join(f.readlines()))
+        o = ansi_escape.sub("", "".join(f.readlines()))
         _md_file.write(o)
     if os.environ.get("DOC_GENERATE_CLI_CONTENT") is not None:
         doc_file = doc_folder / f"{command}.md".replace(" ", "/")
         parent_folder = doc_file.parent
         parent_folder.mkdir(parents=True, exist_ok=True)
-        current_doc = doc_template.format(command=command,
-                                          command_name=command.split(" ")[-1],
-                                          command_help_path=str(target_file))
+        current_doc = doc_template.format(
+            command=command, command_name=command.split(" ")[-1], command_help_path=str(target_file)
+        )
         with open(doc_file, "w") as _doc_file:
             _doc_file.write(current_doc)

docs/doc/Modelops/handlers.png

@@ -4,19 +4,23 @@
 import requirements
 
 _md_file: IO
-with (mkdocs_gen_files.open("dependencies.md", "w") as _md_file,
-      open("requirements.txt") as _req,
-      open("requirements.doc.txt") as _doc_req,
-      open("requirements.test.txt") as _test_req,
-      open("requirements.extra.txt") as _extra_req):
+with (
+    mkdocs_gen_files.open("dependencies.md", "w") as _md_file,
+    open("requirements.txt") as _req,
+    open("requirements.doc.txt") as _doc_req,
+    open("requirements.test.txt") as _test_req,
+    open("requirements.extra.txt") as _extra_req,
+    open("requirements.dev.txt") as _dev_req,
+):
     content = ["# List of dependencies", ""]
 
     _requirements: list[str] = _req.read().splitlines()
     _doc_requirements: list[str] = _doc_req.read().splitlines()
     _test_requirements: list[str] = _test_req.read().splitlines()
     _extra_requirements: list[str] = _extra_req.read().splitlines()
+    _dev_requirements: list[str] = _dev_req.read().splitlines()
 
-    for _r in [_requirements, _doc_requirements, _extra_requirements, _test_requirements]:
+    for _r in [_requirements, _doc_requirements, _extra_requirements, _test_requirements, _dev_requirements]:
         for _l in _r:
             if not _l:
                 content.append("")
@@ -28,7 +32,7 @@
                 content.append(
                     f"[ ![PyPI - {_name}]"
                     f"(https://img.shields.io/pypi/l/{_name}?style=for-the-badge&labelColor=informational&label={_name})]"
-                    f"(https://pypi.org/project/{_name}/)  ")
+                    f"(https://pypi.org/project/{_name}/)  "
+                )
 
     _md_file.writelines(_l + "\n" for _l in content)
-

docs/doc/Modelops/handlers.puml

@@ -2,12 +2,12 @@
 
 import mkdocs_gen_files
 
-from CosmoTech_Acceleration_Library import __version__
+from cosmotech.coal import __version__
 
 _md_file: IO
-with mkdocs_gen_files.open("index.md", "w") as _md_file, \
-        open("docs/scripts/index.md.template") as index_template, \
-        open("README.md") as readme:
+with mkdocs_gen_files.open("index.md", "w") as _md_file, open("docs/scripts/index.md.template") as index_template, open(
+    "README.md"
+) as readme:
     _index: list[str] = index_template.readlines()
     _readme_content = readme.readlines()
     for _line in _index:

docs/pull_request.md

@@ -1,13 +1,12 @@
 import os
 
 import mkdocs_gen_files
-from griffe.dataclasses import Alias
-from griffe.dataclasses import Module
+from griffe import Alias
+from griffe import Module
 
-pyhand = mkdocs_gen_files.config['plugins']['mkdocstrings'].get_handler('python')
-module_name = 'CosmoTech_Acceleration_Library'
-
-griffed_module = pyhand.collect(module_name, {})
+pyhand = mkdocs_gen_files.config["plugins"]["mkdocstrings"].handlers.get_handler("python")
+module_name = "cosmotech.coal"
+griffed_module = pyhand.collect(module_name, pyhand.get_options({}))
 
 
 def yield_module_member(module: Module) -> list[bool, str]:
@@ -26,36 +25,36 @@ def yield_module_member(module: Module) -> list[bool, str]:
 depth = 0
 parents = {}
 for is_class, identifier in yield_module_member(griffed_module):
-    parent, *sub = identifier.rsplit('.', depth)
+    parent, *sub = identifier.rsplit(".", depth)
     if is_class:
-        parent, *sub = identifier.rsplit('.', depth + 1)
+        parent, *sub = identifier.rsplit(".", depth + 1)
     parents.setdefault(parent, set())
     if sub:
         parents[parent].add(sub[0])
     else:
         parents[parent].add(parent)
 
 # gen md files
-with open('docs/scripts/generic_ref.md.template') as f:
+with open("docs/scripts/generic_ref.md.template") as f:
     generic_template_ref = f.read()
 
 mk_nav = mkdocs_gen_files.Nav()
 for nav, file_set in parents.items():
-    nav_root = ['References']
-    nav_root.extend(n for n in nav.split('.')[1:] if n)
-    file_name = '/'.join(nav.split('.')[1:]) + '.md'
+    nav_root = ["References"]
+    nav_root.extend(n for n in nav.split(".")[1:] if n)
+    file_name = "/".join(nav.split(".")[1:]) + ".md"
     mk_nav[nav_root] = file_name
-    with mkdocs_gen_files.open(os.path.join('references', file_name), 'w') as f:
-        f.write(f'# {nav}')
-        f.write('\n')
+    with mkdocs_gen_files.open(os.path.join("references", file_name), "w") as f:
+        f.write(f"# {nav}")
+        f.write("\n")
         for filz in sorted(file_set):
             _content = ""
             if filz != nav:
-                _content = generic_template_ref.replace('%%IDENTIFIER%%', '.'.join([nav, filz]))
+                _content = generic_template_ref.replace("%%IDENTIFIER%%", ".".join([nav, filz]))
             else:
-                _content = generic_template_ref.replace('%%IDENTIFIER%%', filz)
+                _content = generic_template_ref.replace("%%IDENTIFIER%%", filz)
             f.write(_content)
-            f.write('\n')
+            f.write("\n")
 
 with mkdocs_gen_files.open("references/SUMMARY.md", "w") as nav_file:
     nav_file.writelines(mk_nav.build_literate_nav())