Merge pull request #112 from ritchie46/moveMatplotlibExtrasRequirement

Move matplotlib to extras_require, to make headless installs possible

.github/workflows/release.yaml

@@ -24,6 +24,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
+          pip install -r plot_requirements.txt
           pip install -r test_requirements.txt
       - name: Run linting check with pylint
         run: |

.github/workflows/test.yaml

@@ -20,6 +20,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
+          pip install -r plot_requirements.txt
           pip install -r test_requirements.txt
       - name: Run linting check with pylint
         run: |

anastruct/fem/plotter/__init__.py

@@ -1,2 +1,5 @@
-from .mpl import Plotter
+try:
+    from .mpl import Plotter
+except ImportError:
+    from .null import Plotter  # type: ignore
 from .values import PlottingValues

anastruct/fem/plotter/null.py

@@ -0,0 +1,10 @@
+from anastruct.fem.plotter.values import PlottingValues
+
+
+class Plotter(PlottingValues):
+    def __init__(self, system, mesh):
+        super(Plotter, self).__init__(system, mesh)
+        self.system = system
+        self.one_fig = None
+        self.max_q = 0
+        self.max_system_point_load = 0

doc/source/installation.rst

@@ -5,10 +5,14 @@ You can install anaStruct with pip!
 
 ::
 
+    $ pip install anastruct[plot]
+
+Or if you would like a headless version of anaStruct (with no plotting abilities), you can do that too.
+
+::
     $ pip install anastruct
 
-It takes a while before new features are added in the official PyPI index. So if you want the latest features,
-install from github.
+Finally, while updates are made regularly on PyPI, if you'd like the bleeding edge newest features and fixes, or if you'd like to contribute to the development of anaStruct, then install from github.
 
 ::
 

doc/source/plotting.rst

@@ -4,8 +4,9 @@ Plotting
 The SystemElements object implements several plotting methods for retrieving standard plotting results. Every plotting
 method has got the same parameters. The plotter is based on a Matplotlib backend and it is possible to get the figure
 and do modifications of your own. The x and y coordinates of the model should all be positive value for the plotter
-to work properly.
+to work properly. 
 
+Note that plotting capabilities do require that anaStruct be installed with the "plot" sub-module (e.g. `pip install anastruct[plot]` )
 
 Structure
 #########

plot_requirements.txt

@@ -0,0 +1 @@
+matplotlib==3.5.3

requirements.txt

@@ -1,4 +1,2 @@
-matplotlib==3.5.3
 numpy>=1.15
 scipy>=1.1.0
-

setup.py

@@ -23,6 +23,8 @@ def read_file(file):
 
 long_description = read_file("README.md")
 requirements = read_requirements("requirements.txt")
+plot_requirements = read_requirements("plot_requirements.txt")
+test_requirements = read_requirements("test_requirements.txt")
 __version__ = "0"
 exec(read_file("anastruct/_version.py"))  # pylint: disable=exec-used
 
@@ -51,5 +53,6 @@ def read_file(file):
     ],
     package_data={"anastruct.sectionbase": ["data/*.xml"]},
     install_requires=requirements,
+    extras_require={"plot": plot_requirements, "test": test_requirements},
     ext_modules=em,
 )