README.Rmd

---
output: github_document
---

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

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# inlamesh3d

<!-- badges: start -->
<!-- badges: end -->

The goal of `inlamesh3d` is to add 3D mesh functionality to fmesher and INLA.
When the methods have been tested, they will be incorporated into the main
packages instead.

For online documentation,
see [https://inlabru-org.github.io/inlamesh3d/](https://inlabru-org.github.io/inlamesh3d/)


## Installation

You can install the development version from [GitHub](https://github.com/) with:

```{r eval=FALSE}
# install.packages("remotes")
remotes::install_github("inlabru-org/inlamesh3d", build_vignettes = TRUE)
```
## Example

You must load `INLA` before loading `inlamesh3d` to get the correct overrides.

```{r example}
suppressPackageStartupMessages(library(INLA))
library(inlamesh3d)
loc <- matrix(rnorm(12), 4, 3)
tv <- geometry::delaunayn(loc)
mesh <- inla.mesh3d(loc, tv)
str(mesh)
```
New version of `inla.spde2.matern`, as well as `fm_basis()`, `fm_evaluator()`,
and `fm_fem()` methods are now available to use in much the same way as for 2D meshes.

For a full example, see `vignette("spde3d")`.