Welcome to the GSE Wiki

Welcome to the GSE Wiki#

This collection of wikis is a repository of information for the department of Geoscience & Engineering at TU Delft on, amongst others, computational resources, data and sample management best practices, and How Tos.

Wikis

About the GSE-comp website#

Anybody at GSE can contribute to this wiki.

How to update the Wiki#

There are three options:

  1. Send an email to Jan Thorbecke with your changes.

  2. Create a merge request by editing directly at gitlab.tudelft.nl/gse-citg/gse-comp.

  3. Create a merge request by cloning locally and pushing your changes (make sure to create a new branch; main is a protected branch).

How to build the GSE wiki locally#

Pre-requisite: Working conda environment (Python); we recommend miniforge.

  1. Clone the repository

    git clone git@gitlab.tudelft.nl:gse-citg/gse-comp

  2. Move into the repo and create a conda environment in the terminal with

    cd gse-comp
conda env create -f environment.yml

  3. Activate the conda environment with

    conda activate gse-comp

  4. To generate and preview the documentation, run

    make html     # Generates the docs
make preview  # Opens a browser rendering the local docs

  5. To deploy (you must have sudo-rights on the gse-comp-server for this):

    make deploy
Contents