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
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: ERA-URBAN
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Size: 232 KB
Statistics
  • Stars: 13
  • Watchers: 3
  • Forks: 5
  • Open Issues: 5
  • Releases: 3
Created over 10 years ago · Last pushed almost 5 years ago
Metadata Files
Readme Changelog License Citation Zenodo

README.rst

.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
    :target: https://opensource.org/licenses/Apache-2.0
.. image:: https://travis-ci.org/ERA-URBAN/wrfpy.svg?branch=master
    :target: https://travis-ci.org/ERA-URBAN/wrfpy
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1420918.svg
   :target: https://doi.org/10.5281/zenodo.1420918
.. image:: https://badge.fury.io/py/WRFpy.svg
    :target: https://badge.fury.io/py/WRFpy

WRFpy
=====

What is WRFpy:
~~~~~~~~~~~~~~

WRFpy is a python application that provides an easy way to set up, run,
and monitor (long) Weather Research and Forecasting (WRF) simulations.
It provides a simple user-editable JSON configuration file and
integrates with Cylc to access distributed computing and storage
resources as well as monitoring. Optionally, WRFpy allows for data
assimilation using WRF data assimilation system (WRFDA) and
postprocessing of wrfinput files using the NCEP Unified Post Processing
System (UPP).

Installation
~~~~~~~~~~~~

WRFpy is installable via pip:

::

   pip install wrfpy


Usage
~~~~~

WRFpy provides functionality depending on the used command-line
switches:

::

   usage: wrfpy [-h] [--init] [--create] [--basedir BASEDIR] suitename

   WRFpy

   positional arguments:
     suitename          name of suite

   optional arguments:
     -h, --help         show this help message and exit
     --init             Initialize suite (default: False)
     --create           Create suite config (default: False)
     --basedir BASEDIR  basedir in which suites are installed (default:
                        ${HOME}/cylc-suites)


In order to set up a new cylc suite, we first need to initialize one.
This is done using the following command:

::

   wrfpy --init testsuite

This creates a configuration file (config.json) that needs to be filled
in by the user before continuing. WRFpy points the user to the location
of this file.

After the configuration file has been filled, it is time to create the
actual configuration that will be used by the CYLC workflow engine. To
create the CYLC suite, use the following command:

::

   wrfpy --create testsuite

The final configuration lives in a file called suite.rc. If you want to
make further (specialized) changes to the workflow by adding/tweaking
steps, you can directly edit the suite.rc file with your favorite
editor.

Now it is time to register the suite with CYLC. CYLC is available at

::

   https://cylc.github.io/cylc/

and has great documentation. From now on you are using CYLC to control
your WRF runs. Please consult the CYLC documentation for the relevant
commands.

Owner

  • Name: ERA-URBAN
  • Login: ERA-URBAN
  • Kind: organization

Citation (CITATION.cff)

# YAML 1.2
--- 
authors: 
  - 
    affiliation: "Netherlands eScience Center"
    family-names: Haren
    given-names: Ronald
    name-particle: van
cff-version: "1.0.3"
commit: 
date-released: 2018-09-18
doi: 10.5281/zenodo.1420918
keywords: 
  - "WRF"
  - "WRFDA"
  - "urban nudging"
  - "workflow"
  - "cylc"
license: Apache-2.0
message: "If you use this software, please cite it using these metadata."
repository-code: "https://github.com/ERA-URBAN/wrfpy"
title: WRFpy
version: "0.2.1"

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 204
  • Total Committers: 4
  • Avg Commits per committer: 51.0
  • Development Distribution Score (DDS): 0.127
Top Committers
Name Email Commits
Ronald van Haren r****n@e****l 178
Ronald van Haren R****n@e****l 16
Bruno P. Kinoshita b****a@n****z 7
Sytse Koopmans s****s@w****l 3
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 7
  • Total pull requests: 17
  • Average time to close issues: 11 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 3
  • Total pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.59
  • Merged pull requests: 12
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • rvanharen (3)
  • kinow (3)
  • sytsek47 (1)
Pull Request Authors
  • kinow (8)
  • rvanharen (4)
  • sytsek47 (4)
  • dependabot[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 13 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 2
  • Total maintainers: 1
pypi.org: wrfpy

A python application that provides an easy way to set up, run, and monitor (long) Weather Research and Forecasting (WRF) simulations.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 13 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 14.2%
Stargazers count: 17.1%
Average: 20.4%
Dependent repos count: 21.6%
Downloads: 39.1%
Maintainers (1)
Last synced: 6 months ago

Dependencies

requirements-docs.txt pypi
  • sphinx *
  • sphinx-autobuild *
requirements-rtd.txt pypi
  • numpy *
  • sphinx *
  • sphinx-autobuild *
requirements-test.txt pypi
  • coverage * test
  • pytest * test
  • pytest-cov <2.6.0 test
requirements.txt pypi
  • Jinja2 ==2.8
  • MarkupSafe ==0.23
  • PyYAML >=4.2b1
  • astropy ==2.0.9
  • f90nml *
  • netCDF4 *
  • pathos ==0.2.2.1
  • pyOpenSSL *
  • python-dateutil ==2.7.3
setup.py pypi
  • Jinja2 *
  • MarkupSafe *
  • PyYAML *
  • astropy *
  • f90nml *
  • netCDF4 *
  • numpy *
  • pathos *
  • pyOpenSSL *
  • python-dateutil *