Polymake.jl icon indicating copy to clipboard operation
Polymake.jl copied to clipboard

Run tests for tutorials in examples/*

Open benlorenz opened this issue 5 years ago • 3 comments

Either in this repository or in a separate oscar-system repository (Tests probably via github-actions)

cc: @kalmarek @micjoswig

benlorenz avatar Apr 23 '20 10:04 benlorenz

yep, I raised this issue when the location of the notebooks was discussed on Thursday meeting; I'm 100% for making sure those work. Do you think Literate.jl an option for this?

kalmarek avatar Jun 30 '20 10:06 kalmarek

Literate.jl cannot really do what we need right now, it can create a notebook from a julia file but not the other way round.

But it could be an option if we change the notebooks to .jl files, which would bring some advantages:

  • Literate.jl can convert to jupyter notebooks for publishing them
  • ipynb is rather bad for version control, jl is a lot better
  • we can just run the scripts in the github actions
  • we could easily convert them to markdown pages instead of relying on github showing the ipynb more or less nicely

disadvantages:

  • needs one more step when running them from the source
  • cannot be edited from within jupyter

opinions @kalmarek @IvanSpirandelli @saschatimme ?

benlorenz avatar Jul 01 '20 07:07 benlorenz

in my exys, the advantages overweigh the disadvantages. especially now, in context of the coming documentation, the generated markdown files sound promising.

but we probably need to exclude the polydb notebook from the tests.

alexej-jordan avatar Aug 04 '20 21:08 alexej-jordan