cimsi 0.8.2.dev1__tar.gz → 0.8.4__tar.gz

cimsi-0.8.4/.gitlab/issue_templates/bug.md

@@ -0,0 +1,50 @@
+<!--
+** Please read **
+
+* Do not report bugs that are specific to your model repository source here.
+
+* Before opening a new issue, make sure to search for keywords in the issues
+  list and verify the issue you're about to submit isn't a duplicate:
+
+- internal: https://gitlab.science.gc.ca/CanESM/imsi/-/issues
+- external: https://gitlab.com/cccma/imsi/-/issues
+-->
+
+## Summary
+
+<!-- Provide a short summary of the bug encountered. -->
+
+### Current `bug` behaviour
+
+<!-- Describe what actually happens. -->
+
+### Expected correct behaviour
+
+<!-- Describe what you should see instead. -->
+
+### Steps to reproduce
+
+<!-- Describe how to reproduce the issue - use a numbered list. -->
+
+1.
+2.
+
+<!-- Where appropriate:
+- Add link to a branch with this error or other supporting pages.
+- Add relevant screenshots, logs, code, or output.
+-->
+
+<!-- v OPTIONAL, uncomment title v -->
+<!-- ## Possible fixes -->
+
+<!--
+Provide a link to the line of code that might be responsible for the problem; and/or suggest a fix.
+-->
+
+## Environment
+
+<!-- Include the version of imsi you used (run `which imsi`). -->
+**imsi version**:
+
+<!-- Leave this label, do not add others -->
+/label ~"bug"

cimsi-0.8.4/.gitlab/issue_templates/documentation.md

@@ -0,0 +1,26 @@
+<!--
+** Please read **
+
+* Use this issue template for suggesting new or updates to existing documentation.
+  Note: changes to documentation as part of feature development should be included
+  in those relevant issues.
+
+* Do not report documentation updates that are specific to your model repository source here.
+-->
+
+## Summary
+
+<!-- Provide a short summary of the documentation request here. -->
+
+## Details
+
+<!-- Provide more details, such as:
+- Describe the content that's erroneous or missing.
+- Provide link to file path or url that is affected.
+- Suggest cross-references that should be included in the content.
+- Suggest specific wording, graphics, or other helpful content.
+-->
+
+
+<!-- Leave this label, do not add others -->
+/label ~"docs"

cimsi-0.8.4/.gitlab/issue_templates/enhancement.md

@@ -0,0 +1,49 @@
+<!--
+** Please read **
+
+* Do not request enhancements that are specific to your model repository source here.
+
+* Before opening a new issue, make sure to search for keywords in the issues
+  list and verify the issue you're about to submit isn't a duplicate:
+
+- internal: https://gitlab.science.gc.ca/CanESM/imsi/-/issues
+- external: https://gitlab.com/cccma/imsi/-/issues
+-->
+
+## Summary
+
+<!-- Provide a short summary of the enhancement request here.
+- This should summarize the main idea and use-case of the feature.
+- Add links to related issues
+-->
+
+### Problem to solve
+
+<!-- Describe what this feature enhancement is trying to solve. -->
+
+### Proposal
+
+<!-- Describe the feature in detail and how it will work. -->
+
+<!-- Where appropriate:
+- Add relevant diagrams, mock-ups of interfaces, expected output, etc.
+- List potential risk factors, if known.
+-->
+
+<!-- v OPTIONAL, uncomment title v -->
+<!-- #### Implementation Plan -->
+
+<!--
+Provide an outline of where in the imsi code base this feature
+might live, which classes it may interact with, etc.
+-->
+
+### Importance
+
+<!-- Describe why this feature is important
+e.g., how this impacts workflow, how this may improve software functionality, why users might want to use it.
+-->
+
+
+<!-- Leave this label, do not add others -->
+/label ~"enhancement"

cimsi-0.8.4/.gitlab/issue_templates/feature.md

@@ -0,0 +1,48 @@
+<!--
+** Please read **
+
+* Do not request features that are specific to your model repository source here.
+
+* Before opening a new issue, make sure to search for keywords in the issues
+  list and verify the issue you're about to submit isn't a duplicate:
+
+- internal: https://gitlab.science.gc.ca/CanESM/imsi/-/issues
+- external: https://gitlab.com/cccma/imsi/-/issues
+-->
+
+## Summary
+
+<!-- Provide a short summary of the feature request here.
+- This should summarize the main idea and use-case of the feature.
+- Add links to related issues
+-->
+
+### Problem to solve
+
+<!-- Describe what this new feature is trying to solve. -->
+
+### Proposal
+
+<!-- Describe the feature in detail and how it will work. -->
+
+<!-- Where appropriate:
+- Add relevant diagrams, mock-ups of interfaces, expected output, etc.
+- List potential risk factors, if known.
+-->
+
+<!-- v OPTIONAL, uncomment title v -->
+<!-- #### Implementation Plan -->
+
+<!--
+Provide an outline of where in the imsi code base this feature
+might live, which classes it may interact with, etc.
+-->
+
+### Importance
+
+<!-- Describe why this feature is important
+e.g., how this impacts workflow, how this may improve software functionality, why users might want to use it.
+-->
+
+<!-- Leave this label, do not add others -->
+/label ~"feature"

cimsi-0.8.4/.gitlab/merge_request_templates/Default.md

@@ -0,0 +1,62 @@
+<!-- # IMSI Merge Request Template -->
+
+<!-- Use "Draft" for in progress, remove for review and trigger CI -->
+
+Closes:
+
+Related Issues:
+
+## Summary
+
+<!--
+Provide a brief and clean summary of what this MR does:
+* What problem does it solve?
+* Why is it needed?
+* Which part of IMSI (or related tool) does it affect?
+* Does this feature conflict with known future development or other systems?
+-->
+
+<!--
+If this MR causes a changed in imsi behaviour for the user:
+* Include the heading below, and list the changes.
+-->
+<!-- ### Behaviour Changes: -->
+
+<!--
+If this MR causes a config-breaking change:
+* Include the heading below, and list the changes.
+* Link to model repo MRs where this change is applied (update version requirements!)
+-->
+<!-- ### Config Breaking Changes: -->
+
+
+## Testing
+
+<!--
+Describe how this MR was tested:
+* Confirm that unit tests pass
+* Include steps to reproduce test cases (imsi commands, settings, etc)
+* List imsi and repo versions
+* Confirm BI model results when necessary (provide runid)
+-->
+
+<!-- v OPTIONAL, uncomment v -->
+<!-- ### Missing test coverage -->
+<!--
+List new tests need to be written here. Explain why they are not included in this MR.
+-->
+
+## Reviewers
+
+<!-- Select at least one member as reviewer (who will mark this MR as "approved"): -->
+**Functional Review**: @ras008 @rna001 @rrd001 @sts000
+
+<!-- Select at least one member as merger (who will execute the merge after approval):-->
+<!-- add @rna001 as a backup when needed-->
+**Integration Approval**: @ncs001 @nil001
+
+<!-- Select ONLY ONE of the labels by uncommenting; do not add others -->
+<!-- /label ~"bug" -->
+<!-- /label ~"enhancement" -->
+<!-- /label ~"feature" -->
+<!-- /label ~"docs" -->

{cimsi-0.8.2.dev1 → cimsi-0.8.4}/.gitlab/merge_request_templates/imsi_mr.md

@@ -6,7 +6,6 @@ Closes:
 
 Related Issues:
 
-
 ## Summary
 
 <!--
@@ -17,13 +16,18 @@ Provide a brief and clean summary of what this MR does:
 * Does this feature conflict with known future development or other systems?
 -->
 
+<!--
+If this MR causes a changed in imsi behaviour for the user:
+* Include the heading below, and list the changes.
+-->
+<!-- ### Behaviour Changes: -->
 
 <!--
 If this MR causes a config-breaking change:
 * Include the heading below, and list the changes.
 * Link to model repo MRs where this change is applied (update version requirements!)
 -->
-<!-- ### Config Breaking Changes**: -->
+<!-- ### Config Breaking Changes: -->
 
 
 ## Testing
@@ -42,14 +46,6 @@ Describe how this MR was tested:
 List new tests need to be written here. Explain why they are not included in this MR.
 -->
 
-
-## References
-
-<!--
-* Related documentation or configuration paths
--->
-
-
 ## Reviewers
 
 <!-- Select at least one member as reviewer (who will mark this MR as "approved"): -->
@@ -58,3 +54,9 @@ List new tests need to be written here. Explain why they are not included in thi
 <!-- Select at least one member as merger (who will execute the merge after approval):-->
 <!-- add @rna001 as a backup when needed-->
 **Integration Approval**: @ncs001 @nil001
+
+<!-- Select ONLY ONE of the labels by uncommenting; do not add others -->
+<!-- /label ~"bug" -->
+<!-- /label ~"enhancement" -->
+<!-- /label ~"feature" -->
+<!-- /label ~"docs" -->

{cimsi-0.8.2.dev1 → cimsi-0.8.4}/.gitlab-ci.yml

@@ -1,58 +1,32 @@
-stages:
-  - test
-  - deploy
-  - publish
-  - cleanup
-
-variables:
-  GIT_STRATEGY: none # we manually handle the source repo in a persistent location
-  GIT_DEPTH: "0"
-  CI_WRK_DIR: "/home/scrd105/s5-runpath/imsi-ci/${CI_PIPELINE_ID}/"
-  CI_JOB_RUN_DIR: "${CI_WRK_DIR}/${CI_JOB_ID}"
-  UV_LINK_MODE: copy
-  UV_PUBLISH_TOKEN: $UV_PUBLISH_TOKEN
-  IMSI_DEPLOYED_PYTHON_VER: "3.12"
-  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 CanE
-
-before_script:
-  # clone to the CI_JOB_RUN_DIR
-  - mkdir -p "${CI_JOB_RUN_DIR}"
-  - git clone "${CI_REPOSITORY_URL}" "${CI_JOB_RUN_DIR}"
-  - cd "${CI_JOB_RUN_DIR}"
-  - git checkout "${CI_COMMIT_SHA}"
-    
+# -----------------------------
+# Templates
+# -----------------------------
+.internal_job: &internal_job
+  tags:
+    - u3
+
+.upstream_tag_rules: &upstream_tag_rules
+  - if: '$CI_COMMIT_TAG && $CI_PROJECT_URL == "https://gitlab.science.gc.ca/CanESM/imsi"'
+    when: on_success
+  - when: never
 
-after_script:
-  # this only cleans up the single job
-  # leaving behind and empty dir
-  - echo "Cleaning up ${CI_JOB_RUN_DIR}"
-  - rm -rf "${CI_JOB_RUN_DIR}"
+.publish_rules: &publish_rules
+  - if: '$CI_COMMIT_TAG && $CI_PROJECT_URL == "https://gitlab.science.gc.ca/CanESM/imsi" && $CI_COMMIT_TAG !~ /(rc|dev)[0-9]*$/'
+    when: on_success
+  - when: never
 
-  
-.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: |
-    echo "Running the imsi tests..."
-    # setup environment
-    ${UV_BINARY} venv --python=${PYTHON_VERSION}
-    source .venv/bin/activate && ${UV_BINARY} pip install pip
-    pip install --upgrade setuptools
-    pip install $CI_JOB_RUN_DIR[tests]
+.release_template: &release_template
+  tags:
+    - u3
+  allow_failure: false
 
-    # Run tests
-    coverage run -m pytest -x ${CI_JOB_RUN_DIR}/tests/
-    coverage report -m
-    coverage xml -o coverage.xml
-  coverage: '/TOTAL\s+[0-9]+\s+[0-9]+\s+([0-9]+)%/'
+.publish_template: &publish_template
+  tags:
+    - u3
+  allow_failure: false
+  rules: *publish_rules
 
 .test_trigger_rules: &test_trigger_rules
-  # Only run these rules on gitlab.science.gc.ca
-  - if: '$CI_SERVER_HOST != "gitlab.science.gc.ca"'
-    when: never
-
   # 1. Skip if MR title starts with "Draft:"
   - if: '$CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TITLE =~ /^Draft:/'
     when: never
@@ -69,82 +43,118 @@ after_script:
   - when: never
 
 
+.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: |
+    echo "Running the imsi tests..."
+    # setup environment
+    ${UV_BINARY} venv --python=${PYTHON_VERSION}
+    source .venv/bin/activate && ${UV_BINARY} pip install pip
+    pip install --upgrade setuptools
+    pip install $CI_JOB_RUN_DIR[tests]
+
+    # Dynamic runid (CI override) - hash to shorten
+    HASH_STRING=$( echo "${CI_PIPELINE_ID}-${CI_COMMIT_SHA}" | md5sum | cut -c 1-7 )
+    RUNID_BASE=ci-${HASH_STRING}
+
+    # Run tests
+    coverage run -m pytest -x ${CI_JOB_RUN_DIR}/tests/ --target-runid-base=${RUNID_BASE}
+    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
+  <<: [*test_job_template, *internal_job]
   parallel:
     matrix:
       - PYTHON_VERSION: ['3.12', '3.13']
 
-test:
-  stage: test
-  <<: *matrix_job_template
-  rules: *test_trigger_rules
+# ------------------------------------
+# CI/CD
+# ------------------------------------
 
+stages:
+  - test
+  - deploy
+  - link_latest
+  - publish
+  - cleanup
 
-test-cp4c:
-  before_script: [] # override global before before_script
-  after_script: [] # override global after_script
-  stage: test
-  parallel:
-    matrix:
-      - PYTHON_VERSION: ['3.12', '3.13']
+variables:
+  GIT_STRATEGY: none # we manually handle the source repo in a persistent location
+  GIT_DEPTH: "0"
+  CI_WRK_DIR: "${IMSI_CI_RUNPATH}/${CI_PIPELINE_ID}/"
+  CI_JOB_RUN_DIR: "${CI_WRK_DIR}/${CI_JOB_ID}"
+  UV_LINK_MODE: copy
+  IMSI_DEPLOYED_PYTHON_VER: "3.12"
+  UV_BINARY: "/home/scrd102/.local/bin/uv"
+  CANESM_REF_REPO: "/home/scrd102/cccma_libs/canesm/"  # change once we have CD for CanE
+  # IMSI_DEPLOY_PATH is defined under the gitlab ci variables
 
-  image: ghcr.io/astral-sh/uv:python$PYTHON_VERSION-alpine
-  variables:
-    # IMSI test vars
-    TEST_USER: 'test_user'
-    TEST_EXP: 'cmip6-piControl'
-    TEST_VERSION: 'v5.1_cp4c'
-    TEST_MODEL: 'canesm51_p1'
-    TEST_EXT_REPO: 'https://gitlab.com/cccma/canesm.git'
-    TEST_MACHINE: 'trillium'
-    TEST_SEQ: 'iss'
-    # Vars used in CI/CD
-    BASE_LAYER: alpine
-    UV_LINK_MODE: copy
-  script: 
-    - apk update && apk add git
-    - uv venv
-    - source .venv/bin/activate
-    - pip install --upgrade setuptools
-    - pip install .[tests]
-    - coverage run -m pytest tests/
+workflow:
   rules:
-    # Only run this job on the EXTERNAL mirror
-    - if: '$CI_SERVER_HOST == "gitlab.com"'
-      when: on_success
-
-    # Fallback: never run internally
+    - if: '$CI_SERVER_HOST == "gitlab.science.gc.ca"'
     - when: never
 
+before_script:
+  - mkdir -p "$CI_JOB_RUN_DIR"
+  - |
+    if [[ -n "$CI_MERGE_REQUEST_SOURCE_PROJECT_URL" ]]; then
+      echo "Cloning fork with CI job token"
+      AUTH_URL=$(echo "$CI_MERGE_REQUEST_SOURCE_PROJECT_URL" \
+        | sed "s#https://#https://gitlab-ci-token:${CI_JOB_TOKEN}@#")
+      git clone "$AUTH_URL" "$CI_JOB_RUN_DIR"
+    else
+      git clone "$CI_REPOSITORY_URL" "$CI_JOB_RUN_DIR"
+    fi
+
+  - cd "$CI_JOB_RUN_DIR"
+  - git fetch --tags origin
+  - git fetch origin "$CI_COMMIT_REF_NAME"
+  - git checkout "${CI_COMMIT_TAG:-$CI_COMMIT_SHA}"
+
+
+after_script:
+  # this only cleans up the single job
+  # leaving behind and empty dir
+  - echo "Cleaning up ${CI_JOB_RUN_DIR}"
+  - rm -rf "${CI_JOB_RUN_DIR}"
+
+# ------------------------
+# Stages
+# ------------------------
+test:
+  stage: test
+  <<: *matrix_job_template
+  rules: *test_trigger_rules
 
 deploy:
   stage: deploy
+  <<: *internal_job
   script: |
-    # make the deploy location
-    mkdir -p ${IMSI_DEPLOY_PATH}/latest
-    cd ${IMSI_DEPLOY_PATH}
-
     # pass Python version, tag, and deploy path as arguments
-    source ${CI_JOB_RUN_DIR}/tests/deploy_imsi_env.sh "${IMSI_DEPLOYED_PYTHON_VER}" "${CI_COMMIT_TAG}" "${IMSI_DEPLOY_PATH}" "${CANESM_REF_REPO}"
-  rules:
-    # Only run these rules on gitlab.science.gc.ca
-    - if: '$CI_SERVER_HOST != "gitlab.science.gc.ca"'
-      when: never
+    source tests/deploy_imsi_env.sh "${IMSI_DEPLOYED_PYTHON_VER}" "${CI_COMMIT_TAG}" "${IMSI_DEPLOY_PATH}" "${CANESM_REF_REPO}"
+  rules: *upstream_tag_rules
 
-    - if: $CI_COMMIT_TAG
+link_latest:
+  stage: link_latest
+  script: |
+    CURRENT_DATE=$(date +%Y-%m-%d)
+    ENV_NAME="pyenv_${IMSI_DEPLOYED_PYTHON_VER}_imsi_${CI_COMMIT_TAG}_${CURRENT_DATE}"
+    VENV_PATH="${IMSI_DEPLOY_PATH}/${ENV_NAME}"
+
+    ln -sfnT "${VENV_PATH}" "${IMSI_DEPLOY_PATH}/latest"
+  <<: *release_template
+  rules: *publish_rules
 
 publish:
   stage: publish
   script:
     - ${UV_BINARY} build
     - ${UV_BINARY} publish
-  rules:
-    # Only run these rules on gitlab.science.gc.ca
-    - if: '$CI_SERVER_HOST != "gitlab.science.gc.ca"'
-      when: never
-
-    - if: $CI_COMMIT_TAG
+  <<: *publish_template
 
 
 cleanup:
@@ -156,10 +166,6 @@ cleanup:
   allow_failure: true
   interruptible: false    # ensure cleanup runs even if pipeline is canceled
   rules:
-    # Only run these rules on gitlab.science.gc.ca
-    - if: '$CI_SERVER_HOST != "gitlab.science.gc.ca"'
-      when: never
-
     # Run cleanup for ALL cases where pipeline actually runs useful jobs
     # 1. Merge requests (draft or not, success or fail)
     - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
@@ -175,4 +181,43 @@ cleanup:
 
     # 4. Fallback: never
     - when: never
+  <<: *internal_job
+
+# --------------------
+# External UNTESTED
+# --------------------
+test-cp4c:
+  before_script: [] # override global before before_script
+  after_script: [] # override global after_script
+  stage: test
+  parallel:
+    matrix:
+      - PYTHON_VERSION: ['3.12', '3.13']
+
+  image: ghcr.io/astral-sh/uv:python$PYTHON_VERSION-alpine
+  variables:
+    # IMSI test vars
+    TEST_USER: 'test_user'
+    TEST_EXP: 'cmip6-piControl'
+    TEST_VERSION: 'v5.1_cp4c'
+    TEST_MODEL: 'canesm51_p1'
+    TEST_EXT_REPO: 'https://gitlab.com/cccma/canesm.git'
+    TEST_MACHINE: 'trillium'
+    TEST_SEQ: 'iss'
+    # Vars used in CI/CD
+    BASE_LAYER: alpine
+    UV_LINK_MODE: copy
+  script: 
+    - apk update && apk add git
+    - uv venv
+    - source .venv/bin/activate
+    - pip install --upgrade setuptools
+    - pip install .[tests]
+    - coverage run -m pytest tests/
+  rules:
+    # Only run this job on the EXTERNAL mirror
+    - if: '$CI_SERVER_HOST == "gitlab.com"'
+      when: on_success
 
+    # Fallback: never run internally
+    - when: never