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

Run tests for tutorials in examples/* #268

Open
benlorenz opened this issue Apr 23, 2020 · 3 comments
Open

Run tests for tutorials in examples/* #268

benlorenz opened this issue Apr 23, 2020 · 3 comments

Comments

@benlorenz
Copy link
Member

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

cc: @kalmarek @micjoswig

@kalmarek
Copy link
Contributor

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?

@benlorenz
Copy link
Member Author

benlorenz commented Jul 1, 2020

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 ?

@alexej-jordan
Copy link
Collaborator

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.

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

No branches or pull requests

3 participants