esm_tools

Simple Infrastructure for Earth System Simulations

https://github.com/esm-tools/esm_tools

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 1 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 82 committers (1.2%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.9%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Simple Infrastructure for Earth System Simulations

Basic Info
  • Host: GitHub
  • Owner: esm-tools
  • License: gpl-2.0
  • Language: Shell
  • Default Branch: release
  • Homepage: https://esm-tools.github.io/
  • Size: 17.3 MB
Statistics
  • Stars: 28
  • Watchers: 7
  • Forks: 15
  • Open Issues: 133
  • Releases: 3
Created almost 6 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.rst

=========
ESM Tools
=========

Documentation
-------------

.. image:: https://readthedocs.org/projects/esm-tools/badge/?version=latest

For our complete documentation, please check https://esm-tools.readthedocs.io/en/latest/index.html.

How to cite this software
-------------------------
To cite ESM-Tools, please use the following DOI: https://zenodo.org/doi/10.5281/zenodo.3737927. This DOI represents all versions of the software, and will always pointing to the latest version available on https://zenodo.org.


Before you continue
-------------------

You will need python 3 (possibly version 3.6 or newer), a version of git that is not ancient (everything newer than 2.10 should be good), and up-to-date pip (``pip install -U pip``) to install the `esm_tools`. That means that on the supported machines, you could for example use the following settings:

albedo::

    $ module load git
    $ module load python

levante.dkrz.de::

    $ module load git
    $ module load python3

glogin.hlrn.de / blogin.hlrn.de::

    $ module load git
    $ module load anaconda3

juwels.fz-juelich.de::

    $ module load Stages/2022
    $ module load git
    $ module load Python/3.9.6

aleph::

    $ module load git
    $ module load python

Note that some machines might raise an error ``conflict netcdf_c`` when loading ``anaconda3``. In that case you will need to swap ``netcdf_c`` with ``anaconda3``::

    $ module unload netcdf_c
    $ module load anaconda3



Installing
----------

1. First, make sure you add the following lines to one of your login or profile files, i.e. ``~/.bash_profile``, ``~/.bashrc``, ``~/.profile``, etc.::

        $ export PATH=$PATH:~/.local/bin
        $ export LC_ALL=en_US.UTF-8
        $ export LANG=en_US.UTF-8

2. Inside the same login or profile file, add also the ``module`` commands necessary for the HPC system you are using (find the lines in the section above).

3. You can choose to source now your login or profile file, so that the ``module`` and ``export`` commands are run (e.g. ``$ source ~/.bash_profile``).

4. To use the new version of the ESM-Tools, now rewritten in Python, clone this repository::

        $ git clone https://github.com/esm-tools/esm_tools.git

5. Then, run the ``install.sh``::

        $ ./install.sh

You should now have the command line tools ``esm_master`` and ``esm_runscripts``, which replace the old version.

Owner

  • Name: ESM-Tools
  • Login: esm-tools
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use ESM-Tools software, please cite using the metadata below."
authors:
- family-names: "Gierz"
  given-names: "Paul"
  orcid: "https://orcid.org/0000-0002-4512-087X"
  affiliation: "Alfred-Wegener-Institut Helmholtz-Zentrum für Polar- und Meeresforschung"
- family-names: "Andrés-Martínez"
  given-names: "Miguel"
  orcid: "https://orcid.org/0000-0002-1525-5546"
  affiliation: "Alfred-Wegener-Institut Helmholtz-Zentrum für Polar- und Meeresforschung"
- family-names: "Barbi"
  given-names: "Dirk"
  orcid: "https://orcid.org/0000-0002-5053-1788"
  affiliation: "Alfred-Wegener-Institut Helmholtz-Zentrum für Polar- und Meeresforschung"
- family-names: "Wieters"
  given-names: "Nadine"
  orcid: "https://orcid.org/0000-0002-5092-7766"
  affiliation: "Alfred-Wegener-Institut Helmholtz-Zentrum für Polar- und Meeresforschung"
- family-names: "Cristini"
  given-names: "Luisa"
  orcid: "https://orcid.org/0000-0003-4791-0776"
  affiliation: "Alfred-Wegener-Institut Helmholtz-Zentrum für Polar- und Meeresforschung"
- family-names: "Streffing"
  given-names: "Jan"
  orcid: "https://orcid.org/0000-0001-9515-3322"
  affiliation: "Alfred-Wegener-Institut Helmholtz-Zentrum für Polar- und Meeresforschung"
- family-names: "Wahl"
  given-names: "Sebastian"
  orcid: "https://orcid.org/0000-0002-1360-5776"
  affiliation: "GEOMAR Helmholtz-Zentrum für Ozeanforschung"
- family-names: "Ural"
  given-names: "Deniz"
- family-names: "Kjellsson"
  given-names: "Joakim"
  orcid: "https://orcid.org/0000-0002-6405-5276"
  affiliation: "Rossby Center, Swedish Meteorological and Hydrological Institute"
- family-names: "Chegini"
  given-names: "Fatemeh"
- family-names: "Khosravi"
  given-names: "Sara"

title: "ESM-Tools"
doi: 10.5281/zenodo.5787476
date-released: 2021-12-16
url: "https://github.com/esm-tools/esm_tools"

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 2,886
  • Total Committers: 82
  • Avg Commits per committer: 35.195
  • Development Distribution Score (DDS): 0.634
Top Committers
Name Email Commits
Miguel Andres-Martinez m****z@a****e 1,055
Paul Gierz p****z@a****e 413
Dirk Barbi d****i@a****e 198
Sebastian Wahl s****l@g****e 181
Miguel 6****m@u****m 154
Jan Streffing j****g@a****e 142
denizural d****6@g****m 110
BumpVersion Action b****n@g****s 99
JanStreffing J****g@a****e 48
Nadine Wieters n****s@a****e 47
Joakim Kjellsson j****n@g****e 36
chrisdane c****k@a****e 33
Paul Gierz p****z@a****e 27
ICCP Guest J****g 27
Paul Gierz p****z@a****m 25
Nikolay Koldunov k****n@g****m 21
Lars Ackermann l****n@a****e 21
Kai Himstedt h****t@d****e 19
deniz ural d****l@a****e 19
shkjocke s****e@b****e 17
shkjocke s****e@b****e 15
shkjocke s****e@b****e 11
shkjocke s****e@b****e 10
Joakim Kjellsson j****m@n****h 10
shkjocke s****e@b****e 9
shkjocke s****e@b****e 9
shkjocke s****e@b****e 8
Xavier Yepes x****s@a****e 7
Xiaoxu Shi x****i@a****e 6
Kai Himstedt k****t@u****e 6
and 52 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 199
  • Total pull requests: 467
  • Average time to close issues: 7 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 34
  • Total pull request authors: 16
  • Average comments per issue: 4.97
  • Average comments per pull request: 2.5
  • Merged pull requests: 322
  • Bot issues: 0
  • Bot pull requests: 18
Past Year
  • Issues: 55
  • Pull requests: 182
  • Average time to close issues: 23 days
  • Average time to close pull requests: 15 days
  • Issue authors: 16
  • Pull request authors: 11
  • Average comments per issue: 3.55
  • Average comments per pull request: 2.01
  • Merged pull requests: 119
  • Bot issues: 0
  • Bot pull requests: 5
Top Authors
Issue Authors
  • JanStreffing (40)
  • chrisdane (20)
  • pgierz (18)
  • mandresm (15)
  • tsemmler05 (14)
  • joakimkjellsson (11)
  • nwieters (11)
  • hajlaci (11)
  • jannitzbon (5)
  • seb-wahl (5)
  • l975421700 (4)
  • a270105 (3)
  • ackerlar (3)
  • antoniofis10000 (3)
  • fernandadialzira (3)
Pull Request Authors
  • mandresm (174)
  • pgierz (84)
  • JanStreffing (72)
  • ackerlar (50)
  • nwieters (47)
  • seb-wahl (21)
  • dependabot[bot] (19)
  • joakimkjellsson (8)
  • SimonPorr (6)
  • chrisdane (6)
  • christgau (2)
  • denizural (1)
  • tsemmler05 (1)
  • mbutzin (1)
  • jannitzbon (1)
Top Labels
Issue Labels
enhancement (28) bug (27) Stale (22) error handling (18) documentation (15) outdated? (15) Closed by github-actions (14) feature request (13) echam (8) esm_runscripts (7) cleanup (6) awiesm (6) levante (6) awicm (6) fesom (6) oasis (5) esm_master (5) albedo (5) slurm (4) question (4) UX (4) workflow manager (3) continuous integration (3) help (2) help wanted (2) Sprint (2) new machine (2) Hackathon (2) pism (2) awicm-recom (2)
Pull Request Labels
enhancement (30) dependencies (20) awicm (16) Stale (14) bug (14) cleanup (6) oasis (6) Sprint (5) documentation (5) error handling (4) continuous integration (3) echam (2) refactoring (2) awiesm (2) oifs (2) esm_runscripts (2) Hackathon (2) python (2) juwels (2) medusa (1) offline coupling (1) pool_issue (1) fesom (1) workflow manager (1) question (1) jsbach (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 220 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 39
  • Total maintainers: 2
pypi.org: esm-tools

ESM Tools external infrastructure for Earth System Modelling

  • Versions: 39
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 220 Last month
Rankings
Dependent packages count: 7.4%
Forks count: 11.5%
Stargazers count: 13.1%
Average: 14.7%
Downloads: 19.5%
Dependent repos count: 22.2%
Maintainers (2)
Last synced: 7 months ago

Dependencies

.github/workflows/esm_tests_computer_workflow.yml actions
  • actions/checkout v3 composite
.github/workflows/esm_tools_actions.yml actions
  • actions/checkout v2 composite
.github/workflows/esm_tools_actions_hpc_awi_ollie.yml actions
  • Legorooj/skip-ci main composite
  • actions/checkout v2 composite
.github/workflows/esm_tools_actions_hpc_awi_ollie_manual_run.yml actions
  • actions/checkout v2 composite
.github/workflows/esm_tools_actions_novm.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
.github/workflows/esm_tools_publish.yml actions
  • actions/checkout v2 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/pre-merge_actions.yml actions
  • actions/checkout v2 composite
  • jasonamyers/github-bumpversion-action v1.0.4 composite
utils/requirements_dev.txt pypi
  • Sphinx ==1.8.5 development
  • bump2version ==0.5.11 development
  • coverage ==4.5.4 development
  • flake8 ==3.7.8 development
  • pip ==21.1 development
  • tox ==3.14.0 development
  • twine ==1.14.0 development
  • watchdog ==0.9.0 development
  • wheel ==0.38.1 development
.github/workflows/approve_esm_tests_changes.yml actions
.github/workflows/esm_tests.yml actions
.github/workflows/esm_tools_awicm.yml actions
.github/workflows/esm_tools_awiesm.yml actions
.github/workflows/esm_tools_echam-standalone.yml actions
.github/workflows/esm_tools_fesom-standalone.yml actions
.github/workflows/esm_tools_pism-standalone.yml actions
.github/workflows/stale.yml actions
  • actions/stale v5 composite
setup.py pypi
utils/environment.yaml pypi