Skip to content

Add a more in-depth installation guide #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RichardPfr opened this issue May 22, 2024 · 0 comments
Open

Add a more in-depth installation guide #15

RichardPfr opened this issue May 22, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@RichardPfr
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants