Skip to content

Commit

Permalink
Adding context to install/support jupyter lab (#2470)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
germa89 authored Nov 6, 2023
1 parent eec59a2 commit 14f5461
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://jupyter.org/>`_,
you can install both in one step:

.. code:: console
pip install 'ansys-mapdl-core[jupyter]'
Alternatively, install the latest from `PyMAPDL GitHub
<https://github.com/ansys/pymapdl/issues>`_ via:

Expand Down
2 changes: 1 addition & 1 deletion doc/.vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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
Google.Headings = NO
6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 14f5461

Please sign in to comment.