eixport

eixport: An R package to export emissions to atmospheric models - Published in JOSS (2018)

https://github.com/atmoschem/eixport

Science Score: 93.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
    Found 9 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

atmospheric-models atmospheric-science emissions exporting-emissions wrf

Keywords from Contributors

atmos atmospheric-chemistry atmospheric-modelling wrf-chem

Scientific Fields

Engineering Computer Science - 40% confidence
Last synced: 6 months ago · JSON representation

Repository

Export Emissions to Atmospheric Models

Basic Info
Statistics
  • Stars: 29
  • Watchers: 2
  • Forks: 8
  • Open Issues: 2
  • Releases: 6
Topics
atmospheric-models atmospheric-science emissions exporting-emissions wrf
Created over 8 years ago · Last pushed 10 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct

README.Rmd

---
output: github_document
---



```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/"
)
```

# eixport 

[![Travis-CI Build Status](https://travis-ci.org/atmoschem/eixport.svg?branch=master)](https://travis-ci.org/atmoschem/eixport)[![Build status](https://ci.appveyor.com/api/projects/status/frk36kmayf8yff70?svg=true)](https://ci.appveyor.com/project/Schuch666/eixport)
[![Coverage Status](https://img.shields.io/codecov/c/github/atmoschem/eixport/master.svg)](https://codecov.io/github/atmoschem/eixport?branch=master)
[![DOI](https://zenodo.org/badge/106145968.svg)](https://zenodo.org/badge/latestdoi/106145968)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/eixport)](http://cran.r-project.org/web/packages/eixport) 
[![CRAN Downloads](http://cranlogs.r-pkg.org/badges/grand-total/eixport?color=orange)](http://cran.r-project.org/package=eixport)
[![DOI](http://joss.theoj.org/papers/10.21105/joss.00607/status.svg)](https://doi.org/10.21105/joss.00607)
[![cran checks](https://cranchecks.info/badges/worst/eixport)](https://cran.r-project.org/web/checks/check_results_eixport.html)
[![Github Stars](https://img.shields.io/github/stars/atmoschem/eixport.svg?style=social&label=Github)](https://github.com/atmoschem/eixport)


## Exporting emissions to atmospheric models, eixport: `r packageVersion("eixport")`

Emissions are mass that affects atmosphere in complex ways, not only physical, but also, in the health of humans, ecosystems, economically, etc.

There are several models whose inputs are emissions, such as [R-Line](https://www.cmascenter.org/r-line/) or [WRF-Chem](https://ruc.noaa.gov/wrf/wrf-chem/). 
This R-Package provide functions to read emissions from [VEIN](https://github.com/ibarraespinosa/vein) and from other models 
in different formats and export the emissions into the appropriate format suitable to other models.


## Install

To install the [CRAN](https://CRAN.R-project.org/package=eixport) version:



```{r eval = FALSE}
install.packages("eixport")
```

To install the development version:

```{r eval = FALSE}
devtools::install_github("atmoschem/eixport")
```

## Some functions:

- [get_edgar](https://atmoschem.github.io/eixport/reference/get_edgar.html): Download EDGAR emissions data.
- [to_rline](https://atmoschem.github.io/eixport/reference/to_rline.html): Export emissions to other formats
- [to_wrf](https://atmoschem.github.io/eixport/reference/to_wrf.html):	Combine total/spatial/temporal/split and write emission to file
- [to_brams_spm](https://atmoschem.github.io/eixport/reference/to_brams_spm.html):	inputs for SPM BRAMS
- [wrf_profile](https://atmoschem.github.io/eixport/reference/wrf_profile.html): Create spatial profile for WRF-Chem
- [wrf_create](https://atmoschem.github.io/eixport/reference/wrf_create.html):	Create emission files to the WRF-Chem
- [wrf_plot](https://atmoschem.github.io/eixport/reference/wrf_plot.html): simple but useful plot
- [wrf_get](https://atmoschem.github.io/eixport/reference/wrf_get.html):	Read variables
- [wrf_put](https://atmoschem.github.io/eixport/reference/wrf_put.html):	Write variables
- [to_as4wrf](https://atmoschem.github.io/eixport/reference/to_as4wrf.html): Create WRF-Chem inputs using NCL scrip AS4WRF.ncl.
- [to_munich](https://atmoschem.github.io/eixport/reference/to_munich.html): To generate inputs for
MUNICH model.


### Summary
```{r}
library(eixport)
file = paste0(system.file("extdata", package = "eixport"),"/wrfinput_d02")
wrf_summary(file = file)

```

### Attributes as data.frame

```{r}
file = paste0(system.file("extdata", package = "eixport"),"/wrfinput_d02")
f <- wrf_meta(file)
names(f)
head(f$global)
head(f$vars)

```


## Paper on Journal of Open Source Software (JOSS)

https://doi.org/10.21105/joss.00607

```
@article{eixport,
    title = {eixport: An R package to export emissions to atmospheric models},
    journal = {The Journal of Open Source Software},
    author = {Sergio Ibarra-Espinosa and Daniel Schuch and Edmilson {Dias de Freitas}},
    year = {2018},
    doi = {10.21105/joss.00607},
    url = {http://joss.theoj.org/papers/10.21105/joss.00607},
  }
```



## Contributing

Please, read [this](https://github.com/atmoschem/eixport/blob/master/CONTRIBUTING.md) guide.
Contributions of all sorts are welcome, issues and pull requests are the preferred ways of sharing them.
When contributing pull requests, please follow the [Google's R Style Guide](https://google.github.io/styleguide/Rguide.xml).
This project is released with a [Contributor Code of Conduct](https://github.com/atmoschem/eixport/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

Owner

  • Name: ATMOSCHEM
  • Login: atmoschem
  • Kind: organization

JOSS Publication

eixport: An R package to export emissions to atmospheric models
Published
April 25, 2018
Volume 3, Issue 24, Page 607
Authors
Sergio Ibarra-Espinosa ORCID
Departamento de Ciências Atmosféricas, Universidade de São Paulo, Brasil
Daniel Schuch ORCID
Departamento de Ciências Atmosféricas, Universidade de São Paulo, Brasil
Edmilson Dias de Freitas ORCID
Departamento de Ciências Atmosféricas, Universidade de São Paulo, Brasil
Editor
Thomas J. Leeper ORCID
Tags
eixport emissions air quality model

GitHub Events

Total
  • Issues event: 4
  • Watch event: 2
  • Issue comment event: 2
  • Push event: 11
Last Year
  • Issues event: 4
  • Watch event: 2
  • Issue comment event: 2
  • Push event: 11

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 439
  • Total Committers: 7
  • Avg Commits per committer: 62.714
  • Development Distribution Score (DDS): 0.494
Past Year
  • Commits: 22
  • Committers: 2
  • Avg Commits per committer: 11.0
  • Development Distribution Score (DDS): 0.136
Top Committers
Name Email Commits
ibarraespinosa z****a@g****m 222
Schuch666 u****h@g****m 190
schuch666 u****h@e****m 23
Umur Dinç u****c@g****m 1
Thomas J. Leeper t****r@g****m 1
Jeffrey W. Hollister j****r@g****m 1
Amanda Rehbein a****n@u****r 1
Committer Domains (Top 20 + Academic)
usp.br: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 74
  • Total pull requests: 6
  • Average time to close issues: 12 months
  • Average time to close pull requests: 14 days
  • Total issue authors: 8
  • Total pull request authors: 5
  • Average comments per issue: 1.51
  • Average comments per pull request: 2.33
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ibarraespinosa (60)
  • Schuch666 (8)
  • mdsumner (1)
  • bakamotokatas (1)
  • fipoucat (1)
  • C130PA5 (1)
  • jhollist (1)
  • rsbivand (1)
Pull Request Authors
  • bakamotokatas (2)
  • mdsumner (1)
  • jhollist (1)
  • ibarraespinosa (1)
  • leeper (1)
Top Labels
Issue Labels
enhancement (24) bug (9) help wanted (3) JOSS (1) good first issue (1)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • cran 349 last-month
  • Total dependent packages: 2
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 17
  • Total maintainers: 1
proxy.golang.org: github.com/atmoschem/eixport
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced: 6 months ago
cran.r-project.org: eixport

Export Emissions to Atmospheric Models

  • Versions: 12
  • Dependent Packages: 2
  • Dependent Repositories: 1
  • Downloads: 349 Last month
Rankings
Forks count: 6.9%
Stargazers count: 10.0%
Dependent packages count: 13.2%
Average: 15.0%
Downloads: 20.6%
Dependent repos count: 24.3%
Maintainers (1)
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.5.0 depends
  • cptcity * imports
  • data.table * imports
  • methods * imports
  • ncdf4 * imports
  • parallel * imports
  • raster * imports
  • rgdal * imports
  • sf * imports
  • sp * imports
  • utils * imports
  • covr * suggests
  • knitr * suggests
  • lwgeom * suggests
  • rmarkdown * suggests
  • testthat * suggests
  • units * suggests
.github/workflows/R-CMD-check.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/draft-pdf.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite