/cannon-env

Linux environment files for the FASRC Cannon cluster.

Primary LanguageEmacs LispOtherNOASSERTION

ACMG logo

Latest Release Release Date License

cannon-env: Configuration files for Cannon

This repository (cannon-env) contains scripts and configuration files that you can use to customize your login environment on the FASRC Cannon cluster.

Installation

We recommend downloading this repository to your Cannon home directory. Type the following commands at the command-line prompt:

cd ~
git clone --recurse-submodules https://github.com/Harvard-ACMG/cannon-env.git

We have provided a script named copy-cannon-env that will copy the relevant scripts and configuration files to the proper places in your home directory. To execute the script, type at the command-line prompt:

cd cannon-env
./copy-cannon-env

Contents

When you run ./copy-cannon-env, several configuration files and scripts will be copied to your home directory as well as several subfolders (which will be created if they do not exist).

Any existing configuration files will be backed up to timestamped folders (.backup/YYYY-MM-DDThh-mm-ss). This will allow you to copy over any previous customizations from the backup configuration files to the new configuration files.

root

This folder contains startup scripts, which will be copied to your home directory (aka ~ or $HOME). You may modify some of these scripts to customize your Cannon login environment. For a list of files in this folder, please see root/README.md.

bin

This folder contains several user convenience scripts, which will be copied to your $HOME/bin folder. For a complete desciption, please see bin/README.md.

envs

This directory contains scripts that the proper Cannon software modules for GEOS-Chem Classic and GCHP. For a complete description, please see envs/README.md.

IDL

This directory contains scripts that initialize your IDL session. Please see IDL/README.md for more information.

Reporting bugs or technical issues

Please report any bugs or technical issues you may encounter by opening a new issue. We try to ensure that this repository is kept up-to-date as possible. But there is always the possibility that Cannon software or operating system upgrades may "break" the functionality provided by these configuraton files.