Skip to content

Store executed versions of notebooks #78

@ketch

Description

@ketch

Currently we are storing notebooks with all output removed. I think we should instead store fully-executed notebooks.

Advantages:

  • Anyone viewing the notebook on github will see the output (including images and JSAnimations) without having to download and run the notebook
  • Currently we keep a second copy of most notebooks, executed, as a gist. Duplication is evil! Even moreso for notebooks, since they are harder to diff. This will avoid it.
  • We could include a watermark cell in each notebook, showing the version of Clawpack (and other libraries) that it was last executed with. This would be a nice solution to Add better tracking of version compatibility to each app #55.

Disadvantages:

  • Bigger files. But I don't think they'll be huge, and I think it's okay for an 'apps' repository to be fairly heavy.
  • Output like images and animations may change and can't reasonably be diffed. Again, I think this is okay. Its only effect is to create large sections of unparseable stuff in the diffs, and I believe that's worth it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions