frameit 1.0__tar.gz

frameit-1.0/PKG-INFO

@@ -0,0 +1,4 @@
+Metadata-Version: 2.4
+Name: frameit
+Version: 1.0
+Requires-Python: >=3.10

frameit-1.0/README.md

@@ -0,0 +1,93 @@
+# CycloPyV2
+
+
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+
+Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+
+## Add your files
+
+- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
+- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
+
+```
+cd existing_repo
+git remote add origin https://gitlab.meteo.fr/souffletc/cyclopyv2.git
+git branch -M main
+git push -uf origin main
+```
+
+## Integrate with your tools
+
+- [ ] [Set up project integrations](https://gitlab.meteo.fr/souffletc/cyclopyv2/-/settings/integrations)
+
+## Collaborate with your team
+
+- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
+- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
+- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
+- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
+- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
+- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
+- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
+- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+
+***
+
+# Editing this README
+
+When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+
+## Suggestions for a good README
+
+Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+
+## Name
+Choose a self-explaining name for your project.
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Badges
+On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+## Installation
+Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+## Usage
+Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+## Support
+Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

frameit-1.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "frameit"
+version = "1.0"
+requires-python = ">=3.10"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+addopts = "-ra"
+testpaths = ["tests"]
+
+[project.scripts]
+frameit = "frameit.cli:main"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+extend-exclude = [
+  "DRAFT",
+  "notebooks",
+  "docs/build",
+  "src/frameit.egg-info",
+  ".venv",
+  "build",
+  "dist",
+]
+
+[tool.ruff.lint]
+# Ensemble volontairement conservateur, utile, peu bruyant
+select = ["E", "F", "I", "UP", "B"]
+fixable = ["ALL"]
+
+[tool.ruff.lint.per-file-ignores]
+# Fréquent dans les packages: imports ré-exportés dans __init__.py
+"src/frameit/__init__.py" = ["F401"]
+
+[tool.ruff.format]
+quote-style = "double"
+
+

frameit-1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

frameit-1.0/src/frameit/__init__.py

@@ -0,0 +1,5 @@
+import logging
+
+from ._version import __version__
+
+logging.getLogger("cyclopy").addHandler(logging.NullHandler())

frameit-1.0/src/frameit/__main__.py

@@ -0,0 +1,4 @@
+from frameit.cli import main
+
+if __name__ == "__main__":
+    main()

frameit-1.0/src/frameit/_version.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+
+def get_cyclopy_version() -> str:
+    try:
+        return version("cyclopy")
+    except PackageNotFoundError:
+        return "unknown"
+
+
+__version__ = get_cyclopy_version()

frameit-1.0/src/frameit/check/__init__.py

@@ -0,0 +1,3 @@
+from .check_functions import check_group_var  # nouvelle importation
+
+__all__ = ["check_group_var"]

frameit-1.0/src/frameit/check/check_functions.py

@@ -0,0 +1,157 @@
+import logging
+
+import numpy as np
+import xarray as xr
+
+logger = logging.getLogger(__name__)
+
+
+def drop_time_dupes(ds: xr.Dataset, keep: str = "first") -> xr.Dataset:
+    # keep: "first" ou "last"
+    t = ds["time"].values
+    if keep == "last":
+        # indices des dernières occurrences
+        _, idx = np.unique(t[::-1], return_index=True)
+        keep_idx = (t.size - 1) - np.sort(idx)
+    else:
+        # indices des premières occurrences
+        _, idx = np.unique(t, return_index=True)
+        keep_idx = np.sort(idx)
+    return ds.isel(time=keep_idx)
+
+
+def check_group_var(by_group: dict, requests: dict) -> dict:
+    """
+    Supporte:
+    - by_group plat:   {group -> xr.Dataset}, requests: {group -> spec}
+    - by_group imbriqué: {method -> {group -> xr.Dataset}},
+        requests: {method -> {group -> spec}} OU {group -> spec}
+
+    Retour:
+    {
+        "\t\t\tignored_groups": [ "group" | "method/group", ... ],
+        "missing_by_group": { "group" | "method/group": [vars manquantes] }
+    }
+    """
+
+    def _is_group_spec_map(d: dict) -> bool:
+        if not isinstance(d, dict) or not d:
+            return False
+        return all(
+            isinstance(v, dict)
+            and any(
+                k in v
+                for k in ("variables", "level_selection", "level_indices", "level_values", "levels")
+            )
+            for v in d.values()
+        )
+
+    def _is_method_group_spec_map(d: dict) -> bool:
+        if not isinstance(d, dict) or not d:
+            return False
+        return all(_is_group_spec_map(v) for v in d.values())
+
+    def _expected_vars(spec: dict) -> set:
+        return set((spec or {}).get("variables") or [])
+
+    if not isinstance(by_group, dict) or not by_group:
+        return {"\t\t\tignored_groups": [], "missing_by_group": {}}
+
+    # Détection by_group plat vs imbriqué
+    is_flat = all(hasattr(v, "dims") for v in by_group.values() if v is not None)
+
+    if is_flat:
+        # Log dims
+        for g, ds in by_group.items():
+            dims = ", ".join(f"{k}={v}" for k, v in ds.dims.items())
+            logger.info("\t\t\tDataset[%s] : dimensions %s", g, dims)
+
+        # Normalisation requests -> {group -> spec}
+        req_map = requests or {}
+        if not _is_group_spec_map(req_map):
+            req_map = {}
+
+        requested_groups = set(req_map.keys())
+        loaded_groups = set(by_group.keys())
+
+        ignored = requested_groups - loaded_groups
+        if ignored:
+            logger.info(
+                "\t\t\tGroupes ignorés car absents dans les données: %s", ", ".join(sorted(ignored))
+            )
+
+        missing_by_group: dict[str, list[str]] = {}
+        for grp in sorted(loaded_groups & requested_groups):
+            exp = _expected_vars(req_map.get(grp))
+            if not exp:
+                continue
+            present = set(by_group[grp].data_vars)
+            missing = sorted(exp - present)
+            if missing:
+                logger.warning("\t\t\t[%s] Variables manquantes: %s", grp, ", ".join(missing))
+                missing_by_group[grp] = missing
+            else:
+                logger.info(
+                    "\t\t\t[%s] Toutes les variables demandées sont présentes (%d).", grp, len(exp)
+                )
+
+        return {"\t\t\tignored_groups": sorted(ignored), "missing_by_group": missing_by_group}
+
+    # Imbriqué: {method -> {group -> xr.Dataset}}
+    # Log dims
+    for m, grp_map in by_group.items():
+        if not isinstance(grp_map, dict):
+            continue
+        for g, ds in grp_map.items():
+            if not hasattr(ds, "dims"):
+                continue
+            dims = ", ".join(f"{k}={v}" for k, v in ds.dims.items())
+            logger.info("\t\t\tDataset[%s/%s] : dimensions %s", m, g, dims)
+
+    # Normaliser requests
+    req_in = requests or {}
+    if _is_method_group_spec_map(req_in):
+        req_methods = req_in  # {method -> {group -> spec}}
+    elif _is_group_spec_map(req_in):
+        # Appliquer le même bloc de groupes à toutes les méthodes présentes
+        req_methods = {m: req_in for m in by_group.keys() if isinstance(by_group.get(m), dict)}
+    else:
+        req_methods = {}
+
+    methods = set(k for k, v in by_group.items() if isinstance(v, dict)) | set(req_methods.keys())
+
+    ignored_flat: list[str] = []
+    missing_flat: dict[str, list[str]] = {}
+
+    for m in sorted(methods):
+        grp_map = by_group.get(m) if isinstance(by_group.get(m), dict) else {}
+        req_map = req_methods.get(m, {})
+
+        requested_groups = set(req_map.keys())
+        loaded_groups = set(grp_map.keys())
+
+        ignored = requested_groups - loaded_groups
+        if ignored:
+            logger.info(
+                "\t\t\tGroupes ignorés car absents dans les données pour %s: %s",
+                m,
+                ", ".join(sorted(ignored)),
+            )
+            ignored_flat.extend([f"{m}/{g}" for g in sorted(ignored)])
+
+        for g in sorted(loaded_groups & requested_groups):
+            exp = _expected_vars(req_map.get(g))
+            if not exp:
+                continue
+            present = set(grp_map[g].data_vars)
+            missing = sorted(exp - present)
+            key = f"{m}/{g}"
+            if missing:
+                logger.warning("\t\t\t[%s] Variables manquantes: %s", key, ", ".join(missing))
+                missing_flat[key] = missing
+            else:
+                logger.info(
+                    "\t\t\t[%s] Toutes les variables demandées sont présentes (%d).", key, len(exp)
+                )
+
+    return {"\t\t\tignored_groups": ignored_flat, "missing_by_group": missing_flat}

frameit-1.0/src/frameit/cli.py

@@ -0,0 +1,271 @@
+
+# src/cyclopy/cli.py
+from __future__ import annotations
+
+import os
+import sys
+from pathlib import Path
+
+
+def _sanitize_sys_path_user_site() -> None:
+    """
+    Ensure CycloPy CLI does not import packages from the user site-packages (e.g. ~/.local),
+    which can shadow the conda environment and break version consistency.
+    """
+    # Fast path: if PYTHONNOUSERSITE is set, user site is usually not injected.
+    # Still sanitize defensively because PYTHONPATH or .pth files may add ~/.local manually.
+    user_base = Path(os.path.expanduser("~/.local")).resolve()
+
+    new_path: list[str] = []
+    for p in sys.path:
+        try:
+            rp = Path(p).resolve()
+        except Exception:
+            new_path.append(p)
+            continue
+
+        # Drop typical user installs, including ~/.local and user site-packages.
+        if user_base in rp.parents or rp == user_base:
+            continue
+
+        new_path.append(p)
+
+    sys.path[:] = new_path
+
+
+_sanitize_sys_path_user_site()
+
+# Imports only after sys.path is sanitized
+from frameit.core.runner import CycloPyRunner  # noqa: E402
+import argparse
+import logging
+import platform
+from typing import Any
+
+from frameit.core.runner import CycloPyRunner
+from frameit.core.settings_class import SimulationConfig
+from frameit.io.netcdf_export import export_outputs
+from frameit.utils import setup_cyclopy_logging
+
+_DEFAULT_INSTITUTION = "LACy, Université de La Réunion, CNRS, Météo-France"
+
+
+def _package_version(pkg_name: str) -> str | None:
+    try:
+        from importlib.metadata import version
+
+        return version(pkg_name)
+    except Exception:
+        return None
+
+
+def _probe_module(mod_name: str) -> dict[str, Any]:
+    out = {"ok": False, "version": None, "path": None, "error": None}
+    try:
+        mod = __import__(mod_name)
+        out["ok"] = True
+        out["version"] = getattr(mod, "__version__", None) or _package_version(mod_name)
+        out["path"] = getattr(mod, "__file__", None)
+        return out
+    except Exception as exc:
+        out["error"] = str(exc)
+        return out
+
+
+def _build_parser() -> argparse.ArgumentParser:
+    p = argparse.ArgumentParser(prog="cyclopy", description="CycloPy CLI")
+    sub = p.add_subparsers(dest="command", required=True)
+
+    # run
+    pr = sub.add_parser("run", help="Run CycloPy from a YAML configuration file.")
+    pr.add_argument("config", type=Path, help="Path to the YAML configuration file")
+    pr.add_argument(
+        "--log-level",
+        default=None,
+        choices=("DEBUG", "INFO", "WARNING", "ERROR"),
+        help="Override log level. If not set, uses conf.DEBUG to choose DEBUG/INFO.",
+    )
+    pr.add_argument(
+        "--no-hdf5-debug-pop",
+        action="store_true",
+        help="Do not remove HDF5_DEBUG from the environment.",
+    )
+
+    # Exports enabled by default, disable with --no-*
+    pr.add_argument(
+        "--no-export-netcdf",
+        dest="export_netcdf",
+        action="store_false",
+        default=True,
+        help="Disable NetCDF export (enabled by default).",
+    )
+    pr.add_argument(
+        "--no-export-polar",
+        dest="export_polar",
+        action="store_false",
+        default=True,
+        help="Disable polar export (enabled by default).",
+    )
+    pr.add_argument(
+        "--no-export-cart",
+        dest="export_cart",
+        action="store_false",
+        default=True,
+        help="Disable cartesian export (enabled by default).",
+    )
+    pr.add_argument(
+        "--compress-level",
+        type=int,
+        default=1,
+        help="NetCDF compression level (0-9). Default: 1.",
+    )
+    pr.add_argument(
+        "--institution",
+        type=str,
+        default=_DEFAULT_INSTITUTION,
+        help="Institution string stored in exported files.",
+    )
+
+    # validate
+    pv = sub.add_parser("validate", help="Load and validate the YAML configuration (lightweight).")
+    pv.add_argument("config", type=Path, help="Path to the YAML configuration file")
+
+    # info (fusion of version and doctor, verbose by default)
+    pi = sub.add_parser(
+        "info", help="Print CycloPy and environment information (verbose by default)."
+    )
+    pi.add_argument("--short", action="store_true", help="Print only 'CycloPy <version>'")
+
+    return p
+
+
+def _configure_logging(conf: SimulationConfig, log_level_override: str | None) -> None:
+    level = log_level_override
+    if level is None:
+        level = "DEBUG" if getattr(conf, "DEBUG", False) else "INFO"
+
+    log_path = setup_cyclopy_logging(
+        conf.cyclopy_output_dir,
+        level=level,
+        simu_name=getattr(conf, "simulation_name", None),
+    )
+    logging.getLogger("cyclopy").info("Logging initialized: %s", str(log_path))
+
+
+def _cmd_validate(cfg_path: Path) -> int:
+    conf = SimulationConfig.from_yaml_with_model_preset(cfg_path)
+
+    out_dir = Path(conf.cyclopy_output_dir)
+    if not out_dir.exists():
+        print(f"WARNING: output directory does not exist: {out_dir}")
+    elif not os.access(out_dir, os.W_OK):
+        print(f"WARNING: no write permission on output directory: {out_dir}")
+
+    print("OK: configuration loaded successfully")
+    return 0
+
+
+
+def _cmd_info(short: bool) -> int:
+    cyclopy_ver = _package_version("cyclopy") or "unknown"
+    if short:
+        print(f"CycloPy {cyclopy_ver}")
+        return 0
+
+    print(f"CycloPy: {cyclopy_ver}")
+    print(f"Python: {platform.python_version()} ({sys.executable})")
+    print(f"Platform: {platform.system()} {platform.release()} ({platform.machine()})")
+
+    env_keys = ("HDF5_DEBUG", "ECCODES_DEFINITION_PATH", "ECCODES_SAMPLES_PATH")
+    print("Environment:")
+    for k in env_keys:
+        print(f"  {k}={os.environ.get(k, '')}")
+
+    modules = {
+        "numpy": _probe_module("numpy"),
+        "xarray": _probe_module("xarray"),
+        "dask": _probe_module("dask"),
+        "cfgrib": _probe_module("cfgrib"),
+        "eccodes": _probe_module("eccodes"),
+        "xesmf": _probe_module("xesmf"),
+        "netCDF4": _probe_module("netCDF4"),
+        "h5py": _probe_module("h5py"),
+    }
+
+    print("Modules:")
+    for name in sorted(modules):
+        m = modules[name]
+        if m["ok"]:
+            ver = m["version"] or ""
+            print(f"  {name}: OK {ver}".rstrip())
+        else:
+            print(f"  {name}: MISSING")
+            if m["error"]:
+                print(f"    error: {m['error']}")
+
+    critical_missing = [k for k in ("numpy", "xarray") if not modules[k]["ok"]]
+    if critical_missing:
+        print(f"Overall: FAIL (missing critical modules: {', '.join(critical_missing)})")
+        return 1
+
+    print("Overall: OK")
+    return 0
+
+
+def _cmd_run(args: argparse.Namespace) -> int:
+    if not args.no_hdf5_debug_pop:
+        os.environ.pop("HDF5_DEBUG", None)
+
+    if not (0 <= int(args.compress_level) <= 9):
+        raise ValueError("--compress-level must be in [0, 9]")
+
+    conf = SimulationConfig.from_yaml_with_model_preset(args.config)
+
+    _configure_logging(conf, args.log_level)
+    logger = logging.getLogger("cyclopy")
+
+    runner = CycloPyRunner(conf)
+    runner.run()
+
+    out_dir = Path(conf.cyclopy_output_dir).resolve()
+
+    if args.export_netcdf:
+        with runner.timer.section("Netcdf export"):
+            export_outputs(
+                runner,
+                institution=str(args.institution),
+                out_dir=out_dir,
+                export_polar=bool(args.export_polar),
+                export_cart=bool(args.export_cart),
+                compress_level=int(args.compress_level),
+            )
+        logger.info("NetCDF export done.")
+    else:
+        logger.info("NetCDF export skipped (--no-export-netcdf).")
+
+    runner.timer.log_summary(logger, title="CycloPy runtime summary")
+    logger.info("CycloPy ends correctly")
+    return 0
+
+
+def main(argv: list[str] | None = None) -> None:
+    parser = _build_parser()
+    args = parser.parse_args(argv)
+
+    # Minimal fallback logging for unexpected errors before CycloPy logging is configured
+    logging.basicConfig(level=logging.INFO, format="%(levelname)s:%(name)s:%(message)s")
+
+    try:
+        if args.command == "run":
+            code = _cmd_run(args)
+        elif args.command == "validate":
+            code = _cmd_validate(args.config)
+        elif args.command == "info":
+            code = _cmd_info(short=bool(args.short))
+        else:
+            code = 2
+    except Exception:
+        logging.getLogger("cyclopy").exception("CycloPy CLI failed")
+        code = 1
+
+    raise SystemExit(code)