Data

Tools

Indexes

Applications

Experiments

Open Source Science

gcm_toolkit

Tools for GCM postprocessing

https://github.com/exorad/gcm_toolkit

Science Score: 64.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
    1 of 5 committers (20.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Tools for GCM postprocessing

Basic Info
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 1
  • Open Issues: 8
  • Releases: 0
Created about 4 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

gcm_toolkit

codecov PyPi version Documentation Status DOI

gcm_toolkit is an open-source python package to read, post-process, and plot 3D GCM data. The goal is to have an easy to use invironment for new GCM users, while allowing for direct access to the data for more experienced users.

gcm_toolkit originated from the need for a consistent and easy-to-share methodology for reading and analyzing the 3D circulation models of exoplanet atmospheres. Currently, the focus is on data produced by the MITgcm and its implementations for exoplanets ( see Carone et al., 2020 and Schneider et al., 2022). But we envision this package as a general tool for the analysis of data from different 3D GCMs.

gcm_toolkit is currently under development. Feel free to contribute!

Features (Current)

  • GCM read-in methods (currently only MITgcm)
  • 'Tag' system for easy referencing of multiple models in memory
  • Making use of xarray's intuitive system of multi-D arrays
  • Quick plotting routines
    • isobaric slices
    • zonal means
    • evolution over time
    • ... and more
  • Direct data access for custom plotting and post-processing

Main Authors

Get Started

Read the docs

Installation

pip install gcm-toolkit

(Note the dash)

Packages needed

Please install the following packages beforehand:

general: xarray, netcdf4

exPERT/MITgcm - raw files: xmitgcm, xgcm, f90nml, cubedsphere

Running the first example

Check the get started in the docs

Miscellaneous Documentation

  • All quantities are expressed in SI units.
  • Latitudes run from -90° to 90° ; Longitudes run from -180° to 180°.
  • The substellar point for tidally locked planets is located at (0°, 0°).
  • The radius of the planet is defined at the bottom boundary of the vertical grid.

Contact

Feel free to contact one of the main authors: Aaron Schneider , Sven Kiefer, or Robin Baeyens.

Project url: https://github.com/exorad/gcm_toolkit

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "Tools for GCM postprocessing."
authors:
- family-names: "Schneider"
  given-names: "Aaron David"
  orcid: "https://orcid.org/0000-0002-1448-0303"
- family-names: "Baeyens"
  given-names: "Robin"
  orcid: "https://orcid.org/0000-0001-7578-969X"
- family-names: "Kiefer"
  given-names: "Sven"
  orcid: "https://orcid.org/0000-0003-1285-3433"  
title: "gcm_toolkit"
version: 0.2.3
date-released: 2022-09-27
url: "https://github.com/exorad/gcm_toolkit"

GitHub Events

Total
Last Year

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 162
  • Total Committers: 5
  • Avg Commits per committer: 32.4
  • Development Distribution Score (DDS): 0.321
Top Committers
Name Email Commits
Aaron David Schneider a****r@n****k 110
Robin Baeyens r****s@k****e 37
kiefersv r****x@g****m 7
Robin Baeyens 3****s@u****m 6
Sven 5****v@u****m 2
Committer Domains (Top 20 + Academic)
kuleuven.be: 1 nbi.ku.dk: 1

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 18
  • Total pull requests: 44
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 3 days
  • Total issue authors: 3
  • Total pull request authors: 4
  • Average comments per issue: 1.61
  • Average comments per pull request: 2.18
  • Merged pull requests: 40
  • Bot issues: 0
  • Bot pull requests: 0
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
  • AaronDavidSchneider (15)
  • robinbaeyens (2)
  • Kiefersv (1)
Pull Request Authors
  • AaronDavidSchneider (33)
  • Kiefersv (8)
  • robinbaeyens (2)
  • TrellixVulnTeam (1)
Top Labels
Issue Labels
discussion (6) good first issue (4) bug (4) enhancement (3) help wanted (3) question (1)
Pull Request Labels