-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathREADME.Rmd
110 lines (79 loc) · 4.89 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/"
)
```
# eixport <img src="man/figures/logo.gif" align="right" alt="" width="140" />
[](https://travis-ci.org/atmoschem/eixport)[](https://ci.appveyor.com/project/Schuch666/eixport)
[](https://codecov.io/github/atmoschem/eixport?branch=master)
[](https://zenodo.org/badge/latestdoi/106145968)
[](http://cran.r-project.org/web/packages/eixport)
[](http://cran.r-project.org/package=eixport)
[](https://doi.org/10.21105/joss.00607)
[](https://cran.r-project.org/web/checks/check_results_eixport.html)
[](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},
}
```
<span class="__dimensions_badge_embed__" data-doi="10.21105/joss.00607"></span><script async src="https://badge.dimensions.ai/badge.js" charset="utf-8"></script>
## 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.