cimsi 0.7.8__tar.gz

cimsi-0.7.8/.editorconfig

@@ -0,0 +1,21 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+
+[*.bat]
+indent_style = tab
+end_of_line = crlf
+
+[LICENSE]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

cimsi-0.7.8/.gitignore

@@ -0,0 +1,112 @@
+
+# local version tracking
+_version.py
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# IDE settings
+.vscode/
+
+# Vi swap files
+*.swp

cimsi-0.7.8/.gitlab-ci.yml

@@ -0,0 +1,82 @@
+stages:
+  - test
+  - deploy
+  - publish
+
+variables:
+  GIT_DEPTH: "0"
+  UV_LINK_MODE: copy
+  UV_PUBLISH_TOKEN: $UV_PUBLISH_TOKEN
+  CI_RUN_PATH: "/home/scrd105/s5-runpath/imsi-ci/$CI_JOB_ID"
+  IMSI_DEPLOYED_PYTHON_VER: "3.10"
+  IMSI_DEPLOY_PATH: "/home/scrd105/canesm_libs/imsi/"
+  UV_BINARY: "/home/scrd102/.local/bin/uv"
+  CANESM_REF_REPO: "/home/scrd102/cccma_libs/canesm/"  # change once we have CD for CanESM
+
+before_script:
+  - git fetch --tags --prune
+  # create run path where the job will run
+  - mkdir -p ${CI_RUN_PATH}
+  # make the deploy location
+  - mkdir -p ${IMSI_DEPLOY_PATH}
+  - mkdir -p ${IMSI_DEPLOY_PATH}/latest
+
+.test_job_template: &test_job_template
+  # note that tests will run on the defined branch, repo, model and experiment
+  # in the .env.test file
+  script: |
+    git clone "$CI_PROJECT_DIR" "$CI_RUN_PATH"
+    git fetch --unshallow --tags || git fetch --tags
+
+    # Ensure cleanup happens even if tests fail
+    trap 'echo "Cleaning up CI path"; rm -rf ${CI_RUN_PATH}' EXIT
+
+    # move into runpath
+    cd ${CI_RUN_PATH}
+
+    # setup environment
+    ${UV_BINARY} venv --python=${PYTHON_VERSION}
+    source .venv/bin/activate && ${UV_BINARY} pip install pip
+    pip install --upgrade setuptools
+    pip install $CI_PROJECT_DIR[tests]
+
+    # Run tests
+    coverage run -m pytest ${CI_PROJECT_DIR}/tests/
+    coverage report -m
+    coverage xml -o coverage.xml
+  coverage: '/TOTAL\s+[0-9]+\s+[0-9]+\s+([0-9]+)%/'
+
+.matrix_job_template: &matrix_job_template
+  <<: *test_job_template
+  parallel:
+    matrix:
+      - PYTHON_VERSION: ['3.10', '3.11', '3.12', '3.13']
+
+test:
+  stage: test
+  <<: *matrix_job_template
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+    - if: '$CI_COMMIT_BRANCH == "main" && $CI_PIPELINE_SOURCE == "push"'
+
+deploy:
+  stage: deploy
+  before_script:
+    - git fetch --unshallow --tags || git fetch --tags
+  script: |
+    cd ${IMSI_DEPLOY_PATH}
+    # pass Python version, tag, and deploy path as arguments
+    source ${CI_PROJECT_DIR}/tests/deploy_imsi_env.sh "${IMSI_DEPLOYED_PYTHON_VER}" "${CI_COMMIT_TAG}" "${IMSI_DEPLOY_PATH}" "${CANESM_REF_REPO}"
+  rules:
+    - if: $CI_COMMIT_TAG
+
+publish:
+  stage: publish
+  before_script:
+    - git fetch --unshallow --tags || git fetch --tags
+  script:
+    - ${UV_BINARY} build
+    - ${UV_BINARY} publish
+  rules:
+    - if: $CI_COMMIT_TAG
+

cimsi-0.7.8/.readthedocs.yaml

@@ -0,0 +1,23 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

cimsi-0.7.8/LICENSE

@@ -0,0 +1 @@
+[Open Government License - Canada version 2.0](https://open.canada.ca/en/open-government-licence-canada)

cimsi-0.7.8/MANIFEST.in

@@ -0,0 +1,10 @@
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

cimsi-0.7.8/Makefile

@@ -0,0 +1,85 @@
+.PHONY: clean clean-test clean-pyc clean-build docs help
+.DEFAULT_GOAL := help
+
+define BROWSER_PYSCRIPT
+import os, webbrowser, sys
+
+from urllib.request import pathname2url
+
+webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
+endef
+export BROWSER_PYSCRIPT
+
+define PRINT_HELP_PYSCRIPT
+import re, sys
+
+for line in sys.stdin:
+	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
+	if match:
+		target, help = match.groups()
+		print("%-20s %s" % (target, help))
+endef
+export PRINT_HELP_PYSCRIPT
+
+BROWSER := python -c "$$BROWSER_PYSCRIPT"
+
+help:
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+
+clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+
+clean-build: ## remove build artifacts
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc: ## remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test: ## remove test and coverage artifacts
+	rm -fr .tox/
+	rm -f .coverage
+	rm -fr htmlcov/
+	rm -fr .pytest_cache
+
+lint: ## check style with flake8
+	flake8 imsi tests
+
+test: ## run tests quickly with the default Python
+	python setup.py test
+
+test-all: ## run tests on every Python version with tox
+	tox
+
+coverage: ## check code coverage quickly with the default Python
+	coverage run --source imsi setup.py test
+	coverage report -m
+	coverage html
+	$(BROWSER) htmlcov/index.html
+
+docs: ## generate Sphinx HTML documentation, including API docs
+	rm -f docs/imsi.rst
+	rm -f docs/modules.rst
+	sphinx-apidoc -o docs/ imsi
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	$(BROWSER) docs/_build/html/index.html
+
+servedocs: docs ## compile the docs watching for changes
+	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
+
+release: dist ## package and upload a release
+	twine upload dist/*
+
+dist: clean ## builds source and wheel package
+	python setup.py sdist
+	python setup.py bdist_wheel
+	ls -l dist
+
+install: clean ## install the package to the active Python's site-packages
+	python setup.py install

cimsi-0.7.8/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.4
+Name: cimsi
+Version: 0.7.8
+Summary: Integrated Modelling System Infrastructure (IMSI) is a comprehensive software project used to download, configure, build and run the suite of models in the CCCma Integrated Modelling System.
+Author: CCCma Technical Development Team
+License: OGL-Canada-2.0
+Project-URL: Homepage, https://imsi.readthedocs.io/en/latest/
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: isodate
+Requires-Dist: cftime
+Requires-Dist: xarray
+Requires-Dist: dataclasses
+Requires-Dist: json5
+Requires-Dist: click
+Requires-Dist: pydantic
+Requires-Dist: omegaconf
+Requires-Dist: pandas
+Requires-Dist: rich
+Requires-Dist: pyarrow
+Requires-Dist: python-dotenv
+Requires-Dist: questionary
+Provides-Extra: tests
+Requires-Dist: coverage; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: python-dotenv; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinxcontrib-programoutput; extra == "docs"
+Requires-Dist: sphinx-rtd-theme==1.2.2; extra == "docs"
+Requires-Dist: recommonmark; extra == "docs"
+
+# Integrated Modelling System Infrastructure (IMSI)
+
+[![Documentation Status](https://readthedocs.org/projects/imsi/badge/?version=latest)](https://imsi.readthedocs.io/en/latest/?version=latest)
+![Pipeline Status](https://gitlab.com/cccma/imsi/badges/main/pipeline.svg)
+![Coverage Status](https://gitlab.com/cccma/imsi/badges/main/coverage.svg)
+
+The **Integrated Modelling System Infrastructure (IMSI)** is a comprehensive Python-based package used to download, configure, build, and run the suite of models in the CCCma Integrated Modelling System.
+
+- **Documentation:** [https://imsi.readthedocs.io](https://imsi.readthedocs.io)
+
+---
+
+## License
+
+- [Open Government License – Canada version 2.0](https://open.canada.ca/en/open-government-licence-canada)
+
+---
+
+## Installation
+
+IMSI is normally pre-installed on support machines by technical staff, and users need only source an environment.
+
+You can install IMSI manually as shown below. It is recommended to install it inside a Python or Conda virtual environment.
+
+```bash
+python3 -m venv /path/to/new/virtual/environment 
+source /path/to/new/virtual/environment/activate
+# conda create -n imsi-test python=3.10
+
+git clone git@gitlab.science.gc.ca:CanESM/imsi.git
+cd imsi
+pip install .      # for usage
+# pip install -e . # for development
+```
+
+## Basic usage
+```bash
+imsi -h # for help
+
+# Setup a CanESM5.1 p1 CMIP6 piControl run
+imsi setup --repo=https://gitlab.com/cccma/canesm --ver=develop_canesm --exp=cmip6-piControl --model=canesm51_p1 --runid=imsi-test
+imsi build          # compile executables
+imsi save-restarts  # save desired restarts
+imsi submit         # submit the run
+```

cimsi-0.7.8/README.md

@@ -0,0 +1,45 @@
+# Integrated Modelling System Infrastructure (IMSI)
+
+[![Documentation Status](https://readthedocs.org/projects/imsi/badge/?version=latest)](https://imsi.readthedocs.io/en/latest/?version=latest)
+![Pipeline Status](https://gitlab.com/cccma/imsi/badges/main/pipeline.svg)
+![Coverage Status](https://gitlab.com/cccma/imsi/badges/main/coverage.svg)
+
+The **Integrated Modelling System Infrastructure (IMSI)** is a comprehensive Python-based package used to download, configure, build, and run the suite of models in the CCCma Integrated Modelling System.
+
+- **Documentation:** [https://imsi.readthedocs.io](https://imsi.readthedocs.io)
+
+---
+
+## License
+
+- [Open Government License – Canada version 2.0](https://open.canada.ca/en/open-government-licence-canada)
+
+---
+
+## Installation
+
+IMSI is normally pre-installed on support machines by technical staff, and users need only source an environment.
+
+You can install IMSI manually as shown below. It is recommended to install it inside a Python or Conda virtual environment.
+
+```bash
+python3 -m venv /path/to/new/virtual/environment 
+source /path/to/new/virtual/environment/activate
+# conda create -n imsi-test python=3.10
+
+git clone git@gitlab.science.gc.ca:CanESM/imsi.git
+cd imsi
+pip install .      # for usage
+# pip install -e . # for development
+```
+
+## Basic usage
+```bash
+imsi -h # for help
+
+# Setup a CanESM5.1 p1 CMIP6 piControl run
+imsi setup --repo=https://gitlab.com/cccma/canesm --ver=develop_canesm --exp=cmip6-piControl --model=canesm51_p1 --runid=imsi-test
+imsi build          # compile executables
+imsi save-restarts  # save desired restarts
+imsi submit         # submit the run
+```

cimsi-0.7.8/cimsi.egg-info/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.4
+Name: cimsi
+Version: 0.7.8
+Summary: Integrated Modelling System Infrastructure (IMSI) is a comprehensive software project used to download, configure, build and run the suite of models in the CCCma Integrated Modelling System.
+Author: CCCma Technical Development Team
+License: OGL-Canada-2.0
+Project-URL: Homepage, https://imsi.readthedocs.io/en/latest/
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: isodate
+Requires-Dist: cftime
+Requires-Dist: xarray
+Requires-Dist: dataclasses
+Requires-Dist: json5
+Requires-Dist: click
+Requires-Dist: pydantic
+Requires-Dist: omegaconf
+Requires-Dist: pandas
+Requires-Dist: rich
+Requires-Dist: pyarrow
+Requires-Dist: python-dotenv
+Requires-Dist: questionary
+Provides-Extra: tests
+Requires-Dist: coverage; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: python-dotenv; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinxcontrib-programoutput; extra == "docs"
+Requires-Dist: sphinx-rtd-theme==1.2.2; extra == "docs"
+Requires-Dist: recommonmark; extra == "docs"
+
+# Integrated Modelling System Infrastructure (IMSI)
+
+[![Documentation Status](https://readthedocs.org/projects/imsi/badge/?version=latest)](https://imsi.readthedocs.io/en/latest/?version=latest)
+![Pipeline Status](https://gitlab.com/cccma/imsi/badges/main/pipeline.svg)
+![Coverage Status](https://gitlab.com/cccma/imsi/badges/main/coverage.svg)
+
+The **Integrated Modelling System Infrastructure (IMSI)** is a comprehensive Python-based package used to download, configure, build, and run the suite of models in the CCCma Integrated Modelling System.
+
+- **Documentation:** [https://imsi.readthedocs.io](https://imsi.readthedocs.io)
+
+---
+
+## License
+
+- [Open Government License – Canada version 2.0](https://open.canada.ca/en/open-government-licence-canada)
+
+---
+
+## Installation
+
+IMSI is normally pre-installed on support machines by technical staff, and users need only source an environment.
+
+You can install IMSI manually as shown below. It is recommended to install it inside a Python or Conda virtual environment.
+
+```bash
+python3 -m venv /path/to/new/virtual/environment 
+source /path/to/new/virtual/environment/activate
+# conda create -n imsi-test python=3.10
+
+git clone git@gitlab.science.gc.ca:CanESM/imsi.git
+cd imsi
+pip install .      # for usage
+# pip install -e . # for development
+```
+
+## Basic usage
+```bash
+imsi -h # for help
+
+# Setup a CanESM5.1 p1 CMIP6 piControl run
+imsi setup --repo=https://gitlab.com/cccma/canesm --ver=develop_canesm --exp=cmip6-piControl --model=canesm51_p1 --runid=imsi-test
+imsi build          # compile executables
+imsi save-restarts  # save desired restarts
+imsi submit         # submit the run
+```