Skip to content

Commit a9236c1

Browse files
committed
Add patch changes to the documentation
1 parent 19d9d91 commit a9236c1

File tree

4 files changed

+23
-24
lines changed

4 files changed

+23
-24
lines changed

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -141,24 +141,23 @@ preparing the data.
141141

142142
#### Downloading the Data
143143

144-
`LogoClim` relies on raster data to represent climate variables.
145-
Although you can download the original datasets directly from [WorldClim
146-
2.1](https://worldclim.org/), they must be converted to ASCII format
147-
before use in NetLogo. To streamline this process, we provide
148-
[Quarto](https://quarto.org/) notebooks in the `qmd` folder, containing
149-
reproducible pipelines with all necessary commands to download and
150-
process the data. You can easily adapt these notebooks to fit your
151-
specific needs.
152-
153-
For quick testing, you can find example datasets in the model's [OSF
154-
repository](https://doi.org/10.17605/OSF.IO/RE95Z). These files are
155-
already converted to ASCII format and are ready for use with `LogoClim`.
156-
Please note that these datasets are intended for demonstration and
157-
testing only and should not be used for research or analysis.
158-
159-
After downloading, extract the files into the `data` folder within the
160-
model's directory, or use the `Select data directory` button in the
161-
model interface to choose the folder where you extracted the data.
144+
`LogoClim` relies on raster data to represent climate variables. The
145+
datasets are available for download from [WorldClim
146+
2.1](https://worldclim.org/), but must be converted to ASCII format for
147+
compatibility with NetLogo. To simplify this workflow, we provide
148+
[Quarto](https://quarto.org/) notebooks in the repository `qmd` folder
149+
with reproducible pipelines for downloading and processing the data.
150+
These notebooks can be customized to meet specific research needs.
151+
152+
We also provide example datasets for testing and demonstration. These
153+
files are available in the model's [OSF
154+
repository](https://doi.org/10.17605/OSF.IO/RE95Z) and are ready to use
155+
with `LogoClim`.
156+
157+
After downloading and processing the files, place them in the `data`
158+
folder within the model's directory. Alternatively, you can use the
159+
*Select data directory* button in the model interface to specify the
160+
location of your data files.
162161

163162
We suggest starting with the 10-minute resolution to verify that the
164163
model runs smoothly on your system before trying higher resolutions.

README.qmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,11 +131,11 @@ To run the model, make sure to download all files in the `nlogo` folder. Note th
131131

132132
#### Downloading the Data
133133

134-
`LogoClim` relies on raster data to represent climate variables. Although you can download the original datasets directly from [WorldClim 2.1](https://worldclim.org/), they must be converted to ASCII format before use in NetLogo. To streamline this process, we provide [Quarto](https://quarto.org/) notebooks in the `qmd` folder, containing reproducible pipelines with all necessary commands to download and process the data. You can easily adapt these notebooks to fit your specific needs.
134+
`LogoClim` relies on raster data to represent climate variables. The datasets are available for download from [WorldClim 2.1](https://worldclim.org/), but must be converted to ASCII format for compatibility with NetLogo. To simplify this workflow, we provide [Quarto](https://quarto.org/) notebooks in the repository `qmd` folder with reproducible pipelines for downloading and processing the data. These notebooks can be customized to meet specific research needs.
135135

136-
For quick testing, you can find example datasets in the model's [OSF repository](https://doi.org/10.17605/OSF.IO/RE95Z). These files are already converted to ASCII format and are ready for use with `LogoClim`. Please note that these datasets are intended for demonstration and testing only and should not be used for research or analysis.
136+
We also provide example datasets for testing and demonstration. These files are available in the model's [OSF repository](https://doi.org/10.17605/OSF.IO/RE95Z) and are ready to use with `LogoClim`.
137137

138-
After downloading, extract the files into the `data` folder within the model's directory, or use the `Select data directory` button in the model interface to choose the folder where you extracted the data.
138+
After downloading and processing the files, place them in the `data` folder within the model's directory. Alternatively, you can use the *Select data directory* button in the model interface to specify the location of your data files.
139139

140140
We suggest starting with the 10-minute resolution to verify that the model runs smoothly on your system before trying higher resolutions.
141141

images/logoclim-interface.xcf

3.86 KB
Binary file not shown.

nlogo/logoclim.nlogo

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -706,11 +706,11 @@ To run the model, make sure to download all files in the repository `nlogo` fold
706706
707707
#### DOWNLOADING THE DATA
708708
709-
`LogoClim` relies on raster data to represent climate variables. Although you can download the original datasets directly from [WorldClim 2.1](https://worldclim.org/), they must be converted to ASCII format before use in NetLogo. To streamline this process, we provide [Quarto](https://quarto.org/) notebooks in the `qmd` folder, containing reproducible pipelines with all necessary commands to download and process the data. You can easily adapt these notebooks to fit your specific needs.
709+
`LogoClim` relies on raster data to represent climate variables. The datasets are available for download from [WorldClim 2.1](https://worldclim.org/), but must be converted to ASCII format for compatibility with NetLogo. To simplify this workflow, we provide [Quarto](https://quarto.org/) notebooks in the repository `qmd` folder with reproducible pipelines for downloading and processing the data. These notebooks can be customized to meet specific research needs.
710710
711-
For quick testing, you can find example datasets in the model's [OSF repository](https://doi.org/10.17605/OSF.IO/RE95Z). These files are already converted to ASCII format and are ready for use with `LogoClim`. Please note that these datasets are intended for demonstration and testing only and should not be used for research or analysis.
711+
We also provide example datasets for testing and demonstration. These files are available in the model's [OSF repository](https://doi.org/10.17605/OSF.IO/RE95Z) and are ready to use with `LogoClim`.
712712
713-
After downloading, extract the files into the `data` folder within the model's directory, or use the `Select data directory` button in the model interface to choose the folder where you extracted the data.
713+
After downloading and processing the files, place them in the `data` folder within the model's directory. Alternatively, you can use the *Select data directory* button in the model interface to specify the location of your data files.
714714
715715
We suggest starting with the 10-minute resolution to verify that the model runs smoothly on your system before trying higher resolutions.
716716

0 commit comments

Comments
 (0)