Skip to content

[JOSS] Out‑of‑date Jupyter notebooks – a few are broken #342

Description

@FlorianK13

I am generally impressed by the amount of information in the notebooks. They are well documented and help understanding the typical workflows. However some (and only some) of these notebooks do not run, for example tutorials/04_scenario/01_scenario_temperature.ipynb fails when trying scene_temp.run() with Attribute Error:

'NoneType' object has no attribute 'keys'

As a user, it can be very frustrating if notebooks referenced in the docs page fail with errors that are not easy to understand.

I see some possible solutions here:

  • Maybe you could define a sub section of "critical docs notebooks" that describe the core functionality and keep those up to date?
  • You could also think about integrating these notebooks into your testing? I have never done that, but based on this blog post it seems doable.

I am open to discuss this further - in the end you are the maintainer and devs and you know much more about this repo :)

This issue is part of a joss review, see openjournals/joss-reviews#10617

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions