Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/access-nri/payu-condaenv

A conda (mamba) python environment for running payu

https://github.com/access-nri/payu-condaenv

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary

Keywords

conda infrastructure model-release-team
Last synced: 5 months ago · JSON representation

Repository

A conda (mamba) python environment for running payu

Basic Info
  • Host: GitHub
  • Owner: ACCESS-NRI
  • License: apache-2.0
  • Language: Shell
  • Default Branch: main
  • Homepage:
  • Size: 59.6 KB
Statistics
  • Stars: 0
  • Watchers: 5
  • Forks: 2
  • Open Issues: 4
  • Releases: 6
Topics
conda infrastructure model-release-team
Created over 2 years ago · Last pushed about 1 year ago
Metadata Files
Readme License

README.md

payu-condaenv

[!NOTE] Containerised conda environments for payu are now being deployed in ACCESS-NRI/model-release-condaenv so any issues with payu module versions from 1.1.6 onwards should be created there.

Overview

This repository is responsible for building, packaging and deploying payu as a micromamba environment.

Usage

Triggering a Deployment

In order to trigger a deployment, some steps must be followed:

  • First, check that a new version of payu has been added to the accessnri conda channel. This is done via CD on the payu-org/payu repository when a new tag is pushed.
  • Open a PR modifying the env.yml file to refer to the newly updated version of payu. The env.yml will be checked for validity and that the version of payu is defined.
  • When this is merged, the env.yml will be used to create a micromamba environment. This is then packaged using conda-pack, and deployed to the appropriate targets (eg. Gadi).

Using the Deployed Payu

On all of the deployment targets, the deployed Payu environment can be activated using Environment Modules.

Gadi

Make sure you're a member of the vk83 project! If not, see how to join an NCI project.

Important: make sure you do not have another conda environment active - either run conda deactivate or module unload any modules that are using conda.

Once you are a member, run the following:

bash module use /g/data/vk83/modules module load payu/VERSION

Payu can then be invoked with payu COMMAND. See payu --help for more information.

Notes

On Future Deployment Environments

New deployment environments must be created as a GitHub Environment and also have an entry in the config/deployment-environment.json file.

Deploying locally

To deploy locally, you can use the assets created in the release. Releases are found here. Specifically:

  • To use the compressed environment (which doesn't require conda or python) you can run tar -xzf payu-VERSION.tar.gz payu-VERSION and then ./payu-VERSION/bin/activate to activate the environment.
  • To use the lockfile, you can run micromamba create -n my-environment -f payu-VERSION.conda-lock.yml with an appropriate install of micromamba.

Owner

  • Name: ACCESS-NRI
  • Login: ACCESS-NRI
  • Kind: organization
  • Email: access.nri@anu.edu.au

Australian Earth System Simulator - National Research Infrastructure

GitHub Events

Total
  • Issues event: 5
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 1
  • Pull request review event: 2
  • Pull request event: 4
  • Create event: 2
Last Year
  • Issues event: 5
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 1
  • Pull request review event: 2
  • Pull request event: 4
  • Create event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 1
  • Average time to close issues: about 1 year
  • Average time to close pull requests: 9 minutes
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 4.0
  • Average comments per pull request: 1.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 9 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • jo-basevi (6)
  • aidanheerdegen (4)
  • CodeGat (2)
  • truth-quark (1)
Pull Request Authors
  • jo-basevi (10)
  • CodeGat (2)
  • anton-seaice (1)
  • blimlim (1)
Top Labels
Issue Labels
add dependency (4)
Pull Request Labels

Dependencies

.github/workflows/check-valid-env.yml actions
  • actions/checkout v4 composite
  • mamba-org/setup-micromamba v1.7.0 composite
.github/workflows/deploy.yml actions
  • access-nri/actions/.github/actions/setup-ssh main composite
  • actions/checkout v4 composite
  • actions/download-artifact v3.0.2 composite
  • actions/upload-artifact v3 composite
  • mamba-org/setup-micromamba v1.7.0 composite
  • softprops/action-gh-release v0.1.15 composite
.github/workflows/update-module.yml actions
  • access-nri/actions/.github/actions/setup-ssh main composite
  • actions/checkout v4 composite
.github/workflows/validate-json.yml actions