search

oscar-system / oscar-website

Dev repo for the oscar website
https://www.oscar-system.org
8 stars 32 forks source link

Attempt to add schemes tutorial #364

Closed HereAround closed 1 month ago

HereAround commented 1 month ago

As requested by @HechtiDerLachs , this is an attempt to bring in the first schemes tutorial. As such,

I should believe that this PR works, but could not verify yet. In particular, @aaruni96 if I run jekyll locally, then it gives me an empty list of tutorials. Maybe I forgot to run a local script?

@HechtiDerLachs I did not have much time for this PR, as you know. So I just chose black for the color of the schemes QR Code. Do you like that? If not, can you please create a new colored QR code and update this PR? (Or send me the new QR code that you like better.)

@HechtiDerLachs @aaruni96 I could not open this notebook yesterday without logging into github. Can you try if this notebook can be reached without a password? If a password (or OSCAR authorization of any sort) is needed, then please do not merge this PR -- I think the tutorials should be accessible even for people without github account/OSCAR rights.

aaruni96 commented 1 month ago

Maybe I forgot to run a local script

You need to run the script which fetches tutorial's last update times before any tutorials show up at all

Can you try if this notebook can be reached without a password

It cannot. The oscar-system/notebooks is a private repository, so, you need to be specifically granted access to this, even just logging into github is not enough.

HereAround commented 1 month ago

Can you try if this notebook can be reached without a password

It cannot. The oscar-system/notebooks is a private repository, so, you need to be specifically granted access to this, even just logging into github is not enough.

Thank you for verifying. This I believe is a strict no-go. The tutorials should be accessible to everybody. So ping to @simonbrandhorst and @HechtiDerLachs . If you really want this as a tutorial, you either need to move it to a different location or change the access rights to the file.

Let me mention that we test the tutorials once every 24 hours with the latest stable OSCAR release. Does this notebook run with this version of OSCAR?

We can also not necessarily fix failures/errors in those notebooks (is it just a coding issue? a mathematical issue? the code runs successfully but presents a mathematically incorrect result). Rather we need your help. If you change the file location/access writes, consider having convenient write access so that you can provide fixes with the least effort in the future.

Let us know how you want to proceed.

HereAround commented 1 month ago

One more thing to consider:

Each tutorial topic in OSCAR comes with a colored QR-Code. By now, already a fair amount of colors are taken (cf. https://www.oscar-system.org/tutorials/). For now, I have just created a black QR Code. If you care for a different color, can you please generate the QR code in your favorite color. The content of the QR code should simply be the link https://www.oscar-system.org/tutorials/Schemes/, where the scheme(s) tutorial(s) will appear in the future.

HechtiDerLachs commented 1 month ago

If you care for a different color, can you please generate the QR code in your favorite color.

I don't know how to do that, unfortunately. But I would probably go for the color with html code db58bf.

aaruni96 commented 1 month ago

Here it is, you'll need to add it to the PR yourself though @HereAround (I don't yet know how to push things to someone else's PR)

schemes-colord

HereAround commented 1 month ago

Ok. Just updated everything. (I did not bother to keep the history straight. Just squashing this one, once we are done.)

Let me verify that this PR is now functional...

HereAround commented 1 month ago

Ok. This seems to work locally for me. (I cannot open the notebook in nbviewer, but this might be a problem with nbviewer and/or the internet connection in KL.)

@aaruni96 Any obvious mistakes? If not, I suggest we squash and merge this.

aaruni96 commented 1 month ago

Looks good to me

HereAround commented 1 month ago

Just merged. @HechtiDerLachs , please verify that it looks and works as you desire. Let me know if changes are needed.

HechtiDerLachs commented 1 month ago

Thx!

The nbviewer also doesn't work for me (404). But I can access the github version.

aaruni96 commented 1 month ago

Ah, the branch is wrong (its master in the website, but main on github). Github web transparently redirects you to the default branch, nbviewer probably can't

@HereAround just requires master to be changed to main, and then it should work

HereAround commented 1 month ago

Ah, the branch is wrong (its master in the website, but main on github). Github web transparently redirects you to the default branch, nbviewer probably can't

@HereAround just requires master to be changed to main, and then it should work

Ok. Let me adjust this.

HereAround commented 1 month ago

https://github.com/oscar-system/oscar-website/pull/367