Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-MET committed Nov 15, 2023
1 parent d3039a8 commit c3af0c6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 20 deletions.
8 changes: 1 addition & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ output: github_document

<!-- README.md is generated from README.Rmd. Please edit that file -->

<style>
body{
text-align: justify;
}
</style>

```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = FALSE,
Expand All @@ -18,7 +12,7 @@ knitr::opts_chunk$set(
out.width = "100%"
)
```
# harpIO <a href=#><img src='man/figures/harp_logo_dark.svg' align="right" height="131.5" style="margin-left:30px" /></a>
# harpIO <img src='man/figures/harp_logo_dark.svg' align="right" width ="80" />


{harpIO} provides a set of read and write functions for harp plus the option to transform gridded data to point data, cross sections or other grids at read time. {harpIO} is able to read _grib1_, _grib2_, _FA_, _NetCDF_ and _vfld_ files from weather forecast / climate models; station observations from _vobs_ files, radar / satellite observations from _HDF5_ files and in the future from in-house databases at selected meteorological institutes. Some of these formats require support packages to be installed and you will be given advice on which packages to install when you attempt to read those data.
Expand Down
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

<style>
body{
text-align: justify;
}
</style>

# harpIO <a href=#><img src='man/figures/harp_logo_dark.svg' align="right" height="131.5" style="margin-left:30px" /></a>
# harpIO <img src='man/figures/harp_logo_dark.svg' align="right" width ="80" />

{harpIO} provides a set of read and write functions for harp plus the
option to transform gridded data to point data, cross sections or other
Expand Down Expand Up @@ -65,7 +59,8 @@ If you include these environment variables in your .bashrc file, or
equivalent, you won’t need to worry about it when you wish to install an
update to meteogrid.

Or you can set compiler and linker options in the file $HOME/.R/Makevars
Or you can set compiler and linker options in the file
\$HOME/.R/Makevars

``` bash
CPPFLAGS=-I/path/to/proj/include
Expand Down Expand Up @@ -102,11 +97,11 @@ When data are interpolated to points it is possible to save the result
to [SQLite](https://www.sqlite.org/) files. These are portable database
files that allow fast access to the data with the ability to select and
filter what you wish to read. You can tell `read_forecast()` to output
point data to SQLite files by setting the argument `output_file_opts =
sqlite_opts(path = "/path/to/output")`. These data can then be read with
`read_point_forecast()`. For gridded data there is generally no
advantage to outputting to another format, so this option is only
available if data are either point data to begin with, or
point data to SQLite files by setting the argument
`output_file_opts = sqlite_opts(path = "/path/to/output")`. These data
can then be read with `read_point_forecast()`. For gridded data there is
generally no advantage to outputting to another format, so this option
is only available if data are either point data to begin with, or
`transformation = "interpolate"`.

## Reading observation data
Expand Down

0 comments on commit c3af0c6

Please sign in to comment.