Where to put Example notebooks that should not be part of the CI?

[pmrv]

I believe we talked about that before, but what did we agree on in the end? Should there be an extra directory for not run notebooks or should we not allow such notebooks because they end up being out-dated?

[liamhuber]

I lean to the latter. Some compromise ideas:

• in all such notebooks, at the top do a pyiron version check and either fail or issue a severe warning message
• keep such notebooks in a separate "showcase" repo, and instead of including them in the repo, show static snapshots of the notebooks on the website
  • Gives people a tour of what is possible without the immediate suggestion that they should try executing this code
  • should still have a version check at the top so people can quickly see the output and know what version will run this code

Even so, if they're not CI'd I'd rather not have them at all. Definitely can have notebooks that only get tested on the "integration" flag, but this might already be the case (just on my phone atm so not easy to quickly verify).

Edit: proper markdown sub lists

[pmrv]

This sparked by an example notebook @yury-lysogorskiy had put for the ACE code, which we cannot install in CI, so I think a "showcase" is probably a good idea.