new usage

README.rst

@@ -70,35 +70,29 @@ However, for instance executing NSGA2:
 
 .. code:: python
 
+   from pymoo.optimize import minimize
+   from pymoo.algorithms.nsga2 import nsga2
+   from pymoo.util import plotting
+   from pymop.factory import get_problem
 
-    import numpy as np
-
-    from pymoo.optimize import minimize
-    from pymoo.util import plotting
-    from pymop.factory import get_problem
-
-    # create the optimization problem
-    problem = get_problem("zdt1")
-    pf = problem.pareto_front()
-
-    res = minimize(problem,
-                   method='nsga2',
-                   method_args={'pop_size': 100},
-                   termination=('n_gen', 200),
-                   pf=pf,
-                   save_history=True,
-                   disp=True)
-
-    plot = True
-    if plot:
-        plotting.plot(pf, res.F, labels=["Pareto-front", "F"])
-
-    # set true if you want to save a video
-    animate = False
-    if animate:
-        from pymoo.util.plotting import animate as func_animtate
-        H = np.concatenate([e.pop.get("F")[None, :] for e in res.history], axis=0)
-        func_animtate('%s.mp4' % problem.name(), H, problem)
+   # load a test or define your own problem
+   problem = get_problem("zdt1")
+
+   # get the optimal solution of the problem for the purpose of comparison
+   pf = problem.pareto_front()
+
+   # create the algorithm object
+   method = nsga2(pop_size=100, elimate_duplicates=True)
+
+   # execute the optimization
+   res = minimize(problem,
+                  method,
+                  termination=('n_gen', 200),
+                  pf=pf,
+                  disp=True)
+
+   # plot the results as a scatter plot
+   plotting.plot(pf, res.F, labels=["Pareto-Front", "F"])
 
 
 

doc/Makefile

@@ -10,6 +10,7 @@ SOURCEDIR     = source
 BUILDDIR      = build
 
 
+
 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext all css
 
 all: html

doc/source/conf.py

@@ -161,6 +161,7 @@
     "edit_link": "false",
     "sidebar": "right",
     "scipy_org_logo": "true",
-    "rootlinks": links_local
+    "rootlinks": links_remote
 }
+
 # html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']}

doc/source/index.rst

@@ -27,11 +27,14 @@ Please note, that the dependencies used in the command above must be fulfilled b
 and can, therefore, not be ensured to be installed prior compilation with the setup script.
 More details about the installation can be found :ref:`here <installation>`.
 
-.. raw:: html
 
-    <a href="/getting_started.html">
-        <img src="/_static/img/getting_started.svg" alt="Getting Started" style="max-width:40%; margin:5px 0px 5px 0px"/>
-    </a>
+.. image:: _static/img/getting_started.svg
+   :target: getting_started.html
+   :width: 40%
+   :alt: Getting Started
+   :align: left
+
+
 
 |vspace|
 

setup.py

@@ -23,7 +23,7 @@ def get_extension_modules():
     url=__url__,
     python_requires='>3.3',
     author_email="[email protected]",
-    description="Multi-Objective Optimization Algorithms",
+    description="Multi-Objective Optimization in Python",
     long_description=readme(),
     license='Apache License 2.0',
     keywords="optimization",
@@ -32,16 +32,18 @@ def get_extension_modules():
     include_package_data=True,
     platforms='any',
     classifiers=[
-        'Development Status :: Production/Stable',
+        'Intended Audience :: Developers',
         'Intended Audience :: Science/Research',
-        'License :: OSI Approved :: Apache License',
         'Operating System :: OS Independent',
+        'License :: OSI Approved :: Apache Software License',
         'Programming Language :: Python',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
-        'Topic :: Optimization :: Multi-objective Optimization',
+        'Topic :: Scientific/Engineering',
+        'Topic :: Scientific/Engineering :: Artificial Intelligence',
+        'Topic :: Scientific/Engineering :: Mathematics'
     ]
 )