VEIN model

Vein Package

Vehicular Emissions INventory (VEIN) model.

Please read the documentation.

System requirements

vein imports functions from spatial packages listed below. In order to install these packages, firstly the user must install the requirements mentioned here.

Packages needed

After installing system dependencies, you need these packages:

• sf
• sp
• units

In order to run the demo, this package is also needed:

• ggplot2

Installation

VEIN can be installed via CRAN or github

# 0.3.9 Reaching the puberty   
library(devtools) 
install_github("atmoschem/vein")
library(vein)
demo(VEIN)

or

# 0.2.3
install.packages("vein")
library(vein)

What is new on 0.3.0 ?

I decided to jump into a new ‘minor’ version because it brings lots of cool improvements.

• vein imports sf functions.
• R packages -raster-, -rgdal- and -rgeos- not needed anymore.
• vein now imports data-table.
• Add class GriddedEmissionsArray.
• Fix #28, data.table imported in emis_grid. Now it is very fast!
• Fix #49: Documentation in inventory est.
• Fix #50: Fix repetition of x_DF.
• Fix #51: deparse text.
• Fix #52: separate objects in rm with ‘,’
• Fix #55.
• Minor fix on demo(VEIN).
• emis and emis_cold adjust length of ef by length of columns of first element of the list of data-frames.
• Revised all examples.

Check the NEWS

How to use vein

VEIN consist of: “Elaboration of vehicular emissions inventories, consisting in four stages, pre-processing activity data, preparing emissions factors, estimating the emissions and post-processing of emissions in maps and databases.”

This implies the use of several functions in a coordinates ans structured way, therefore it is added the new function inventory which creates a structured set of directories and scripts to run VEIN. Please, open the file ‘main.R’ and run each line to understand VEIN. Remember, if you have doubts with any function, just type ‘?’ with the name of the function. For intance: ?inventory.

library(vein)
inventory(name = file.path(tempdir(), "YourCity"), show.dir = T,
          show.scripts = T)

## files at /tmp/RtmpEY0ddt/YourCity

## Directories:
##  [1] "/tmp/RtmpEY0ddt/YourCity"           
##  [2] "/tmp/RtmpEY0ddt/YourCity/daily"     
##  [3] "/tmp/RtmpEY0ddt/YourCity/ef"        
##  [4] "/tmp/RtmpEY0ddt/YourCity/emi"       
##  [5] "/tmp/RtmpEY0ddt/YourCity/emi/BUS_01"
##  [6] "/tmp/RtmpEY0ddt/YourCity/emi/HGV_01"
##  [7] "/tmp/RtmpEY0ddt/YourCity/emi/LCV_01"
##  [8] "/tmp/RtmpEY0ddt/YourCity/emi/MC_01" 
##  [9] "/tmp/RtmpEY0ddt/YourCity/emi/PC_01" 
## [10] "/tmp/RtmpEY0ddt/YourCity/est"       
## [11] "/tmp/RtmpEY0ddt/YourCity/est/BUS_01"
## [12] "/tmp/RtmpEY0ddt/YourCity/est/HGV_01"
## [13] "/tmp/RtmpEY0ddt/YourCity/est/LCV_01"
## [14] "/tmp/RtmpEY0ddt/YourCity/est/MC_01" 
## [15] "/tmp/RtmpEY0ddt/YourCity/est/PC_01" 
## [16] "/tmp/RtmpEY0ddt/YourCity/images"    
## [17] "/tmp/RtmpEY0ddt/YourCity/network"   
## [18] "/tmp/RtmpEY0ddt/YourCity/veh"       
## Scripts:
## [1] "est/BUS_01/input.R" "est/HGV_01/input.R" "est/LCV_01/input.R"
## [4] "est/MC_01/input.R"  "est/PC_01/input.R"  "main.R"            
## [7] "traffic.R"

Please, read the examples in the documentation of each function and run the demo.

Issues

If you encounter any issues while using VEIN, please submit your issues to: https://github.com/atmoschem/vein/issues/

If you have any suggestions just let me know to sergio.ibarra@usp.br.

Thanks and enjoy VEIN!

future steps

• Add more support to sf.
• Estimation of evaporative emissions with Copert Tier 3.
• More speciations.
• A book (hopefully released in 2018).

Note:

The paper of vein on GMDD under open review. If you use VEIN, please, cite it:

Ibarra-Espinosa, S., Ynoue, R., O’Sullivan, S., Pebesma, E., Andrade, M. D. F., and Osses, M. (2017). VEIN v0.2.2: an R package for bottom-up Vehicular Emissions Inventories Geosci. Model Dev. Discus, https://doi.org/10.5194/gmd-2017-193, in review, 2017.

https://doi.org/10.5194/gmd-2017-193