Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
blankjul committed Apr 19, 2019
1 parent 5e95370 commit 2eb8c24
Showing 1 changed file with 23 additions and 19 deletions.
42 changes: 23 additions & 19 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,44 +1,50 @@
pymoo - Multi-Objective Optimization Framework
====================================================================

You can find the detailed documentation here: http://pymoo.org
You can find the detailed documentation here: https://pymoo.org

.. image:: https://gitlab.msu.edu/blankjul/pymoo/badges/master/pipeline.svg

|gitlab| |python| |license|


.. |gitlab| image:: https://gitlab.msu.edu/blankjul/pymoo/badges/master/pipeline.svg
:alt: build status
:target: https://gitlab.msu.edu/blankjul/pymoo/commits/master

.. image:: https://img.shields.io/badge/python-3.6-blue.svg
.. |python| image:: https://img.shields.io/badge/python-3.6-blue.svg
:alt: python 3.6

.. image:: https://img.shields.io/badge/license-apache-blue.svg
.. |license| image:: https://img.shields.io/badge/license-apache-blue.svg
:alt: license apache
:target: https://www.apache.org/licenses/LICENSE-2.0


Installation
====================================================================
We are currently working on a paper about *pymoo*.
Meanwhile, if you have used our framework for research purposes, please cite us with:

First, make sure you have a python environment installed. We recommend miniconda3 or anaconda3.
::

.. code:: bash
@misc{pymoo,
author = {Julian Blank and Kalyanmoy Deb},
title = {pymoo - {Multi-objective Optimization in Python}},
howpublished = {https://pymoo.org}
}

conda --version

Then from scratch create a virtual environment for pymoo:

.. code:: bash
conda create -n pymoo -y python==3.6 cython numpy
conda activate pymoo
Installation
====================================================================

First, make sure you have a Python 3 environment installed. We recommend miniconda3 or anaconda3.

For the current stable release please execute:
The official release is always available at PyPi:

.. code:: bash
pip install pymoo
pip install Cython>=0.29 numpy>=1.15 pymoo
For the current development version:
For the current developer version:

.. code:: bash
Expand All @@ -64,8 +70,6 @@ However, for instance executing NSGA2:

.. code:: python
import numpy as np
Expand Down

0 comments on commit 2eb8c24

Please sign in to comment.