Basics for running VEIN

Source: vignettes/basics.Rmd

This vignette shows how to install and run VEIN for people who do not know R

## Install VEIN

You can install VEIN with

  • GitLab: remotes::install_gitlab("ibarraespinosa/vein")
  • GitHub: remotes::install_github("atmoschem/vein")
  • or CRAN: install.packages("vein")

GitHub and GitLab are more updated

Then, use vein

Download a project

Check the documentation of get_project

?get_project

or here

Choose a name, for instance, “awesome_city”

get_project(directory = "awesome_city")
system("tree  awesome_city")

The structure is:

awesome_city
├── config
│   ├── clean.R
│   ├── config.R
│   ├── inventory.xlsx
│   └── packages.R
├── main.R
├── main.Rproj
├── network
│   ├── net.gpkg
│   └── net.rds
├── scripts
│   ├── evaporatives.R
│   ├── exhaust.R
│   ├── fuel_eval.R
│   ├── net.R
│   ├── pavedroads.R
│   ├── plots.R
│   ├── post.R
│   ├── traffic.R
│   └── wrf.R
└── wrf
└── wrfinput_d02

You have to open the file main.Rproj with Rstudio and then open and run main.R

To run main.R you will need these extra packages:

  • ggplot2
  • readxl
  • eixport (If you plan to generate WRF Chem emissions file)

If you do not have them already, you can install:

install.packages(c("ggplot2", "readxl", "eixport"))

Too complicated? Watch a YouTube video

in English:

in Portuguese:

here