From 26321ff300a12ae334c37ed237e95797aa9aaf26 Mon Sep 17 00:00:00 2001 From: pytlab Date: Thu, 8 Nov 2018 14:05:17 +0800 Subject: [PATCH] Update READEME --- README.rst | 2 +- setup.py | 37 ++++++++++++++++++++++++++++++------- 2 files changed, 31 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index b61d597..c41630e 100644 --- a/README.rst +++ b/README.rst @@ -20,7 +20,7 @@ A **G**\ enetic **A**\ lgorithm **F**\ ramework in py\ **T**\ hon :target: https://www.python.org/downloads/release/python-351/ :alt: platform -.. image:: https://img.shields.io/badge/pypi-v0.5.5-blue.svg +.. image:: https://img.shields.io/badge/pypi-v0.5.6-blue.svg :target: https://pypi.python.org/pypi/gaft/ :alt: versions diff --git a/setup.py b/setup.py index 71e8f61..51211bb 100644 --- a/setup.py +++ b/setup.py @@ -20,8 +20,9 @@ :target: https://travis-ci.org/PytLab/gaft :alt: Build Status -.. image:: https://codecov.io/gh/PytLab/gaft/branch/master/graph/badge.svg - :target: https://codecov.io/gh/PytLab/gaft +.. image:: https://img.shields.io/codecov/c/github/PytLab/gaft/master.svg + :target: https://codecov.io/gh/PytLab/gaft + :alt: Codecov .. image:: https://landscape.io/github/PytLab/gaft/master/landscape.svg?style=flat :target: https://landscape.io/github/PytLab/gaft/master @@ -31,20 +32,29 @@ :target: https://www.python.org/downloads/release/python-351/ :alt: platform -.. image:: https://img.shields.io/badge/pypi-v0.5.5-blue.svg +.. image:: https://img.shields.io/badge/pypi-v0.5.6-blue.svg :target: https://pypi.python.org/pypi/gaft/ :alt: versions +.. image:: https://readthedocs.org/projects/gaft-docs/badge/?version=latest + :target: https://gaft-docs.readthedocs.io/en/latest/?badge=latest + :alt: Documentation Status + Introduction ------------ -**gaft** is a Python Framework for genetic algorithm computation. It provide built-in genetic operators for genetic algorithm optimization and plugin interfaces for users to define your own genetic operators and on-the-fly analysis for algorithm testing. +**GAFT** is a general Python Framework for genetic algorithm computation. It provides built-in genetic operators for target optimization and plugin interfaces for users to define your own genetic operators and on-the-fly analysis for algorithm testing. + +**GAFT** is now accelerated using MPI parallelization interfaces. You can run it on your cluster in parallel with MPI environment. -**gaft** is now accelerated using MPI parallelization interfaces. You can run it on your cluster in parallal with MPI environment. +Python Support +-------------- -Installation: -------------- +**GAFT** requires Python version 3.x (Python 2.x is not supported). + +Installation +------------ 1. Via pip:: @@ -54,9 +64,22 @@ python setup.py install +If you want GAFT to run in MPI env, please install mpi4py explicitly:: + + pip install mpi4py + See `INSTALL.md `_ for more installation details. +Test +---- + +Run unit test:: + + python setup.py test + + ''' + install_requires = [ ]