Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: ClKroll
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 6.89 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 2 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Code of conduct Citation

README.md

PyPI version Test Documentation Status DOI

Logo 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" Jupyter book.

Requirements

konrad requires Python 3.6 or higher. The recommended way to get Python is through Anaconda. 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 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 ```

Owner

  • Name: Clarissa Alicia Kroll
  • Login: ClKroll
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Kluft"
  given-names: "Lukas"
  orcid: "https://orcid.org/0000-0002-6533-3928"
- family-names: "Dacie"
  given-names: "Sally"
  orcid: "https://orcid.org/0000-0002-7572-2903"
- family-names: "Bourdin"
  given-names: "Stella"
  orcid: "https://orcid.org/0000-0003-2635-5654"
title: "konrad"
url: "https://github.com/atmtools/konrad"
keywords:
  - python3
  - atmospheric-science
license: MIT
repository-code: "https://github.com/atmtools/konrad"
type: software

GitHub Events

Total
Last Year

Dependencies

.github/workflows/build-book.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/build-test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/python-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
environment.yaml pypi
  • climt *
  • sympl >=0.4.0
pyproject.toml pypi
setup.py pypi