Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/ai2cm/fv3config

Manipulate FV3GFS run directories

https://github.com/ai2cm/fv3config

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.3%) to scientific vocabulary

Keywords from Contributors

climate-modeling
Last synced: 10 months ago · JSON representation

Repository

Manipulate FV3GFS run directories

Basic Info
  • Host: GitHub
  • Owner: ai2cm
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Size: 434 KB
Statistics
  • Stars: 1
  • Watchers: 10
  • Forks: 0
  • Open Issues: 20
  • Releases: 0
Created almost 7 years ago · Last pushed over 2 years ago
Metadata Files
Readme Changelog License

README.rst 

FV3Config
=========

.. image:: https://readthedocs.org/projects/fv3config/badge/?version=latest
   :target: https://fv3config.readthedocs.io/en/latest/?badge=latest
   
.. image:: https://circleci.com/gh/ai2cm/fv3config.svg?style=svg
   :target: https://circleci.com/gh/ai2cm/fv3config

FV3Config is used to configure and manipulate run directories for FV3GFS.

* Free software: Apache 2.0 license

Basic usage
-----------

.. code-block:: python

    import fv3config

    with open("config.yml", "r") as f:
        config = fv3config.load(f)
    fv3config.write_run_directory(config, './rundir')


:code:`config` is a configuration dictionary which contains namelists, input data specifications,
and other options. It can be edited just like any dictionary.

For more in-depth usage, please refer to the documentation. This can be generated with :code:`make docs`.


Authentication with Google Cloud Storage
----------------------------------------

Many of the examples in this repo refer to data stored in an Allen AI google
cloud storage bucket, which is open to the public...but not for free.

This package uses fsspec to access remote files. See their `configuration
documentation`_ for details. If you do not typically access AI2 google cloud
storage, you may need to enable requester pays, which you can do by setting the
following environment variables::

    export FSSPEC_GS_REQUESTER_PAYS=
    # the following will be set with `gcloud auth login`
    export GOOGLE_CLOUD_PROJECT=


You can check your authentication in a python console like this::

    >>> import google.auth
    >>> google.auth.default()
    (, '')

If you see both the credentials object and the project id, you are adequately
authenticated for requester pays. If you are accessing a bucket owned by your
project, then the project does not need to be set.

.. _configuration documentation: https://filesystem-spec.readthedocs.io/en/latest/features.html#configuration

Owner

  • Name: ai2cm
  • Login: ai2cm
  • Kind: organization
  • Location: Seattle WA, USA

AI2 Climate Modeling

GitHub Events

Total
Last Year

Committers

Last synced: over 3 years ago

All Time
  • Total Commits: 102
  • Total Committers: 11
  • Avg Commits per committer: 9.273
  • Development Distribution Score (DDS): 0.676
Top Committers
Name Email Commits
Jeremy McGibbon j****m@v****m 33
Noah D Brenowitz n****2@g****m 24
Oliver Watt-Meyer o****m@v****m 23
Spencer Clark s****k@g****m 7
Oliver Fuhrer o****r@u****m 6
W. Andre Perkins f****e@g****m 4
Johann Dahm j****d@v****m 1
rheacangeo 5****o@u****m 1
Mark Cheeseman M****C@v****m 1
brianhenn b****h@v****m 1
oelbert o****6@g****m 1
Committer Domains (Top 20 + Academic)
vulcan.com: 5

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 26
  • Total pull requests: 77
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 14 days
  • Total issue authors: 7
  • Total pull request authors: 13
  • Average comments per issue: 2.27
  • Average comments per pull request: 0.65
  • Merged pull requests: 68
  • 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
View more stats
Top Authors
Issue Authors
  • nbren12 (14)
  • spencerkclark (3)
  • mcgibbon (3)
  • oliverwm1 (3)
  • ofuhrer (1)
  • yuenxq (1)
  • rheacangeo (1)
Pull Request Authors
  • nbren12 (20)
  • mcgibbon (16)
  • oliverwm1 (16)
  • ofuhrer (9)
  • spencerkclark (6)
  • frodre (3)
  • dependabot[bot] (2)
  • brianhenn (1)
  • rheacangeo (1)
  • jdahm (1)
  • elynnwu (1)
  • SpiderMonkey1975 (1)
  • oelbert (1)
Top Labels
Issue Labels
enhancement (1) documentation (1)
Pull Request Labels
dependencies (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 155 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 7
  • Total versions: 8
  • Total maintainers: 2
pypi.org: fv3config

FV3Config is used to configure and manipulate run directories for FV3GFS.

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 7
  • Downloads: 155 Last month
Rankings
Dependent repos count: 5.6%
Downloads: 9.8%
Dependent packages count: 10.1%
Average: 17.4%
Forks count: 29.8%
Stargazers count: 31.9%
Maintainers (2)
Twine vcm
Last synced: 11 months ago

Dependencies

requirements.txt pypi
  • Sphinx *
  • black ==19.10b0
  • bump2version *
  • click ==8.0.4
  • coverage *
  • flake8 ==3.7.8
  • google-cloud-storage *
  • kubernetes *
  • pip *
  • pytest *
  • pytest-cov *
  • sphinx_rtd_theme *
  • tox *
  • wheel *
Dockerfile docker
  • python 3.7.8-slim-stretch build
setup.py pypi