konrad

Implementation of a radiative-convective equilibrium model.

https://github.com/atmtools/konrad

Science Score: 77.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
  • Committers with academic emails
    6 of 17 committers (35.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.4%) to scientific vocabulary

Keywords

atmospheric-science hacktoberfest python python3 science
Last synced: 4 months ago · JSON representation ·

Repository

Implementation of a radiative-convective equilibrium model.

Basic Info
  • Host: GitHub
  • Owner: atmtools
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 28.9 MB
Statistics
  • Stars: 20
  • Watchers: 5
  • Forks: 16
  • Open Issues: 2
  • Releases: 15
Topics
atmospheric-science hacktoberfest python python3 science
Created almost 8 years ago · Last pushed 10 months 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: atmtools
  • Login: atmtools
  • Kind: organization

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"
- family-names: "Kroll"
  given-names: "Clarissa"
  orcid: "https://orcid.org/0000-0002-3449-418X"
- family-names: "Czarnecki"
  given-names: "Paulina"
  orcid: "https://orcid.org/0000-0002-5011-882X"
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
  • Watch event: 3
  • Issue comment event: 1
  • Push event: 1
  • Pull request event: 1
Last Year
  • Watch event: 3
  • Issue comment event: 1
  • Push event: 1
  • Pull request event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 852
  • Total Committers: 17
  • Avg Commits per committer: 50.118
  • Development Distribution Score (DDS): 0.464
Past Year
  • Commits: 16
  • Committers: 3
  • Avg Commits per committer: 5.333
  • Development Distribution Score (DDS): 0.313
Top Committers
Name Email Commits
Lukas Kluft l****t@g****m 457
lkluft l****t@0****d 155
SallyDa s****e@g****m 136
sdacie s****e@0****d 43
sbourdin s****n@L****R 15
Paulina Czarnecki p****3@c****u 13
Stella Bourdin s****n@m****e 9
Clarissa Kroll m****3@m****e 6
TheresaLang t****g@g****t 3
hgloeckner 5****7 3
Moritz Guenther m****r@w****e 3
Diego Jimenez-de-la-Cuesta 3****o 2
Sally Dacie m****0@m****e 2
diegojco d****z@m****e 2
Clarissa Kroll c****l@t****e 1
Diego m****6@m****e 1
jiawei.bao j****o@s****u 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 6
  • Total pull requests: 110
  • Average time to close issues: 11 months
  • Average time to close pull requests: 6 days
  • Total issue authors: 6
  • Total pull request authors: 10
  • Average comments per issue: 2.17
  • Average comments per pull request: 0.38
  • Merged pull requests: 108
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: 7 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.2
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • olemke (1)
  • stella-bourdin (1)
  • suessspeise (1)
  • lkluft (1)
  • SallyDa (1)
  • diegojco (1)
Pull Request Authors
  • lkluft (88)
  • stella-bourdin (7)
  • pczarnecki (3)
  • moritz-g (3)
  • TheresaLang (3)
  • diegojco (3)
  • SallyDa (2)
  • ClKroll (1)
  • Jette87 (1)
  • jiaweibao (1)
Top Labels
Issue Labels
Pull Request Labels
in progress (1) enhancement (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 182 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 15
  • Total maintainers: 1
pypi.org: konrad

'Implementation of a radiative-convective equilibrium model.

  • Versions: 15
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 182 Last month
Rankings
Forks count: 8.9%
Dependent packages count: 10.1%
Stargazers count: 14.2%
Average: 15.5%
Dependent repos count: 21.5%
Downloads: 22.7%
Maintainers (1)
Last synced: 4 months ago

Dependencies

setup.py pypi
  • climt >=0.16.25
  • matplotlib >=2.0.0
  • netcdf4 >=1.2.7
  • numpy >=1.20.0,<1.22.0
  • scipy >=0.19.0
  • sympl >=0.4.0
  • typhon >=0.7.0
  • xarray >=0.9.1
.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
pyproject.toml pypi
environment.yaml pypi
  • climt *
  • sympl >=0.4.0