Science Score: 57.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 4 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: BoundaryLayerVercauteren
  • Language: Python
  • Default Branch: main
  • Size: 14.7 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 2
Created over 3 years ago · Last pushed about 2 years ago
Metadata Files
Readme Citation

README.md

Energy Balance Model

The code in this repository is used to study the sensitivity of the nocturnal and polar atmospheric boundary layer to transient phenomena. The analysis is performed with a model for near-surface temperature inversion transitions which was originally defined by van de Wiel et. al. [1] but has been modified to include different types of perturbations.

The corresponding publication is: Kaiser, A., Vercauteren, N., and Krumscheid, S.: Sensitivity of the nocturnal and polar boundary layer to transient phenomena, EGUsphere [preprint], https://doi.org/10.5194/egusphere-2023-1519, 2023.

If comments in the code include references to figures or equations they refer to the ones in this publication.

How to set up and run the model

  1. Clone repository bash git clone git@github.com:am-kaiser/energy_balance_model.git cd energy_balance_model

  2. Create and activate environment using a virtual environment: bash module load Python/3.9.5-GCCcore-10.3.0 # depending on system set up pip install virtualenv # if you don't have virtualenv installed virtualenv ebm_venv source ebm_venv/bin/activate pip install -r docker/requirements.txt alternatively using docker: bash cd docker docker build . -t energy_balance_model cd .. docker run -ti -v "$PWD:/home/" energy_balance_model cd home

  3. Run the model bash python main.py # when using virtualenv python3 main.py # docker Output files can be found in output/ directory with current data and time.

Change model parameters

All model parameters can be set in the file. For a description of most of the model parameters see section 2.1.

Command-line options for running the model

```bash usage: main.py [-h] [-pl] [-V] [-odeu] [-f] [-u] [-uf] [-sf] [-sfu] [-ss] [-a]

Run the energy balance model.

optional arguments:
-h, --help show this help message and exit
-pl, --plot Make potential, bifurcation, ... plots.
-V, --version show program's version number and exit
-odeu, --odewithvaru
Run ODE model with time dependent u.
-f, --function Randomize the model function itself.
-u, --u Randomize the model parameter u. -uf, --u
andfunction Randomize the model parameter u and the model itself. -sf, --stabfunction Randomize the stability function. -sfu, --stabfunctionandtimedependentu Randomize the stability function and u is time dependent. -ss, --sensitivitystudy Perform a sensitivity study. -a, --all Run model with all randomizations. ```

Contributors

Disclaimer

This code has been set up to run on Ubuntu 20.04. Only the python versions 3.8 and 3.9 have been used to run the code.

There is no guarantee that the code runs on any other operating system or with a different python version.

References

[1] van de Wiel, B. J. H., Vignon, E., Baas, P., van Hooijdonk, I. G. S., van der Linden, S. J. A., Antoon van Hooft, J., Bosveld, F. C., de Roode, S. R., Moene, A. F., and Genthon, C.: Regime Transitions in Near-Surface Temperature Inversions: A Conceptual Model, Journal of Atmospheric Sciences, 74, 1057–1073, https://doi.org/10.1175/JAS-D-16-0180.1, 2017.

Owner

  • Name: BoundaryLayerVercauteren
  • Login: BoundaryLayerVercauteren
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Kaiser"
  given-names: "Amandine"
  orcid: "https://orcid.org/0000-0002-2756-9964"
- family-names: "Vercauteren"
  given-names: "Nikki"
  orcid: "https://orcid.org/0000-0003-2893-9186"
title: "BoundaryLayerVercauteren/energy_balance_model: Version 3.0"
version: 3.0
doi: 10.5281/zenodo.10469086
date-released: 2024-01-08

GitHub Events

Total
Last Year

Dependencies

.github/workflows/linter.yml actions
  • actions/checkout v3 composite
  • github/super-linter/slim v4 composite
.github/workflows/pytest.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
docker/Dockerfile docker
  • ubuntu 20.04 build
docker/requirements.txt pypi
  • PyDSTool ==0.91.0
  • SciencePlots ==1.0.9
  • cmcrameri ==1.4
  • dataclasses-json ==0.5.7
  • matplotlib ==3.6.1
  • numpy ==1.23.4
  • pandas ==1.5.0
  • scipy ==1.9.2
  • sdeint ==0.3.0
  • seaborn ==0.12.0