noresmhub/noresm-exp

Information about NorESM experiments

NorESM Experiments

An overview of NorESM2 experiments including upgrades, code modifications and parameter settings.

The overview includes:

NorESM2-MM CMIP6 DECK simulations
NorESM2-LM CMIP6 DECK simulations
NorESM2-MM CMIP6 historical simulations
NorESM2-LM CMIP6 historical simulations
NorESM2-MM CMIP6 scenario simulations
NorESM2-LM CMIP6 scenario simulations
NorESM2-MM spinup tree
NorESM2-LM spinup tree

Usage

Editing the content

To develop and/or build the NorESM Experiments content, you should:

1. Clone this repository
2. Run pip install -r requirements.txt (it is recommended you do this within a virtual environment)
3. Edit the source files located in the noresm_exp_book/content directory
4. Push the changes to git (branch main) if you want to trigger the automatic build/deploy workflow

Automatic deployment

The GitHub actions workflow (noresm-exp/.github/workflows/deploy.yml) automatically renders the content, pushes the rendered output to the gh-pages branch of the repo and hosts it on GitHub Pages (at https://noresmhub.github.io/noresm-exp/intro) when a push or pull request is made to the main branch.

Local build

To build locally:

1. Run jupyter-book clean noresm_exp_book/ to remove any existing builds
2. Run jupyter-book build noresm_exp_book/

A fully-rendered HTML version of the book will be built in noresm_exp_book/_build/html/.

Credits and licence

This project is created using the open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

noresm-exp's Issues

Adjust (very wide) right margin

Hi @annefou ,
I wonder if it is possible to adjust the page width?
https://noresmhub.github.io/noresm-exp/noresm2_lm_spin/noresm2_lm_spin_intro.html
Now, half on the page is blank and that space would be very useful for adding more columns into tables. Is is possible to adjust it? I have googled a lot, but couldn't find any suggestions.

Best,
Ada

Failed building

Hi @annefou ,
I updated links in all pages and now the building fails, but I'm not sure why and what to change. Too bad I have to disturb you every time I make some changes...

Best regards,
Ada

How to add a "simple" figure to a md file?

Hi @annefou ,

I'm trying to include a figure (Figure_4.png) at the bottom of this page:
https://noresmhub.github.io/noresm-exp/noresm2_lm_spin.html#%60%60%60{figure}-../images/Figure_4.png

I have included what I believed was the correct syntax in this file:
https://github.com/NorESMhub/noresm-exp/blob/master/content/noresm2_lm_spin.md

I have tried all the different options I can think of, but it is not going very well...

Ada

Failed to change table of contents

Hi Anne!
@annefou
I changed the logo. That worked! Yeah!
I tried to add some sections to toc.yml in _data, that failed.
I also tried to add two files which will describe noresm experiments to the content folder. That failed.
Are they suppose to be saved in that folder? Is it more organized to add subfolders? E.g. NorESM2-LM spin up, NorESM2-MM spin up ....

I appreciate some start up help. I tried to look at the Jupyter book tutorial but the syntax seems to be different.

Ada

Folder structure in content

The overview of the NorESM2-LM simulations have worked fine. Then I tried to organize my work in subfolders under content by adding two subfolders, one for NorESM2-MM and one for NorESM2-LM and now nothing works. And I don't understand why... Feedback is very welcome!

Best,
Ada

Figured it out in the end :-)

Failed to build

Hi @annefou,
The NorESM2 experiment documentation fails to build after I changed nothing more than 1 link in one of the files - which is strange so I guess I have changed some rights (executing rights maybe?) just by opening the file-
The timing is not very good as I just presented the webpage on the NorESM2 user workshop 5 minutes ago and will present it again on Thursday. And there are several links I need to change since the path has changes. What to do??

Ada

Fail to build

Hi @annefou ,
I can't make the jupyter book build. It is something wrong with toc I think, but I don't know what is wrong. I have tested and tested, but still it fails...

Logo for norESM-exp

Rather than having the jupyter book logo on https://noresmhub.github.io/noresm-exp/intro, we can add our own logo. Do you hav any idea for a logo for noresm-exp? Otherwise I can make a suggestion...