Skip to content

Add a more in-depth installation guide #15

@RichardPfr

Description

@RichardPfr

The current guide works, though may not be accurate or in-depth enough.
Having pictures or even a video for all subsequent steps, even after the installation of Python (as currently), may be more understandable.

Additionally @mxstrl is currently testing this out himself and with some students so he will be able to give a better overview what steps are needed or which can cause troubles during installation.

Also it might be good to, from our side, define a optimal working environment, define how PyRolL is best used and also go through its setup during this guide.
May include:

  • installation of an IDE (Pycharm)
  • setup of virtual environments (hatch)
  • introduction to an optimal workflow (define .venv via tomls, initialize venv, use PyRolL in venv)

If we define such a fixed workflow we could also provide templates for it (hatch.toml, pyproject.toml, jupyter-notebook with basic setup).

Everyone more experienced with Python and its usage will know where he can do something differently to our example.

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions