-
Notifications
You must be signed in to change notification settings - Fork 48
Install
We offer two paths to install the PCMDI Metrics package. The preferred method is to install the Anaconda package and then install PCMDI Metrics using our conda channel. Alternatively, the older build from source install method is also supported.
- Install using Anaconda - Installation instructions for Anaconda users.
- Install on Ubuntu - Installation instructions for Ubuntu
- Install on RedHat or CentOS - Installation instructions for RedHat and CentOS
- Install on Mac OS X - Installation instructions for Mac
Step 1: Ensure your target machine has the following packages installed
- gfortran/gcc (v4.6 <= version < v5.2.2 - We do not support alternate compilers at this time)
- git
- XCode (with Command Line Tools; if on Mac OS X 10.10 with XCode v6.4.x and 10.11 with XCode 7.2.x)
- XQuartz (if on Mac OS X)
For more detailed information take a look at the UV-CDAT installation info pages
Step 2: Get the latest version of the install script
wget --no-check-certificate https://raw.githubusercontent.com/PCMDI/pcmdi_metrics/master/install_metrics.bash
Step 3: Edit the script to reflect your preferences, mainly you will need to edit
## Directory where to install UVCDAT and the METRICS Packages
install_prefix="PCMDI_METRICS" ; # relative path where UV-CDAT will be installed
## Temporary build directory
build_directory=""${install_prefix}/tmp" ; # relative path where temporary build files will be stored
## Speed up your build by increasing the following to match your number of processors
num_cpus=4 ; # number of cpus/cores available to the build (more = faster)
## Do we want to build with graphics capabilities
build_graphics=false
## Do we want MESA driver (non interactive graphics mode - useful for HPC environments)
build_graphics_against_mesa=true
## Do we want to build with CMOR
build_cmor=false
## Do we build UV-CDAT with parallel capabilities (MPI)
build_parallel=false
Step 4: Configure your user/system environment
On some systems you might need to specify the path of your local certificate (usually leave it blank), e.g.:
certificate=${HOME}/ca.llnl.gov.pem.cer
It may also be useful to turn off certificate checking for github.com
setenv GIT_SSL_NO_VERIFY 1 (*csh)
export GIT_SSL_NO_VERIFY=1 (bash)
Step 5: Run the install script
bash install_metrics.bash
Upon successful installation, the following confirmation will be presented:
*******************************
UVCDAT - master - Install Success
Metrics - master - Install Success
*******************************
Please test as follows:
source ${install_prefix}/bin/setup_runtime.sh or .csh ; # Assuming bash shell *.csh otherwise
python ${metrics_build_directory}/test/test_suite.py
*******************************
Create your customized input_parameters.py (inspire yourself from examples in ${install_prefix}/doc/pcmdi_input_parameters_sample.py
Once you have a parameter file run:
source ${install_prefix}/bin/setup_runtime.sh or .csh ; # Assuming bash shell *.csh otherwise
pcmdi_metrics_driver.py -p /path/to/your/edited/parameter_file.py
*******************************
Once everything is ok, you can safely remove the temporary build directory: ${install_prefix}/tmp
*******************************
For further information or suggestions please contact the PCMDI Metrics Team @ [email protected]
*******************************
Step 6: Create a parameter file for your run, you can inspire yourself from examples located in the metrics/doc subdirectory
Step 7: Run the metrics package
> pcmdi_metrics_driver.py -p /path/to/your/edited/parameter_file.py