Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move usecases to external resources #65

Open
1 of 5 tasks
pauleve opened this issue Apr 29, 2020 · 4 comments
Open
1 of 5 tasks

Move usecases to external resources #65

pauleve opened this issue Apr 29, 2020 · 4 comments
Assignees

Comments

@pauleve
Copy link
Contributor

pauleve commented Apr 29, 2020

The docker repository should not aim at including usecases. Usecases should be hosted on external resources (like gist or zenodo) and referenced on the website at https://colomoto.github.io/colomoto-docker/#tutorials-and-use-cases.

@aurelien-naldi
Copy link
Contributor

Agreed, but I think we need to prepare a better system to host them first. Using gist and common notebook viewers is fine, but I would rather keep them together in a place we can handle.

I would add usecases to a separate git repository along with the required files and some metadata (to be defined!). Then we can build a set of static pages to host the use cases with a web preview (using hugo and nbconvert) and download option. We can even annotate them with versions of the colomoto image for which they have been tested and use that to open them in mybinder.

We can start playing with this in a new repository with pages hosted on github (I can set this up) and remove them from the docker repository when we are happy with the result.

@pauleve
Copy link
Contributor Author

pauleve commented Apr 29, 2020

So you see them as some sort of official use cases? In general we can think that they are supplementary material for publications, so it is mainly up to the authors to manage how they are hosted and possibly updated with time.

But we can do both and have some sort of advanced tutorials hosted on a colomoto-notebooks or colomoto-usecases repository, indeed.

@aurelien-naldi
Copy link
Contributor

Not really official, rather a repository open to submission by modellers. Of course it can also contain some "official" notebooks (in particular tutorials). For me it would be nice to have a go-to place to submit analysis notebooks and it would be convenient for new users to have an obvious place to search for example code.

I think that this kind of repository, along with a model repository (on which I am planning to come back once we learn a bit more from the GINsim one) would be a big selling point for the colomoto community.

@pauleve
Copy link
Contributor Author

pauleve commented Apr 29, 2020

👍

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

No branches or pull requests

2 participants