Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/open-atmos/camp

Multi-phase chemistry treatment for atmospheric models
https://github.com/open-atmos/camp

Last synced: 9 days ago
JSON representation

Multi-phase chemistry treatment for atmospheric models

Host: GitHub
URL: https://github.com/open-atmos/camp
Owner: open-atmos
License: mit
Created: 2021-07-28T14:31:48.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-12-16T11:36:47.000Z (21 days ago)
Last Synced: 2024-12-24T18:09:55.101Z (12 days ago)
Language: Fortran
Homepage:
Size: 490 MB
Stars: 14
Watchers: 8
Forks: 9
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: COPYING

Awesome Lists containing this project

open-sustainable-technology - CAMP - Allows a given chemical mechanism to be solved in atmospheric models with different aerosol representations. (Atmosphere / Atmospheric Chemistry and Aerosol)

README

        
CAMP

======

CAMP: Chemistry Across Multiple Phases

[![Latest version](https://img.shields.io/github/tag/open-atmos/camp.svg?label=version)](https://github.com/open-atmos/camp/blob/main/ChangeLog.md)

[![CI Status](https://github.com/open-atmos/camp/actions/workflows/main.yml/badge.svg)](https://github.com/open-atmos/camp/actions/workflows/main.yml)

[![License](https://img.shields.io/github/license/open-atmos/camp.svg)](https://github.com/open-atmos/camp/blob/main/COPYING)

The full CAMP documentation, including the BootCAMP tutorial is available [here](https://open-atmos.github.io/camp).

References:

   * [M. Dawson, C. Guzman, J. H. Curtis, M. Acosta, S. Zhu, D. Dabdub,

     A. Conley, M. West, N. Riemer, and O. Jorba (2022),

     Chemistry Across Multiple Phases (CAMP) version 1.0: An

     Integrated multi-phase chemistry model, Geosci. Model Dev. 15](https://doi.org/10.5194/gmd-15-3663-2022)

Copyright (C) 2017–2021 Barcelona Supercomputing Center and the

University of Illinois at Urbana–Champaign

Running CAMP with Docker

==========================

This is the fastest way to get running.

* **_Step 1:_** Install [Docker Community Edition](https://www.docker.com/community-edition).

    * On Linux and MacOS this is straightforward. [Download from here](https://store.docker.com/search?type=edition&offering=community).

    * On Windows the best version is [Docker Community Edition for Windows](https://store.docker.com/editions/community/docker-ce-desktop-windows), which requires Windows 10 Pro/Edu.

* **_Step 2:_** Run the CAMP test suite with:

```text

docker run -it --rm ghcr.io/open-atmos/camp:main bash -c 'cd /build; make test'

```

Dependencies

============

Required dependencies:

   * Fortran 2008 compiler -  or similar

   * CMake version 2.6.4 or higher - 

   * json-fortran for JSON input file support -

     

   * SuiteSparse - 

   * A modified version of CVODE 3.1.2 - provided here in `cvode-3.4-alpha.tar.gz`

Installation

============

1. Install cmake, json-fortran, SuiteSparse, and CVODE (see above).

2. Unpack CAMP:

        tar xzvf camp-1.0.0.tar.gz

3. Change into the main CAMP directory (where this README file is

   located):

        cd camp-1.0.0

4. Make a directory called `build` and change into it:

        mkdir build

        cd build

5. If desired, set environment variables to indicate the install

   locations of supporting libraries. If running `echo $SHELL`

   indicates that you are running `bash`, then you can do something

   like:

        export JSON_FORTRAN_HOME=${HOME}/opt

        export SUITE_SPARSE_HOME=${HOME}/opt

        export SUNDIALS_HOME=${HOME}/opt

   Of course the exact directories will depend on where the libraries

   are installed. You only need to set variables for libraries

   installed in non-default locations, and only for those libraries

   you want to use.

   If `echo $SHELL` instead is `tcsh` or similar, then the environment

   variables can be set like `setenv NETCDF_HOME /` and similarly.

6. Run cmake with the main CAMP directory as an argument (note the

   double-c):

        ccmake ..

7. Inside ccmake press `c` to configure, edit the values as needed,

   press `c` again, then `g` to generate. Optional libraries can be

   activated by setting the `ENABLE` variable to `ON`. For a parallel

   build, toggle advanced mode with `t` and set the

   `CMAKE_Fortran_COMPILER` to `mpif90`, then reconfigure.

8. Optionally, enable compiler warnings by pressing `t` inside ccmake

   to enable advanced options and then setting `CMAKE_Fortran_FLAGS`

   to:

        -O2 -g -fimplicit-none -W -Wall -Wconversion -Wunderflow -Wimplicit-interface -Wno-compare-reals -Wno-unused -Wno-unused-parameter -Wno-unused-dummy-argument -fbounds-check

8. Compile CAMP and test it as follows. Some tests may fail due to

   bad random initial conditions, so re-run the tests a few times to

   see if failures persist.

        make

        make test