Home

Welcome to the climate-data-dynamics-lab-website wiki!

This repository contains the code for the Climate Data and Dynamics lab website. This wiki aims to be a bare bones explanation for editing and maintaining the website, see the template documentation for more in depth information. If you find any useful information about about editing the lab website please add to this wiki!

Editing the website

The two main file types that need editing are markdown and yaml files. Below is some information to help but you can also just look at files that are already in the folders and use those as a template. The lab website testbed also has information about editing plus various ways in which things can be displayed.

Personal sections

Each member of the lab should create a markdown file in the _members folder that is the team members name (e.g. john-doe.md). This markdown file contains a header where you need to put your name, a photo (if you like), your role and set links to other things (like your GitHub account google scholar). A standard one might look like

---
name: John Doe
aliases: # Necessary to be able to find your papers using the link in your profile
  - J. Doe
  - J. M. Doe
image: images/john-headshot.jpeg
role: 
links:
  home-page: #link to home page
  email:
  github: #GitHub username
  orcid:
  google-scholar:
---

Note: The photo file should be .jpeg and placed in in the images folder.

Then, in the text of the markdown file, you can write information about yourself. The website template then builds everything into a nice page on the website!

ANOTHER NOTE: for the "search for John Doe's papers on the research page" to correctly find you, you need to add aliases that you use when you author paper.

Projects

Editing the text at the top of the projects page is done in projects/index.md.

To create a project on the Projects page in the website an entry in the _data/projects.yaml. Adding the group: featured field in the project entry is what allows it to be featured on the projects page.

Home page

The home page is the index.md file located in the root of the repository. To edit the homepage edit this file.

Research

To include your publications on the research page, please add your ORCID id to the ocrcid.yaml script in a pull request.

The publications are all handled by a GitHub action which periodically generates a pull request to update the list of publications based on an ORCID profile (I think google scholar may also be used). The citations.yaml file is automatically generated from the chosen orcid profile and does not need to edited (unless maybe a figure needs to be added to the entry).

Thumbnail images are not always added but you can add them separately. One option is to save the image in google drive and then make the file able to embedded in HTML. Then in the sources.yaml file add the image to the id that is generated in citations.yaml

- id: # check `citations.yaml` for the id of the publication you want to add the thumbnail to
  image: # url to image

Once this is done there is no need to further update anything, the template then takes care of everything each time the citations are updated.

Citations not appearing

NOTE: this is only for citations that are not retrieved from an ORCID id.

We have had an extra condition to the cite.py to remove any entries that are not from journal publications. This is done by comparing the citation["publisher"] field to a list of journals.

       # remove entries that are not from journal publications
       if citation["publisher"] in journals:
           # add new citation to list
           citations.append(citation)

This means that if the journal you published in is not in the journals variable you will need to add it. To add the journal to the journals variable open a pull request, add your journal to the list of journals, then commit. This will build a preview of the website in the PR which you can check to see if your citation has appeared.

To return to the default behaviour (including all citations e.g. conference presenatations, datasets, etc. from orcid sources ) remove the lines that filter according to the journal field,

        # remove entries that are not from journal publications
        if citation["publisher"] in journals:

and bring

            citations.append(citation)

in one level of indentation.

Updating the website template

This template is maintained so there will at times be a need/want/reason to update the template. To do so follow instructions from the template documentation. There is a little bit of manual work to be done when updating the website to make sure that it does not overwrite what has already been done.