Community Analysis Pipeline (CAP)

Welcome to the Mars Climate Modeling Center (MCMC) Community Analysis Pipeline (CAP).

About

CAP is a set of Python3 libraries and command-line executables that streamline downloading, processing, and plotting output from the NASA Ames Mars Global Climate Models:

• NASA Ames Legacy Mars GCM
• NASA Ames Mars GCM with GFDL's FV3 dynamical core

Installation

Requirements:

• Python 3.7 or later
• pip (Python package installer)

Recommended Installation

For reproducible analysis, we recommend installing CAP in a dedicated virtual environment. Please reference our installation instructions online. Briefly, a virtual environment looks like this:

# Create a new virtual environment with pip or conda:
python3 -m venv amescap-env # with pip
# OR
conda create -n amescap python=3.13 # with conda

# Activate the environment, which varies by OS, shell, and package manager:
source amescap-env/bin/activate     # pip + Unix/MacOS (bash) OR Windows Cygwin
# OR
source amescap-env/bin/activate.csh # pip + Unix/MacOS (csh/tcsh/zsh)
# OR
amescap-env\Scripts\activate        # pip + Windows PowerShell
# OR
conda activate amescap-env          # conda + Unix/MacOS (bash, csh, tcsh, zsh) OR Windows Cygwin
# OR
.\amescap\Scripts\Activate.ps1      # conda + Windows PowerShell

# Install CAP and its dependencies
pip install git+https://github.com/NASA-Planetary-Science/AmesCAP.git
# OR install a specific branch with:
pip install git+https://github.com/NASA-Planetary-Science/AmesCAP.git@devel

# For spectral analysis capabilities, please follow the installation instructions.

# Copy amescap_profile to your home directory, which varies by OS, shell, and package manager:
# pip + Unix/MacOS (bash, csh, tcsh, zsh) OR Windows Cygwin:
cp amescap/mars_templates/amescap_profile ~/.amescap_profile
# OR pip + Windows Powershell:
Copy-Item .\amescap\mars_templates\amescap_profile -Destination $HOME\.amescap_profile
# OR conda + Unix/MacOS (bash, csh, tcsh, zsh):
cp /opt/anaconda3/envs/amescap/mars_templates/amescap-profile ~/.amescap-profile
# OR conda + Windows Cygwin:
cp /cygdrive/c/Users/YourUsername/anaconda3/envs/amescap/mars_templates/amescap-profile ~/.amescap-profile
# OR conda + Windows Powershell:
Copy-Item $env:USERPROFILE\anaconda3\envs\amescap\mars_templates\amescap-profile -Destination $HOME\.amescap-profile

This ensures consistent package versions across different systems.

For spectral analysis capabilities, please follow the installation instructions.

Available Commands

After installation, the following commands will be available:

• MarsInterp - Interpolate data to pressure or altitude coordinates
• MarsPull - Download model outputs
• MarsPlot - Create visualizations
• MarsVars - Process and analyze variables
• MarsFiles - Manage data files
• MarsFormat - Convert between model/reanalysis formats
• MarsCalendar - Handle Mars calendar calculations

Documentation

Full documentation is available at readthedocs.io.

Getting Started

The tutorial directory contains:

• Installation instructions for Linux, MacOS, and Windows
• Documentation of CAP functions
• Practice exercises to familiarize users with CAP
  • NASA Ames MGCM Tutorial
  • Legacy GCM Tutorial

Data Sources

The tutorials use MGCM simulation outputs documented in Haberle et al. 2019. Data is available through the MCMC Data Portal.

Contributing

We welcome contributions! Please see our contributing guidelines for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Citation

If you use CAP in your research, please cite: (APA) NASA Ames Mars Climate Modeling Center (2024). Community Analysis Pipeline [Computer software]. NASA Planetary Science GitHub.