Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
miquelcaceres committed Jul 26, 2024
1 parent 6fcd7f7 commit 295ec91
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 13 deletions.
18 changes: 13 additions & 5 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,30 @@ A complete documentation of both packages, including a *reference book*, can be

## Companion R packages

The modelling tools included in **medfate** and **medfateland** are complemented with two companion packages:
The modelling tools included in **medfate** and **medfateland** are closely developed with another package:

+ Package [**meteoland**](https://emf-creaf.github.io/meteoland) allows generating daily weather input for simulation models in **medfate** and **medfateland**.
+ Package [**traits4models**](https://emf-creaf.github.io/traits4models) provides functions to help creating species parameter inputs for process-based models such as those in for **medfate** and **medfateland** functions [*under development*].

The relationships between the four packages are illustrated in the figure below, where black arrows indicate package dependencies and gray arrows indicate model parameter provision.
Two other R packages complete the simulation framework, but can be used for many other purposes beyond forest modelling:

```{r, out.width='60%', fig.align="center", echo=FALSE}
+ Package [**meteoland**](https://emf-creaf.github.io/meteoland) allows generating daily weather input for simulation models in **medfate** and **medfateland**. Package **meteoland** is a dependency for **medfate** and **medfateland**, but can be used independently to obtain daily weather data.
+ Package [**forestables**](https://emf-creaf.github.io/forestables) allows reading and harmonizing forest inventory data to a common data structure. Initialization workflows in **medfateland** can use data from **forestables**, but the data structures of the package can be used for many studies beyond modelling.

The relationships between the five packages are illustrated in the figure below, where black arrows indicate package dependencies and gray arrows indicate model parameter or data provision.

```{r, out.width='80%', fig.align="center", echo=FALSE}
knitr::include_graphics("man/figures/packages.png")
```


## Authorship

The set of R packages are developed and maintained by the [*Ecosystem Modelling Facility*](https://emf.creaf.cat) unit at [*CREAF*](https://www.creaf.cat/) (in Spain), in close collaboration with researchers from [*URFM-INRAE*](https://www6.paca.inrae.fr/ecologie_des_forets_mediterraneennes/) (in France) and [*CTFC*](https://www.ctfc.cat/) (in Spain).
Package **medfateland** is developed and maintained by the [*Ecosystem Modelling Facility*](https://emf.creaf.cat) unit at [*CREAF*](https://www.creaf.cat/) (in Spain), in close collaboration with researchers from [*URFM-INRAE*](https://www6.paca.inrae.fr/ecologie_des_forets_mediterraneennes/) (in France) and [*CTFC*](https://www.ctfc.cat/) (in Spain).

```{r, out.width='60%', fig.align="center", echo=FALSE}
knitr::include_graphics("man/figures/institution_logos.png")
```

## Funding

+ **Research project**: Boosting process-based models to project forest dynamics and associated ecosystem services at stand-to-regional scales (BOMFORES). **Financial Entity**: Ministerio de Ciencia e Innovación (PID2021-126679OB-I00). **Duration from**: 01/09/2022 **to**: 31/08/2024. **PI**: Miquel De Cáceres.
35 changes: 27 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,29 +44,48 @@ can be found at <https://emf-creaf.github.io/medfatebook/index.html>.
## Companion R packages

The modelling tools included in **medfate** and **medfateland** are
complemented with two companion packages:
closely developed with another package:

- Package [**meteoland**](https://emf-creaf.github.io/meteoland) allows
generating daily weather input for simulation models in **medfate**
and **medfateland**.
- Package [**traits4models**](https://emf-creaf.github.io/traits4models)
provides functions to help creating species parameter inputs for
process-based models such as those in for **medfate** and
**medfateland** functions \[*under development*\].

The relationships between the four packages are illustrated in the
Two other R packages complete the simulation framework, but can be used
for many other purposes beyond forest modelling:

- Package [**meteoland**](https://emf-creaf.github.io/meteoland) allows
generating daily weather input for simulation models in **medfate**
and **medfateland**. Package **meteoland** is a dependency for
**medfate** and **medfateland**, but can be used independently to
obtain daily weather data.
- Package [**forestables**](https://emf-creaf.github.io/forestables)
allows reading and harmonizing forest inventory data to a common data
structure. Initialization workflows in **medfateland** can use data
from **forestables**, but the data structures of the package can be
used for many studies beyond modelling.

The relationships between the five packages are illustrated in the
figure below, where black arrows indicate package dependencies and gray
arrows indicate model parameter provision.
arrows indicate model parameter or data provision.

<img src="man/figures/packages.png" width="60%" style="display: block; margin: auto;" />
<img src="man/figures/packages.png" width="80%" style="display: block; margin: auto;" />

## Authorship

The set of R packages are developed and maintained by the [*Ecosystem
Package **medfateland** is developed and maintained by the [*Ecosystem
Modelling Facility*](https://emf.creaf.cat) unit at
[*CREAF*](https://www.creaf.cat/) (in Spain), in close collaboration
with researchers from
[*URFM-INRAE*](https://www6.paca.inrae.fr/ecologie_des_forets_mediterraneennes/)
(in France) and [*CTFC*](https://www.ctfc.cat/) (in Spain).

<img src="man/figures/institution_logos.png" width="60%" style="display: block; margin: auto;" />

## Funding

- **Research project**: Boosting process-based models to project forest
dynamics and associated ecosystem services at stand-to-regional scales
(BOMFORES). **Financial Entity**: Ministerio de Ciencia e Innovación
(PID2021-126679OB-I00). **Duration from**: 01/09/2022 **to**:
31/08/2024. **PI**: Miquel De Cáceres.
Binary file modified man/figures/packages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 295ec91

Please sign in to comment.