Skip to content

Improve the Quickstart Guide and add advanced tutorials #130

@flo-schu

Description

@flo-schu

Improving the quickstart guide and adding advanced tutorials

As an additional, and very important benefit, you will become familiar with pymob by working on this task.

Based on the feedback of the pymob workshop, I would like to borrow your eyes and thoughts to improve the quickstart guide. When you stumble over concepts you find unintuitive, we can be sure that other users will have the same questions :)

Below, you find two ideas for advanced tutorials in the Sub-issues. These ideas build up on the discussion we had after the workshop and aim to develop and repeat the concepts from the quickstart guide, rather than to start again from something new. The idea is to have at the end:

This whole task should be as much fun as possible for you, so you can consider the structure as a general direction for the user guide, but I am more than happy if you add your own ideas 😊

Preparation:

  • Clone pymob and install as an editable package: https://pymob.readthedocs.io/en/dev/user_guide/installation.html#development
  • check out the new development branch git switch 130-improve-the-quickstart-guide-and-add-advanced-tutorials
  • Find the quickstart guide notebook docs/source/user_guide/quickstart.ipynb and execute it
  • Look at docs/README.md
  • Convert the notebook to a markdown document jupyter nbconvert --to markdown --execute docs/source/user_guide/quickstart.ipynb

Sub-issues

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions