Made vtk and pyvista optional dependencies

JWock82 · Jan 25, 2025 · f84b3d9 · f84b3d9
1 parent 86d1a19
commit f84b3d9
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@
 An easy to use elastic 3D structural engineering finite element analysis library for Python.
 
 # Installation
-The easiest way to install Pynite is with pip: `pip install PyniteFEA`
+The easiest way to install Pynite is with pip: `pip install PyniteFEA[all]`.
 
 For a more detailed discussion on installation options and dependencies see https://pynite.readthedocs.io/en/latest/installation.html
 

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -6,10 +6,9 @@ Installation
 
 .. code-block:: console
 
-    $ pip install PyniteFEA
+    $ pip install PyniteFEA[all]
 
-Be sure to install ``PyniteFEA`` rather than ``Pynite``. The second one is a different package that
-has nothing to do with finite element analysis.
+Be sure to install ``PyniteFEA`` rather than ``Pynite``. The second one is a different package that has nothing to do with finite element analysis. the ``[all]`` in the line above is only needed if you want to use `Pynite's` built in visualization and reporting features. For a lighter-weight installation you can omit ``[all]``.
 
 For engineers who may be new to `python`, the ``$`` symbol in the line above represents any directory in your system that ``pip`` is accessible from. If you checked the box to place `python` on your system ``PATH`` during installation (recommended) you can run ``pip`` from any directory (see image below). Otherwise it's sitting in the ``Scripts`` folder in the directory where Python was installed, and you'll need to either add it to your system ``PATH`` or navigate to that directory via the console and run the ``pip`` command above.
 

diff --git a/setup.py b/setup.py
@@ -24,13 +24,11 @@
         'PrettyTable',
         'scipy',
         'matplotlib',
-        'vtk',
-        'pyvista[all,trame]',
-        'trame_jupyter_extension',
-        'ipywidgets'
     ],
     extras_require = {
-        'vtk':  ['IPython'],
+        'all': ['Ipython', 'vtk', 'pyvista[all,trame]', 'trame_jupyter_extension', 'ipywidgets', 'pdfkit', 'Jinja2'],
+        'vtk':  ['IPython', 'vtk'],
+        'pyvista': ['pyvista[all,trame]', 'trame_jupyter_extension', 'ipywidgets'],
         'reporting': ['pdfkit', 'Jinja2'],
         'derivations': ['jupyterlab', 'sympy']
     },