From 14f5461c2f92e34424b5916306c4c178974c4253 Mon Sep 17 00:00:00 2001 From: German <28149841+germa89@users.noreply.github.com> Date: Mon, 6 Nov 2023 11:03:32 +0100 Subject: [PATCH] Adding context to install/support jupyter lab (#2470) * Adding jupyter context * Adding info in installation part * fixing link in readme * Disabling google headings * Disabling Google heading. Adding `mapdl` (lowercase) to accepts. Fixing other warnings. * fixing vale version to avoid pipeline unexpected breakdowns. * Undoing changes from main * Empty comment to trigger CICD * Empty commit to re-trigger CICD --- README.rst | 8 ++++++++ doc/.vale.ini | 2 +- pyproject.toml | 6 ++++++ 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 54948515d2..1dbb9c915a 100644 --- a/README.rst +++ b/README.rst @@ -114,6 +114,14 @@ Install the latest release from `PyPi pip install ansys-mapdl-core +If you are planning to use PyMAPDL together with `Jupyter lab `_, +you can install both in one step: + +.. code:: console + + pip install 'ansys-mapdl-core[jupyter]' + + Alternatively, install the latest from `PyMAPDL GitHub `_ via: diff --git a/doc/.vale.ini b/doc/.vale.ini index 2e76c41081..4383ab4c6d 100644 --- a/doc/.vale.ini +++ b/doc/.vale.ini @@ -31,4 +31,4 @@ TokenIgnores = (:(func|class|meth|attr|py):`(?:.|\n)*?`)|(<.*>) # Removing Google-specific rule - Not applicable under some circumstances Google.Colons = NO -Google.Headings = NO \ No newline at end of file +Google.Headings = NO diff --git a/pyproject.toml b/pyproject.toml index d7f43ca82e..a7e2f1fb0f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -55,6 +55,12 @@ classifiers = [ ] [project.optional-dependencies] +jupyter = [ + "jupyterlab>=3", + "ipywidgets", + "pyvista[jupyter]", +] + tests = [ "ansys-dpf-core==0.10.0", "autopep8==2.0.4",