From d94e1bbc13d1f0e1510bdc02061dad229877cde3 Mon Sep 17 00:00:00 2001 From: Ahmed Ilyas <ahmed.n.ilyas@gmail.com> Date: Tue, 30 Jul 2024 14:04:41 +0200 Subject: [PATCH] Minor doc update for py311 --- docs/howto/develop/setup.md | 6 +++--- docs/tutorial/develop_plugin.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/howto/develop/setup.md b/docs/howto/develop/setup.md index 6c897cbf1d..332901a57c 100644 --- a/docs/howto/develop/setup.md +++ b/docs/howto/develop/setup.md @@ -59,19 +59,19 @@ git submodule update --init ### Set up a Python environment -The NOMAD code currently targets Python 3.9. You should work in a Python virtual environment. +The NOMAD code currently requires at least Python 3.9, but we recommend using Python 3.11. You should work in a Python virtual environment. #### Pyenv If your host machine has an older version installed, -you can use [pyenv](https://github.com/pyenv/pyenv){:target="_blank"} to use Python 3.9 in parallel with your +you can use [pyenv](https://github.com/pyenv/pyenv){:target="_blank"} to use Python 3.11 in parallel with your system's Python. #### Virtualenv Create a virtual environment. It allows you to keep NOMAD and its dependencies separate from your system's Python installation. -Make sure that the virtual environment is based on Python 3.9. +Make sure that the virtual environment is based on Python 3.11. Use either the built-in `venv` module (see example) or [virtualenv](https://pypi.org/project/virtualenv/){:target="_blank"}. ```shell diff --git a/docs/tutorial/develop_plugin.md b/docs/tutorial/develop_plugin.md index f60077d022..d5f285406e 100644 --- a/docs/tutorial/develop_plugin.md +++ b/docs/tutorial/develop_plugin.md @@ -169,7 +169,7 @@ and the "Allow GitHub Actions to create and approve pull requests" options and c ## Setting up the python environment ### Creating a virtual environment -Before we can start developing we recommend to create a virtual environment using Python 3.9 +Before we can start developing we recommend to create a virtual environment using Python 3.11 ```sh python3.11 -m venv .pyenv -- GitLab