CoNES User Guide

Welcome to the Containerisation of NEMO Employing Singularity (CoNES) User Guide!

This guide aims to give an overview of how to build and run a NEMO Singularity Image File (SIF). Dependencies, worked examples, and how to integrate the build and distribution process with GitHub will also be covered.

This is by no means a definitive guide and not the only way to achieve the containerisation of an Ocean Model!

Getting Started & Background Information

• Introduction to CoNES
  • NEMO
  • Singularity
  • Reproducible science
• Quick Start
  • Setting up the environment
  • Download a pre-built NEMO SIF
  • Submitting a Job
  • Output Data

Building and Deploying a NEMO Container

• Build a NEMO SIF
  • Definition File
  • The Build
  • Fake Root
  • GitHub Builds
  • Further Features
  • Converting images from one format to another
• Running on HPC
  • Hybrid versus Bind methods
• Performance
  • Scaling Tests
  • Bare-metal
  • NEMO SIF
  • Summary

Reference

• Sharing
  • Zenodo
  • GitHub
  • Reproducible science
• Appendix