pyremo

python tools for remo postprocessing and maintenance

https://github.com/remo-rcm/pyremo

Science Score: 54.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
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.2%) to scientific vocabulary

Keywords from Contributors

cordex geoscience
Last synced: 7 months ago · JSON representation ·

Repository

python tools for remo postprocessing and maintenance

Basic Info
  • Host: GitHub
  • Owner: remo-rcm
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage: https://pyremo.readthedocs.io
  • Size: 72.6 MB
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 2
  • Open Issues: 17
  • Releases: 17
Created over 5 years ago · Last pushed 8 months ago
Metadata Files
Readme Contributing License Citation Zenodo

README.rst

======
pyremo
======

Python tools for the regional climate model `REMO `_.

.. image:: https://zenodo.org/badge/282037812.svg
   :target: https://zenodo.org/badge/latestdoi/282037812

.. image:: https://github.com/remo-rcm/pyremo/actions/workflows/ci.yaml/badge.svg
    :target: https://github.com/remo-rcm/pyremo/actions/workflows/ci.yaml

.. image:: https://github.com/remo-rcm/pyremo/actions/workflows/ci-extensions.yaml/badge.svg
    :target: https://github.com/remo-rcm/pyremo/actions/workflows/ci-extensions.yaml

.. image:: https://codecov.io/gh/remo-rcm/pyremo/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/remo-rcm/pyremo

.. image:: https://img.shields.io/pypi/v/pyremo.svg
        :target: https://pypi.python.org/pypi/pyremo

.. image:: https://readthedocs.org/projects/pyremo/badge/?version=latest
        :target: https://pyremo.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://anaconda.org/conda-forge/pyremo/badges/version.svg
    :target: https://anaconda.org/conda-forge/pyremo

.. image:: https://results.pre-commit.ci/badge/github/remo-rcm/pyremo/master.svg
   :target: https://results.pre-commit.ci/latest/github/remo-rcm/pyremo/master
   :alt: pre-commit.ci status

.. image:: https://www.codefactor.io/repository/github/remo-rcm/pyremo/badge
   :target: https://www.codefactor.io/repository/github/remo-rcm/pyremo
   :alt: CodeFactor



Features
--------

* Easy access to Remo meta information and data
* API based on xarray data structures
* Pressure interpolation
* Pre and post processing
* Includes basic physics package for REMO

Installation
------------

We recommend installing ``pyremo`` with conda:

.. code-block:: console

    conda install -c conda-forge pyremo


Installation from source
------------------------

We don't recommend to pip install ``pyremo`` because some of the dependencies require pre-compiled packages
that won't work with pip. For instructions to install py-cordex from source, please have a look
at the `contributing guide `_.
If you want to contribute, please get in contact as early as possible, e.g.,  using `draft pull requests `_.

Fortran extensions
------------------

There are two sub-packages that are extra private dependencies and contain Fortran extensions. For example, the preprocessing module :code:`preproc` will require the installation
of the legacy source code for preprocessing which is packaged in

* https://gitlab.dkrz.de/remo/pyintorg

For the pressure interpolation :code:`prsint`, you will need to install the additional package:

* https://gitlab.dkrz.de/remo/pydruint

Note, that you will have to install these packages from source which will require a fortran compiler (e.g. :code:`gfortran`).
If you require access to those packages, please request access to the REMO group in the DRKZ gitlab.
If you have access, you can install those extension directly from the gitlab, e.g.

.. code-block:: console

    pip install git+http://gitlab.dkrz.de/remo/pyintorg.git
    pip install git+http://gitlab.dkrz.de/remo/pydruint.git

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

Owner

  • Name: remo-rcm
  • Login: remo-rcm
  • Kind: organization

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: pyremo
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Lars
    family-names: Buntemeyer
    email: lars.buntemeyer@hereon.de
    orcid: 'https://orcid.org/0000-0002-0849-2404'
    affiliation: Helmholtz-Zentrum hereon
  - given-names: Ludwig
    family-names: Lierhammer
    email: ludwig.lierhammer@hereon.de
    affiliation: Helmholtz-Zentrum hereon
    orcid: 'https://orcid.org/0000-0002-7207-0003'
identifiers:
  - type: doi
    value: 10.5281/zenodo.7550490
repository-code: 'https://github.com/remo-rcm/pyremo'
license: MIT
commit: e442df5615406d0eeac2f86f11fb7d714e8733c8
version: 0.4.1
date-released: '2023-01-19'

GitHub Events

Total
  • Create event: 45
  • Release event: 3
  • Issues event: 4
  • Delete event: 33
  • Push event: 86
  • Pull request event: 82
Last Year
  • Create event: 45
  • Release event: 3
  • Issues event: 4
  • Delete event: 33
  • Push event: 86
  • Pull request event: 82

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 485
  • Total Committers: 8
  • Avg Commits per committer: 60.625
  • Development Distribution Score (DDS): 0.192
Past Year
  • Commits: 105
  • Committers: 7
  • Avg Commits per committer: 15.0
  • Development Distribution Score (DDS): 0.59
Top Committers
Name Email Commits
Lars Buntemeyer l****r@h****e 392
Lars Buntemeyer 5****r@u****m 35
Lars Buntemeyer l****r@g****m 32
pre-commit-ci[bot] 6****]@u****m 11
Ludwig Lierhammer l****r@h****e 9
Lars Buntemeyer l****r@g****m 4
Lars Buntemeyer l****r@h****e 1
pyup-bot g****t@p****o 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 34
  • Total pull requests: 214
  • Average time to close issues: 11 months
  • Average time to close pull requests: 9 days
  • Total issue authors: 1
  • Total pull request authors: 5
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.38
  • Merged pull requests: 195
  • Bot issues: 0
  • Bot pull requests: 105
Past Year
  • Issues: 2
  • Pull requests: 80
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 days
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 68
  • Bot issues: 0
  • Bot pull requests: 59
Top Authors
Issue Authors
  • larsbuntemeyer (35)
Pull Request Authors
  • pre-commit-ci[bot] (123)
  • larsbuntemeyer (112)
  • dependabot[bot] (22)
  • ludwiglierhammer (11)
  • pyup-bot (1)
Top Labels
Issue Labels
bug (5) documentation (4) enhancement (4) good first issue (2) question (1)
Pull Request Labels
dependencies (22)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 69 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 24
  • Total maintainers: 1
pypi.org: pyremo

Data analytics, processing and plotting for regional climate model REMO.

  • Documentation: https://pyremo.readthedocs.io/
  • License: MIT License Copyright (c) 2020, Climate Service Center Germany (GERICS) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.8.2
    published 10 months ago
  • Versions: 18
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 69 Last month
Rankings
Dependent packages count: 10.0%
Average: 21.1%
Dependent repos count: 21.7%
Forks count: 22.6%
Downloads: 23.1%
Stargazers count: 27.8%
Maintainers (1)
Last synced: 7 months ago
conda-forge.org: pyremo
  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Average: 50.2%
Dependent packages count: 51.2%
Forks count: 57.4%
Stargazers count: 58.4%
Last synced: 7 months ago

Dependencies

.github/workflows/ci-extensions.yaml actions
  • actions/checkout v3 composite
  • codecov/codecov-action v3 composite
  • mamba-org/provision-with-micromamba main composite
.github/workflows/ci.yaml actions
  • actions/checkout v3 composite
  • codecov/codecov-action v3 composite
  • mamba-org/provision-with-micromamba main composite
.github/workflows/linting.yaml actions
  • actions/checkout v3 composite
  • mamba-org/provision-with-micromamba main composite
.github/workflows/publish-pypi.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
  • pypa/gh-action-pypi-publish release/v1 composite
pyproject.toml pypi
setup.py pypi
ci/requirements/environment.yml pypi