Add description for Jupyter to README.md

[kloimhardt]

This is a suggestion for a usage description of Noj+Jupyter. It could be included in any other place than README.md

[daslu]

@kloimhardt
This looks great to me, so clear and helpful.

One little comment:
You refer to the noj-v2-getting-started notebook, but at the moment, its visualizations will actually fail in Jupyter (discussed here.

We'll probably have better self-contained code examples in the coming days. For now, it might be better to avoid this specific one.

[daslu]

@kloimhardt @behrica

I am proposing the following -- what do you think?

• To solve the problem of the changing version, we can include the above text in a chapter of a Noj book rather than the README. In that chapter, we will fetch the current version string and print the code relevant to that version.

• We will add a very basic Getting Started chapter, that will include a few code examples that are currently compatible with the Clojupyter JAR. We will link to that chapter as a code example, rather than to the currently linked tutorial (which is currently not supported in Clojupyter).

[kloimhardt]

@daslu Sounds good. This PR was just a proposal. I am not keen to actually getting it pulled. It can be closed at any time. But I leave it open as a reminder for now.

[daslu]

Thanks.
Maybe we can merge it as a first step, and then (if you wish), collaborate on turning it into a chapter in the book.

Let us see what @behrica thinks.

[behrica]

looks good to me.
Maybe you can add additional a link to https://github.com/qubit55/clojupyter_colab_setup
as an alternative way to run this kernel in Google Colab ?

[kloimhardt]

Added the Colab link and removed the link to the getting-started notebook. Feedback welcome. However, this text is free to use for anyone and any purpose deemed to fit, without any need to get an opinion from my side.

[daslu]

@behrica I'm confused.

If I understand correctly, the Colab setup does not support Noj yet.
qubit55/clojupyter_colab_setup#5

So, isn't it confusing to mention it here?

[behrica]

Yes, the download location is hardcoded. So to be forked and changed. I opened an issue to have it configurable. I can revise the text accordingly Daniel Slutsky ***@***.***> schrieb am Sa., 8. Feb. 2025, 17:02:

…

@behrica <https://github.com/behrica> I'm confused. If I understand correctly, the Colab setup does not support Noj yet. qubit55/clojupyter_colab_setup#5 <qubit55/clojupyter_colab_setup#5> So, isn't it confusing to mention it here? — Reply to this email directly, view it on GitHub <#132 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAA7DANFML3JAGS3LH3YKQT2OYS7XAVCNFSM6AAAAABWWC3FFSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNBVHAYDOMJXGQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[behrica]

Nevertheless it's worth to link to it . It's not obvious how to do this. Hopefully soon it's configurable .

[daslu]

@behrica Thanks.

Would you like to merge this and then revise the text?

[daslu]

I suggest adding a clarifying note that currently Jupyter supports most but not all data visualization kinds.

[daslu]

Should we merge this?

[kloimhardt]

I am closing this PR to clean the slate a bit. This PR is about a few lines of text only. Which are not lost and can be copied into any place desired (maybe README.md is not the right place).

[daslu]

@behrica
I think we can merge this.