OpenDreamKit.github.io icon indicating copy to clipboard operation
OpenDreamKit.github.io copied to clipboard

'Use Cases' section on opendreamkit.org

Open nthiery opened this issue 7 years ago • 16 comments

Our web site now has a Use cases section, currently available from the Project menu. It's meant to hold short documents such as this one with the following structure:

  • A user-centric scenario
  • A suggestion of solution (or solutions)
  • Links to favorite instances; estimate of the number of such instances.
  • Time and expertise required
  • Links to tutorials, relevant software, etc.
  • What's new since ODK started
  • ODK's contributions

Such documents can be both useful to our readers (providing them with operational solutions and best practices) and to us (showcasing our work, with a concrete perspective on the impact of our actions). In particular it will highlight the versatility brought by the toolkit approach.

Currently, there is a single use case; we should write more! By design they can be relatively short and fun to write, so please volunteer.

Here are some suggestions:

  • [x] Publishing interactive textbooks (@marcinofulus)
  • [x] Publishing live talk slides with SageMath + Jupyter + Rise + binder (@nthiery)
  • [x] Publishing reproducible logbooks (@nthiery)
  • [x] Real time collaboration (@minrk)
  • [ ] Getting training (Soft Carpentry, ... @VivianePons, @alex-konovalov)
  • [ ] Teaching / training with Jupyter
  • [ ] Exploiting modern architecture (@ClementPernet)
  • [ ] 3D visualization (@marcinofulus, ...)
  • [ ] A group of coauthors wanting to collaborate on code/paper/...
  • [ ] Making a software package trivial to try and access (reproducible live documentation and live demos, easy installation)
  • [ ] Deploy your own VRE (@defeo?): a lab wanting to provide remote access to its computing resources
    • [ ] Providing (remote) access to (hosted) interactive software to the students in a class
    • [ ] University/Institution/European Infrastructure wide deployment to provide researchers with easy access to computing resources, software and data
    • [ ] A community wanting to deploy a dedicated VRE (e.g. JOOMMF's VRE) (@fangohr ?)
  • [x] WP6 use case: multi-system math calculations with the Math-in-the-Middle (@kohlhase ?)

Any others welcome!

Once we have enough documents, we should also make the use case section very prominent; possibly moving it to the front page.

nthiery avatar Mar 19 '18 22:03 nthiery

Related to the forthcoming workshop, maybe

  • [ ] Write high-level code that runs at « native speed », either using a ffi tool or a compiler

serge-sans-paille avatar Mar 20 '18 10:03 serge-sans-paille

[ ] Write high-level code that runs at « native speed », either using a ffi tool or a compiler

That's a very good point: we should have use cases about performance, and in particular the ease of writing fast code.

There remains to frame this into a compelling user story. Something that makes a visitor reading the scenario immediately think "ah yes, I have been in those shoes; many people will need that"!

nthiery avatar Mar 20 '18 12:03 nthiery

A group of coauthors want to collaborate on the GAP code in the GitHub repository, not organising it in a form of GAP package, but using the same as GAP packages for CI and test coverage. Eventually they put a demo of their code in a Jupyter notebook, runnable on Binder, and used the RISE extension to use the same notebook in a slideshow mode.

This is https://github.com/sukru-yalcinkaya/unipoly described in the Appendix to D5.15.

olexandr-konovalov avatar Oct 22 '19 20:10 olexandr-konovalov

A group of coauthors want ...

That sounds very nice! Are you willing to write up a brief use-case document about it?

nthiery avatar Oct 22 '19 21:10 nthiery

@nthiery I do. They also have a press-release at https://www.mub.eps.manchester.ac.uk/in-abstract/adjoint-representations-of-black-box-groups/. Collaborative visits were supported by CCP-CoDiMa, and then we agreed that this could be a basis for an interesting demonstration of ODK.

An abstract use case would go further - start the project this way, instead of organising the code after, and submit is as a supplementary material to the paper when it is published.

olexandr-konovalov avatar Oct 22 '19 21:10 olexandr-konovalov

We are writing up a use case for MathHub data.

katjabercic avatar Oct 23 '19 08:10 katjabercic

and an announcement of the system itself (for 8/2019) that we should have done earlier.

kohlhase avatar Oct 23 '19 08:10 kohlhase

Katja has written two new posts and committed them, but they are not showing up on the web page (for two hours). I wonder whether that is still too busy, ...

kohlhase avatar Oct 23 '19 10:10 kohlhase

They were missing a .md extension. Fixed.

Katja has written two new posts and committed them, but they are not showing up on the web page (for two hours). I wonder whether that is still too busy, ...

nthiery avatar Oct 23 '19 11:10 nthiery

thanks a lot. I had looked and not seen this. Chapeau

kohlhase avatar Oct 23 '19 13:10 kohlhase

@minrk: thanks for the use case on collaboration!

  • What about "asynchronous collaboration" instead of "long term collaboration"?
  • About real time collaboration: would there be a tutorial to link to on how to set it up?

nthiery avatar Oct 24 '19 19:10 nthiery

What about "asynchronous collaboration" instead of "long term collaboration"?

Great suggestion!

About real time collaboration: would there be a tutorial to link to on how to set it up?

Yes, I'm working on a demo of this. The Work-in-Progress in JupyterLab is in a bit of a transition, so I'm trying to figure out what will demo best.

minrk avatar Oct 25 '19 11:10 minrk

Hi @VivianePons, @alex-konovalov, I just realized that we really should have a use case about "getting training". Pointing to the pages for codima, gap days, sage days, software carpentry, ... A good occasion to highlight odk contribution, special diversity events, but also that he will last after odk. And to include a couple cool pictures. Would you be willing to write such a use case?

nthiery avatar Oct 26 '19 13:10 nthiery

@nthiery @VivianePons good idea - and also about delivering training (for which they can use our training materials).

olexandr-konovalov avatar Oct 26 '19 17:10 olexandr-konovalov

(hi)

On Sat, Oct 26, 2019 at 10:15:42AM -0700, Alexander Konovalov wrote:

@nthiery @VivianePons good idea - and also about delivering training (for which they can use our training materials).

And our jupyter-training extension.

-- Nicolas Chauvat

logilab.fr - services en informatique scientifique et gestion de connaissances

nchauvat avatar Oct 26 '19 18:10 nchauvat

@nthiery @VivianePons good idea - and also about delivering training (for which they can use our training materials).

And our jupyter-training extension.

Yes; so really two different use cases:

  • Getting training
  • Teaching with Jupyter

I added both to my wish list in the first comment of this issue :-)

nthiery avatar Oct 26 '19 19:10 nthiery