Skip to main content

Python micro framework for building nature-inspired algorithms.

Project description

PyPI Version PyPI - Python Version PyPI - Status PyPI - Downloads GitHub Release Date Anaconda-Server Badge Documentation Status GitHub license

Scrutinizer Code Quality Coverage Status GitHub commit activity Updates Average time to resolve an issue Percentage of issues still open GitHub contributors

DOI zenodo DOI JOSS

About

Nature-inspired algorithms are a very popular tool for solving optimization problems. Numerous variants of nature-inspired algorithms have been developed since the beginning of their era. To prove their versatility, those were tested in various domains on various applications, especially when they are hybridized, modified or adapted. However, implementation of nature-inspired algorithms is sometimes a difficult, complex and tedious task. In order to break this wall, NiaPy is intended for simple and quick use, without spending time for implementing algorithms from scratch.

http://c1.staticflickr.com/5/4757/26625486258_41ea6d95e0.jpg

Mission

Our mission is to build a collection of nature-inspired algorithms and create a simple interface for managing the optimization process.
NiaPy will offer:
  • numerous benchmark functions implementations,

  • use of various nature-inspired algorithms without struggle and effort with a simple interface,

  • easy comparison between nature-inspired algorithms and

  • export of results in various formats (LaTeX, JSON, Excel).

Overview

Python micro framework for building nature-inspired algorithms. Official documentation is available here.

The micro framework features following algorithms:

  • basic:
    • Artificial bee colony algorithm

    • Bat algorithm

    • Camel algorithm

    • Cuckoo search

    • Differential evolution algorithm

    • Evolution Strategy

    • Firefly algorithm

    • Fireworks algorithm

    • Flower pollination algorithm

    • Forest optimization algorithm

    • Genetic algorithm

    • Glowworm swarm optimization

    • Grey wolf optimizer

    • Monarch butterfly optimization

    • Moth flame optimizer

    • Harmony Search algorithm

    • Krill herd algorithm

    • Monkey king evolution

    • Multiple trajectory search

    • Particle swarm optimization

    • Sine cosine algorithm

  • modified:
    • Hybrid bat algorithm

    • Self-adaptive differential evolution algorithm

    • Dynamic population size self-adaptive differential evolution algorithm

  • other:
    • Anarchic society optimization algorithm

    • Hill climbing algorithm

    • Multiple trajectory search

    • Nelder mead method or downhill simplex method or amoeba method

    • Simulated annealing algorithm

The following benchmark functions are included in NiaPy:

  • Ackley

  • Alpine
    • Alpine1

    • Alpine2

  • Bent Cigar

  • Chung Reynolds

  • Csendes

  • Discus

  • Dixon-Price

  • Elliptic

  • Griewank

  • Happy cat

  • HGBat

  • Katsuura

  • Levy

  • Michalewicz

  • Perm

  • Pintér

  • Powell

  • Qing

  • Quintic

  • Rastrigin

  • Ridge

  • Rosenbrock

  • Salomon

  • Schumer Steiglitz

  • Schwefel
    • Schwefel 2.21

    • Schwefel 2.22

  • Sphere
    • Sphere2 -> Sphere with different powers

    • Sphere3 -> Rotated hyper-ellipsoid

  • Step
    • Step2

    • Step3

  • Stepint

  • Styblinski-Tang

  • Sum Squares

  • Trid

  • Weierstrass

  • Whitley

  • Zakharov

Setup

Requirements

  • Python 3.6.x or 3.7.x (backward compatibility with 2.7.x)

  • Pip

Dependencies

  • numpy >= 1.16.2

  • scipy >= 1.2.1

  • enum34 >= 1.1.6 (if using python version < 3.4)

  • xlsxwriter >= 1.1.6

  • matplotlib >= 2.2.4

List of development dependencies and requirements can be found in the installation section of NiaPy documentation.

Installation

Install NiaPy with pip:

$ pip install NiaPy

Install NiaPy with conda:

$ conda install -c niaorg niapy

Or directly from the source code:

$ git clone https://github.com/NiaOrg/NiaPy.git
$ cd NiaPy
$ python setup.py install

Usage

After installation, the package can imported:

$ python
>>> import NiaPy
>>> NiaPy.__version__

For more usage examples please look at examples folder.

Contributing

Open Source Helpers

We encourage you to contribute to NiaPy! Please check out the Contributing to NiaPy guide for guidelines about how to proceed.

Everyone interacting in NiaPy’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the NiaPy code of conduct.

Licence

This package is distributed under the MIT License. This license can be found online at http://www.opensource.org/licenses/MIT.

Disclaimer

This framework is provided as-is, and there are no guarantees that it fits your purposes or that it is bug-free. Use it at your own risk!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

NiaPy-2.0.0rc10.tar.gz (142.2 kB view details)

Uploaded Source

Built Distribution

NiaPy-2.0.0rc10-py3-none-any.whl (212.4 kB view details)

Uploaded Python 3

File details

Details for the file NiaPy-2.0.0rc10.tar.gz.

File metadata

  • Download URL: NiaPy-2.0.0rc10.tar.gz
  • Upload date:
  • Size: 142.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.5

File hashes

Hashes for NiaPy-2.0.0rc10.tar.gz
Algorithm Hash digest
SHA256 1d274fd27c8675bf3c30cd903eff98d983c3a1281264963b5f11c5ce8840d823
MD5 e82709ca8cfec0a32e7e4ec3a53a595b
BLAKE2b-256 26048ff52ba5b50b81c3490ee82024e45e58226ffab9ccd504a6ce7ebff094b8

See more details on using hashes here.

File details

Details for the file NiaPy-2.0.0rc10-py3-none-any.whl.

File metadata

  • Download URL: NiaPy-2.0.0rc10-py3-none-any.whl
  • Upload date:
  • Size: 212.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.5

File hashes

Hashes for NiaPy-2.0.0rc10-py3-none-any.whl
Algorithm Hash digest
SHA256 85e5b17e809d8d5806d3abc82574e0f9384de7e126c1228459e1282e95f4ac68
MD5 02c4708047f210006cb6a87d8527df1d
BLAKE2b-256 21cc188600a551120c29480706565f3a526f81fc5ea13ed094b2cdabaff5388b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page