https://github.com/atmtools/konrad

Implementation of a radiative-convective equilibrium model.
https://github.com/atmtools/konrad

atmospheric-science hacktoberfest python python3 science

Last synced: 8 days ago
JSON representation

Implementation of a radiative-convective equilibrium model.

• Host: GitHub
• URL: https://github.com/atmtools/konrad
• Owner: atmtools
• License: mit
• Created: 2018-03-06T07:13:42.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-07-11T19:20:48.000Z (4 months ago)
• Last Synced: 2024-10-14T06:41:15.692Z (29 days ago)
• Topics: atmospheric-science, hacktoberfest, python, python3, science
• Language: Python
• Homepage:
• Size: 28.6 MB
• Stars: 19
• Watchers: 6
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff

Awesome Lists containing this project

• awesome-meteo - konrad - dimensional radiative-convective equilibrium (RCE) model. (Uncategorized / Uncategorized)

README

        
[![PyPI version](https://badge.fury.io/py/konrad.svg)](https://badge.fury.io/py/konrad)

[![Test](https://github.com/atmtools/konrad/workflows/Test/badge.svg?branch=main)](https://github.com/atmtools/konrad/commits/main)

[![Documentation Status](https://readthedocs.org/projects/konrad/badge/?version=latest)](https://konrad.readthedocs.io/?badge=latest)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1313687.svg)](https://doi.org/10.5281/zenodo.1313687)

# ![Logo](howto/images/konrad-logo_64.png) konrad

``konrad`` is a one-dimensional radiative-convective equilibrium (RCE) model.

It is build in an object oriented structure to allow simple modifications of

the model setup.

You can find various tutorials that illustrate the usage of ``konrad`` in our

["How to konrad"](https://atmtools.github.io/konrad) Jupyter book.

## Requirements

``konrad`` requires Python 3.6 or higher. The recommended way to get

Python is through [Anaconda](https://www.continuum.io/downloads).

But of course, any other Python distribution is also working.

## Install stable release

You can install the latest stable version of ``konrad`` using ``pip``:

```bash

python -m pip install konrad

```

Konrad depends on the [CliMT](https://github.com/CliMT/climt) package.

CliMT handles a variety of underlying FORTRAN code and provides precompiled

binary wheels for some Python versions and operating systems.

However (for Python >3.7) the FORTRAN libraries need to be compiled locally.

In this case, you need to specify a C compiler, a FORTRAN compiler, and the

target architecture using the corresponding environment variables:

```bash

CC=gcc FC=gfortran TARGET=HASWELL python -m pip install konrad

```

### macOS

On macOS, you may need to install the GCC compiler suite beforehand:

```bash

# Install GCC 11 and set it as C and Fortran compiler.

brew install gcc@12

CC=gcc-12 FC=gfortran-12

# Set the target architecture (different for Apple M1 [arm64]).

[[ $(uname -p) == arm64 ]] && TARGET=ARMV8 || TARGET=HASWELL

# Install a trimmed down version of CliMT that ships RRTMG only.

export CC FC TARGET

python -m pip install git+https://github.com/atmtools/climt@rrtmg-only

# Install konrad itself

python -m pip install konrad

```