index.qmd

# Welcome {.unnumbered}

```{r}
#| label: setup
#| include: false

library(badger)
library(here)
library(htmltools)
library(knitr)

here("R", ".setup.R") |> source()
```

## Welcome

`LogoClim` is a [NetLogo](https://www.netlogo.org) model designed to simulate and visualize global climate conditions. It allows researchers to pull high-resolution climate data directly into agent-based models, making it easier to study how climate variables interact with complex systems over time.

This manual walks you through everything you need to get started: an overview of the model's structure, a breakdown of its core components, step-by-step usage instructions, and practical examples showing how to configure and run simulations. Whether you're new to NetLogo or already familiar with agent-based modeling, the goal here is to give you a clear path from setup to results.

If something is still unclear after reading through, feel free to open a discussion in the project's [discussion tab](https://github.com/sustentarea/logoclim/discussions/categories/q-a) on GitHub. The community is there to help, though response times may vary.


::: {#fig-welcome-logoclim-interface}
![](images/logoclim-interface.gif){fig-align="center" style="width: 100%; padding-top: 0px;"}

`LogoClim`'s interface. Click on the image to enlarge it.
:::

## Citation

```{r}
#| echo: false
#| output: asis

cat(
  badge_custom(
    x = "doi",
    y = "10.17605/OSF.IO/EAPZU",
    color = "1284C5",
    url = "https://doi.org/10.17605/OSF.IO/EAPZU",
    alt = ""
  )
)
```

::: {.callout-note}
When using WorldClim data, you must also cite the original data sources.

The appropriate citation depends on the specific dataset utilized. Please refer to the [WorldClim website](https://www.worldclim.org/data/index.html#citation) for up-to-date citation guidelines and dataset references.
:::

If you use this model in your research, please cite it to acknowledge the effort invested in its development and maintenance. Your citation helps support the ongoing improvement of the model.

To cite `LogoClim` in publications please use the following format:

Vartanian, D., Garcia, L., & Carvalho, A. M. (2026). *LogoClim: WorldClim in NetLogo* [Computer software]. <https://doi.org/10.17605/OSF.IO/EAPZU>

A BibLaTeX entry for LaTeX users is:

```latex
@software{vartanian2026,
  title = {LogoClim: WorldClim in NetLogo},
  author = {{Daniel Vartanian} and {Leandro Garcia} and {Aline Martins de Carvalho}},
  year = {2026},
  doi = {10.17605/OSF.IO/EAPZU}
}
```

## Contributing

```{r}
#| echo: false
#| output: asis

cat(
  badge_custom(
    x = "Contributor%20Covenant",
    y = "3.0",
    color = "4baaaa",
    url = "https://www.contributor-covenant.org/version/3/0/code_of_conduct/",
    alt = ""
  )
)
```

Contributions are always welcome! Whether you want to report bugs, suggest new features, or help improve the code or documentation (including this manual), your input makes a difference.

Before opening a new issue, please check the model's [issues tab](https://github.com/sustentarea/logoclim/issues) to see if your topic has already been reported.

You can also support the development of `LogoClim` by becoming a sponsor. Click [here](https://github.com/sponsors/danielvartan) to make a donation. Please mention `LogoClim` in your donation message.

## License

```{r}
#| echo: false
#| output: asis

cat(
  badge_license(
    license = "CC BY-NC-SA",
    color = "lightgrey",
    url = "https://creativecommons.org/licenses/by-nc-sa/4.0/",
    alt = ""
  )
)
```

This manual is licensed under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/). You can share and adapt the material for non-commercial purposes, as long as you provide appropriate credit, use the same license, and indicate if changes were made.

## Acknowledgments

We gratefully acknowledge [Robert J. Hijmans](https://orcid.org/0000-0001-5872-2872), [Stephen E. Fick](https://orcid.org/0000-0002-3548-6966), and the entire [WorldClim](https://worldclim.org/) team for their outstanding work in creating and maintaining the WorldClim datasets.

We thank the [Climatic Research Unit](https://www.uea.ac.uk/groups-and-centres/climatic-research-unit) at the [University of East Anglia](https://www.uea.ac.uk/) and the United Kingdom's [Met Office](https://www.metoffice.gov.uk/) for developing and providing access to the [CRU-TS-4.09](https://crudata.uea.ac.uk/cru/data/hrg/cru_ts_4.09/) dataset, a vital source of historical climate data.

We also acknowledge the World Climate Research Programme ([WCRP](https://www.wcrp-climate.org/)), its Working Group on Coupled Modelling, and the Coupled Model Intercomparison Project Phase 6 ([CMIP6](https://pcmdi.llnl.gov/CMIP6/)) for coordinating and advancing global climate model development.

We are grateful to the climate modeling groups for producing and sharing their model outputs, the Earth System Grid Federation ([ESGF](https://esgf.llnl.gov/)) for archiving and providing access to the data, and the many funding agencies that support [CMIP6](https://pcmdi.llnl.gov/CMIP6/) and [ESGF](https://esgf.llnl.gov/).


:::: {.columns style="display: flex; align-items: center; margin: 1em; padding-top: 2em;"}
::: {.column style="width: 30%; text-align: center;"}
[![](images/sustentarea-logo.svg){width="115"}](https://www.fsp.usp.br/sustentarea/)
:::
::: {.column style="width: 70%; display: flex; align-items: center;"}
This work was developed with support from the [Sustentarea](https://www.fsp.usp.br/sustentarea/) Research and Extension Center at the University of São Paulo ([USP](https://www5.usp.br/)).
:::
::::

:::: {.columns style="display: flex; align-items: center; margin: 1em;"}
::: {.column style="width: 30%; text-align: center;"}
[![](images/resiclima-logo.svg){width="115"}](https://resiclima.com.br/)
:::
::: {.column style="width: 70%; display: flex; align-items: center;"}
This work was developed with support from the [Resiclima Network](https://resiclima.com.br/), an international collaboration for the multidimensional and interdisciplinary study of global climate change.
:::
::::

:::: {.columns style="display: flex; align-items: center; margin: 1em;"}
::: {.column style="width: 30%; text-align: center;"}
[![](images/cnpq-logo.svg){width="150"}](https://www.gov.br/cnpq/)
:::
::: {.column style="width: 70%; display: flex; align-items: center;"}
This work was supported by the Department of Science and Technology of the Secretariat of Science, Technology, and Innovation and of the Health Economic-Industrial Complex ([SECTICS](https://www.gov.br/saude/pt-br/composicao/sectics/)) of the [Ministry of Health](https://www.gov.br/saude/pt-br/composicao/sectics/) of Brazil, and the National Council for Scientific and Technological Development ([CNPq](https://www.gov.br/cnpq/)) (grant no. 444588/2023-0).
:::
::::