This repository contains the assignment and processed data for the computer practicals of the course Hydrological Modelling at Ghent University. The public repository does not contain solutions to the exercise. Solutions can be found in the solutions branch of a a private repository, access to which can be granted upon contacting me.
First, make a local copy of this repository using
git clone https://github.com/h-cel/hydrological-modelling.git
or download as zip file and unzip. In each case, make sure to navigate inside the hydrological-modelling folder before executing any of the command line interface (CLI) instructions below.
Go to the Quarto download page and download Quarto for your operating system (OS). This repository was built using Quarto 1.9.38.
Next, make sure you have (Mini)Conda installed (download links found here) to handle virtual environments in Python. Next open your CLI (or Anaconda prompt) and type:
conda env create -f environment.yml
conda activate quarto_template
This ensures that the correct version of Python is used in your CLI.
Next, it is recommended that following Quarto tools are installed:
- In this repository, a final output is rendered to pdf. Therefore, a LaTeX distribution is needed. Install the TinyTex distribution, a lightweight version of TeX Live, with following command in the CLI:
quarto install tinytex. This should be more straightforward than managing your own Tex distribution. - To render the diagrams, made with Mermaid, quarto needs the Chrome or Edge browser. If you don't have Chrome or Edge in your local device and prefer to keep it that way, you can install a Chrome Headless Shell via quarto in the CLI with
quarto install chrome-headless-shell
To check if these installations were successful, run
quarto check
in the CLI. You should see
[✓] Checking LaTeX....................OK
for LaTex and
[✓] Checking Chrome Headless....................OK
for Chrome.
For this purpose, your clone or fork of this repository should be on GitHub.
For this template, the website is hosted using GitHub Pages.
For your own use, start by running
quarto publish gh-pages
This wil automate the process of setting up a gh-pages branch from which the website is hosted.
Although you could publish every change manually with the command above, it is more convenient to automate this process with Github Actions. This is also eliminates the need to have rendered versions of your Quarto Book checked in to version control.
The workflow to automate the publishing (including rendering) of this book is defined in .github/workflows/publish.yml. Also the installation of the needed dependencies (similar to what is described above) is included here. For your own repository, you might need to change the Read and write permissions of your repo for this work, for more info please see the corresponding Quarto documentation.