Skip to content

First draft of docs for trying OSCAR online#788

Open
aaruni96 wants to merge 4 commits intogh-pagesfrom
ak96/docs-for-nfdi-jupyterhub
Open

First draft of docs for trying OSCAR online#788
aaruni96 wants to merge 4 commits intogh-pagesfrom
ak96/docs-for-nfdi-jupyterhub

Conversation

@aaruni96
Copy link
Copy Markdown
Member

First draft, open to comments and suggestions.

@lgoettgens lgoettgens marked this pull request as draft February 24, 2026 22:04
HereAround
HereAround previously approved these changes Feb 25, 2026
Copy link
Copy Markdown
Member

@HereAround HereAround left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you Aaruni. This generally looks good to me.

One nitpick - the picture with the version number shows Oscar 1.7.0. Maybe that version is at some point in the future (a year from now, two years from now) a bit old? Maybe it makes sense to add an explaining sentence to avoid confusion?

Something like the following for example:

"At the time of writing (Feb 2026), the latest release version of Oscar was 1.7.0, as seen in the screenshot below. Right now, when you read these instructions, the latest OSCAR release is v... This is the version you should see when executing the version_info() command."

@aaruni96 aaruni96 marked this pull request as ready for review February 25, 2026 15:30
@aaruni96 aaruni96 requested a review from lgoettgens February 25, 2026 15:30
@lgoettgens
Copy link
Copy Markdown
Member

image It would be good to move the image to our "blessed" organization instead of a personal repo in the long term (not for this version of the PR).

@lgoettgens
Copy link
Copy Markdown
Member

There seems to be an unnecessary amount of bloat in the docker filesystem.
image
IMO this should be hidden as best as possible

![](hit-start.png){: width="50%" }

5. Select the option in the notebook section which says "Oscar".
![Oscar selection in notebook section](oscar-notebook.png){: width="50%" }
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is the kernel named "Oscar 1.12" even though it does not provide version 1.12? Wouldn't it be better to name it "OSCAR with julia 1.12"?

interface when it is ready.
![](hit-start.png){: width="50%" }

5. Select the option in the notebook section which says "Oscar".
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the difference between the OSCAR variants in the notebook versus the console section? In any case, perhaps we should add a little text after the image which says: "If you accidentally started the OSCAR entry in the "console" section (instead of the "notebook" section), or any other of the listed entries, don't worry: you can just do INSERT INSTRUCTION HERE.

@fingolfin
Copy link
Copy Markdown
Member

Thanks @aaruni96 !

aaruni96 and others added 2 commits March 10, 2026 17:23
Co-authored-by: Lars Göttgens <lars.goettgens@rwth-aachen.de>
Co-authored-by: Max Horn <max@quendi.de>
Co-authored-by: Max Horn <max@quendi.de>
Copy link
Copy Markdown
Member

@fingolfin fingolfin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this. Some more minor notes.


# Try OSCAR Online

OSCAR can be tried online without installation, on the NFDI jupyter hub.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
OSCAR can be tried online without installation, on the NFDI jupyter hub.
OSCAR can be tried online without installation, on the NFDI Jupyter hub.


1. Go to
<https://hub.nfdi-jupyter.de/workshops/oscar-latest>,
and login. Select "Helmholtz AAI" if no other choice applies to you.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
and login. Select "Helmholtz AAI" if no other choice applies to you.
and log in. Select "Helmholtz AAI" if no other choice applies to you.

below, with a row saying "Try out the latest OSCAR in the cloud" and a
"Start" button to the right of it. Click on that "Start" button to start
OSCAR online. This may take some time, up to 10 minutes. You will be
automatically redirected to a jupyter interface when it is ready
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe do a global search and replace to make sure "Jupyter" is spelled consistently.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants