Cleanup for The Diagram Styles (#31)

README.md

@@ -41,20 +41,16 @@ You need to install these libraries for pyXDSM to work. See the [install guide](
 ## How do I use it?
 Here is a simple example. There are some other more advanced things you can do as well. Check out the [examples folder](https://github.com/mdolab/pyXDSM/blob/master/examples)
 ```python
-from pyxdsm.XDSM import XDSM
-
-opt = 'Optimization'
-solver = 'MDA'
-func = 'Function'
+from pyxdsm.XDSM import XDSM, OPT, SOLVER, FUNC
 
 x = XDSM()
 
-x.add_system('opt', opt, r'\text{Optimizer}')
-x.add_system('solver', solver, r'\text{Newton}')
-x.add_system('D1', func, 'D_1')
-x.add_system('D2', func, 'D_2')
-x.add_system('F', func, 'F')
-x.add_system('G', func, 'G')
+x.add_system('opt', OPT, r'\text{Optimizer}')
+x.add_system('solver', SOLVER, r'\text{Newton}')
+x.add_system('D1', FUNC, 'D_1')
+x.add_system('D2', FUNC, 'D_2')
+x.add_system('F', FUNC, 'F')
+x.add_system('G', FUNC, 'G')
 
 x.connect('opt', 'D1', 'x, z')
 x.connect('opt', 'D2', 'z')

examples/kitchen_sink.py

@@ -1,4 +1,5 @@
-from pyxdsm.XDSM import XDSM
+from pyxdsm.XDSM import (XDSM, OPT, SUBOPT, SOLVER, DOE, 
+                         IFUNC, FUNC, GROUP, IGROUP, METAMODEL)
 
 # styling names for the boxes
 opt = 'Optimization'

examples/mdf.py

@@ -1,18 +1,14 @@
-from pyxdsm.XDSM import XDSM
-
-opt = 'Optimization'
-solver = 'MDA'
-func = 'Function'
+from pyxdsm.XDSM import XDSM, OPT, SOLVER, FUNC
 
 # Change `use_sfmath` to False to use computer modern
 x = XDSM(use_sfmath=True)
 
-x.add_system('opt', opt, r'\text{Optimizer}')
-x.add_system('solver', solver, r'\text{Newton}')
-x.add_system('D1', func, 'D_1')
-x.add_system('D2', func, 'D_2')
-x.add_system('F', func, 'F')
-x.add_system('G', func, 'G')
+x.add_system('opt', OPT, r'\text{Optimizer}')
+x.add_system('solver', SOLVER, r'\text{Newton}')
+x.add_system('D1', FUNC, 'D_1')
+x.add_system('D2', FUNC, 'D_2')
+x.add_system('F', FUNC, 'F')
+x.add_system('G', FUNC, 'G')
 
 x.connect('opt', 'D1', 'x, z')
 x.connect('opt', 'D2', 'z')

pyxdsm/XDSM.py

@@ -7,6 +7,16 @@
 
 from pyxdsm import __version__ as pyxdsm_version
 
+OPT = 'Optimization'
+SUBOPT = 'SubOptimization'
+SOLVER = 'MDA'
+DOE = 'DOE'
+IFUNC = 'ImplicitFunction'
+FUNC = 'Function'
+GROUP = 'Group'
+IGROUP = 'ImplicitGroup'
+METAMODEL = 'Metamodel'
+
 tikzpicture_template = r"""
 %%% Preamble Requirements %%%
 % \usepackage{{geometry}}

pyxdsm/tests/test_xdsm.py

@@ -1,6 +1,6 @@
 import unittest
 import os
-from pyxdsm.XDSM import XDSM, __file__
+from pyxdsm.XDSM import XDSM, __file__, OPT, FUNC, SOLVER
 from numpy.distutils.exec_command import find_executable
 
 
@@ -56,8 +56,8 @@ def test_examples(self):
 
     def test_connect(self): 
         x = XDSM(use_sfmath=False)
-        x.add_system('D1', 'Function', 'D_1', label_width=2)
-        x.add_system('D2', 'Function', 'D_2', stack=False)
+        x.add_system('D1', FUNC, 'D_1', label_width=2)
+        x.add_system('D2', FUNC, 'D_2', stack=False)
 
         try: 
             x.connect('D1', 'D2', r'\mathcal{R}(y_1)', 'foobar')
@@ -74,12 +74,12 @@ def test_options(self):
         # Change `use_sfmath` to False to use computer modern
         x = XDSM(use_sfmath=False)
 
-        x.add_system('opt', 'Optimization', r'\text{Optimizer}')
-        x.add_system('solver', 'MDA', r'\text{Newton}')
-        x.add_system('D1', 'Function', 'D_1', label_width=2)
-        x.add_system('D2', 'Function', 'D_2', stack=False)
-        x.add_system('F', 'Function', 'F', faded=True)
-        x.add_system('G', 'Function', 'G', spec_name="G_spec")
+        x.add_system('opt', OPT, r'\text{Optimizer}')
+        x.add_system('solver', SOLVER, r'\text{Newton}')
+        x.add_system('D1', FUNC, 'D_1', label_width=2)
+        x.add_system('D2', FUNC, 'D_2', stack=False)
+        x.add_system('F', FUNC, 'F', faded=True)
+        x.add_system('G', FUNC, 'G', spec_name="G_spec")
 
         x.connect('opt', 'D1', 'x, z')
         x.connect('opt', 'D2', 'z')
@@ -114,7 +114,7 @@ def test_stacked_system(self):
 
         x = XDSM()
 
-        x.add_system('test', 'Optimization', r'\text{test}', stack=True)
+        x.add_system('test', OPT, r'\text{test}', stack=True)
 
         file_name = "stacked_test"
         x.write(file_name)
@@ -251,12 +251,12 @@ def test_tikz_content(self):
 
         x = XDSM(use_sfmath=True)
 
-        x.add_system('opt', 'Optimization', r'\text{Optimizer}')
-        x.add_system('solver', 'MDA', r'\text{Newton}')
-        x.add_system('D1', 'Function', 'D_1')
-        x.add_system('D2', 'Function', 'D_2')
-        x.add_system('F', 'Function', 'F')
-        x.add_system('G', 'Function', 'G')
+        x.add_system('opt', OPT, r'\text{Optimizer}')
+        x.add_system('solver', SOLVER, r'\text{Newton}')
+        x.add_system('D1', FUNC, 'D_1')
+        x.add_system('D2', FUNC, 'D_2')
+        x.add_system('F', FUNC, 'F')
+        x.add_system('G', FUNC, 'G')
 
         x.connect('opt', 'D1', 'x, z')
         x.connect('opt', 'D2', 'z')