Documentation

[Jean1995]

Here we can collect all ideas concerning (better) documentation for PROPOSAL

[Jean1995]

Propagator jupyter notebook
Currently, the jupyter notebook example for the Propagator explains in detail how to create a Propagator object "by hand". However, the default method should be creating a Propagator using a json_file.

Since the default way is only mentioned briefly while the "non-standard" way is described in detail, many new users directly started initializing their Propagators manually, i.e. "the hard way".

I propose that in the current Propagator jupyter notebook, we only explain how to initialize the Propagator using a json file. We might give a minimal example with some explanation, and refer users to the existing documentation of the configuration file.

For initializing the Propagator manually, we should have an extra jupyter notebook, called something like "Propagator_manual", "Propagator_by_hand", "Propagator_expert", "Propagator_advanced" or something like this. This way, new users should be encouraged to rather use configuration files to initialize their Propagators.