Data

Tools

Indexes

Applications

Experiments

Open Source Science

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

A conda (mamba) python environment for running ACCESS-RAM

https://github.com/access-nri/access-ram-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 (11.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

A conda (mamba) python environment for running ACCESS-RAM

Basic Info
  • Host: GitHub
  • Owner: ACCESS-NRI
  • License: apache-2.0
  • Language: Shell
  • Default Branch: main
  • Size: 34.2 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 2
  • Releases: 8
Created almost 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme License

README.md

access-ram-condaenv

This repository is created taking payu-condaenv as a reference.

Overview

This repository is responsible for building, packaging and deploying the environment needed to run the replace_landsurface python scripts, as part of ACCESS-RAM3. This environment is created as a micromamba environment.

Usage

Triggering a Deployment

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

  • Open a PR modifying the env.yml file.
  • The env.yml will be checked for validity.
  • When the PR 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 Environment

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

Gadi

  1. Make sure you're a member of the <PROJECT_TO_BE_DEFINED> 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.

  2. Once you are a member, run the following:

bash module use /g/data/vk83/modules module load conda/access-ram3/<VERSION>

You are set to run ACCESS-RAM3.

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 access-ram-<VERSION>.tar.gz access-ram and then ./access-ram/bin/activate to activate the environment.
  • To use the lockfile, you can run micromamba create -n environment-name -f access-ram.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
  • Create event: 13
  • Release event: 4
  • Issues event: 8
  • Watch event: 1
  • Delete event: 10
  • Member event: 2
  • Issue comment event: 4
  • Push event: 79
  • Pull request review comment event: 30
  • Pull request review event: 30
  • Pull request event: 14
  • Fork event: 1
Last Year
  • Create event: 13
  • Release event: 4
  • Issues event: 8
  • Watch event: 1
  • Delete event: 10
  • Member event: 2
  • Issue comment event: 4
  • Push event: 79
  • Pull request review comment event: 30
  • Pull request review event: 30
  • Pull request event: 14
  • Fork event: 1

Dependencies

.github/workflows/check-valid-env-dev.yml actions
  • actions/checkout v4 composite
  • mamba-org/setup-micromamba f8b8a1e23a26f60a44c853292711bacfd3eac822 composite
.github/workflows/check-valid-env.yml actions
  • actions/checkout v4 composite
  • mamba-org/setup-micromamba f8b8a1e23a26f60a44c853292711bacfd3eac822 composite
.github/workflows/validate-json.yml actions
.github/workflows/deploy.yml actions
  • access-nri/actions/.github/actions/setup-ssh main composite
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/upload-artifact v4 composite
  • mamba-org/setup-micromamba f8b8a1e23a26f60a44c853292711bacfd3eac822 composite
  • softprops/action-gh-release c062e08bd532815e2082a85e87e3ef29c3e6d191 composite
.github/workflows/update-module.yml actions
  • access-nri/actions/.github/actions/setup-ssh main composite
  • actions/checkout v4 composite