3  How to Use It

This manual is still under development and may be subject to change.

This warning will be removed once the manual is finalized.

To get started using LogoClim, ensure you have NetLogo installed. The current version of the model was developed using NetLogo 7.0.3, so it is recommended to use this version or later.

LogoClim also relies on the GIS, Pathdir, String, and Time NetLogo extensions. You don’t need to install them, these are automatically installed when the model is run for the first time.

3.1 Downloading the Model

You can download the latest release of the model from the CoMSES Network or at its GitHub releases page.

For the development version, you can clone or download the GitHub code repository directly.

3.2 Opening the Model

After downloading and uncompressing the model files, open the logoclim.nlogox file in NetLogo. This file is located in the nlogox folder.

3.3 Preparing the Data

Climate data from WorldClim is required but not included with the model. To use LogoClim you will need to prepare the data that suits your research. We prepared functions that do this job for you. See the WorldClim section to learn more.

We also provide example datasets for testing and demonstration. These files are available in the model’s OSF repository and are ready to use with LogoClim. Use them as a starting point.

With files at hand, use the Select Data Directory button in the model interface to specify their location.

3.4 Running the Model

See the section below for details on the interface controls.

Once everything is set, click Setup and then Go buttons to start the simulation.

3.4.1 Interface Controls

3.4.1.1 Choosers, Input Boxes, Sliders, And Switches

  • data-series: Chooser for selecting a data series (default: Historical Monthly Weather Data).
  • data-resolution: Chooser for selecting the spatial resolution of the data, expressed in minutes of a degree of latitude/longitude (default: 10 Minutes (~340 km2 at the Equator)).
  • climate-variable: Chooser for selecting the climate variable (default: Average Maximum Temperature (°C)).
  • bioclimatic-variable: Chooser for selecting a bioclimatic variable. Only useful when climate-variable is set to bioclimatic-variables (default: BIO1 - Annual Mean Temperature).
  • start-month: Chooser for selecting the simulation’s starting month (default: January).
  • global-climate-model: Chooser for selecting a global climate model. Only useful when Future Climate Data is selected (default: CMCC-ESM2).
  • shared-socioeconomic-pathway: Chooser for selecting a Shared Socioeconomic Pathway (SSP) scenario. Only useful when Future Climate Data is selected (default: SSP-585).
  • start-year: Input box for setting the simulation’s start year in YYYY format (default: 1951).
  • data-path: Input box for setting the path to the data folder. Usually, this does not need to be changed. Use the Select Data Directory button to navigate via a dialog window (default: ../data/).
  • historical-climate-color: Input box for setting the color used to represent the Historical Climate Data series (default: 105 (blue)).
  • historical-monthly-weather-color: Input box for setting the color used to represent the Historical Monthly Weather Data series (default: 25 (orange)).
  • future-climate-color: Input box for setting the color used to represent the Future Climate Data series (default: 15 red)).
  • color-bar-bins: Slider for setting the number of bins in the Color Bar plot (default: 15).
  • black-value: Slider for setting the lower threshold for the black color on the world map (default: 0).
  • black-min: Switch for setting the black color threshold to the minimum value of the current dataset. If it is set to On, black-value will be ignored (default: On).
  • white-value: Slider for setting the upper threshold for the white color on the world map (default: 50).
  • white-max: Switch for setting the white color threshold to the maximum value of the current dataset. If it is set to On, white-value will be ignored (default: On).

3.4.1.2 Buttons

  • Setup: Initializes the simulation with the selected parameters.
  • Go: Starts or resumes the simulation.
  • Go Back: Steps the simulation backward in time. This also reset ticks and clear all the plots.
  • Go Forward: Steps the simulation forward in time.
  • Select Data Directory: Opens a dialog window, allowing the user to indicate the data directory.
  • Show Values: Displays patch values when hovering the mouse over them.

3.4.2 Monitors And Plots

  • Climate Variable: Displays the climate variable being used. If climate-variable is set to Bioclimatic Variables, it instead shows the variable selected in the bioclimatic-variable chooser.
  • Month, Year: Displays the current month and year being simulated.
  • Color Bar: A plot showing the color scale used on the world map, with black representing the lowest value and white representing the highest value. The color scale is divided into bins, which can be adjusted using the color-bar-bins slider.
  • Minimum, Maximum, Mean, Standard Deviation: Monitors and plots showing the minimum, maximum, mean, and standard deviation values for the climate variable across the patches. If more than 12 months of data are available, a line matching the series color marks the start of each 12-month cycle, and a 12-month moving average (12MA) is added to highlight trends.

3.5 Integrating with Other Models

LogoClim was created to be integrated with other models using NetLogo’s LevelSpace extension. This extension enables parallel execution and data exchange between models.

Find more information about this in the LevelSpace Overview section.

See the Logônia model for a practical example of LogoClim use.