Skip to main content

Simple Particle Swarm Optimization

Project description

Optimus-Beez

This is a Particle Swarm Optimization (PSO) package. The PSO used is the simplest version presented by Maurice Clarc in "Particle Swarm Optimization".

Installation

Run the following command: pip install optimusbeez

How to use Optimus-Beez

Choosing the function to evaluate

The default function to evaluate is Rosenbrock. To change this, first check out evaluate.py. This file contains evaluate() that evaluates points for different functions. If the function you wish to use is not defined, then go ahead and add it to evaluate(). Then go to function_info.txt and change

  • fn_name to the name of one of the functions in evaluate()
  • true_position to the x,y-coordinates of the global minimum of your function

Optimizing the parameters of the PSO

The optimization algorithm itself contains 5 parameters that need to be set by the user. These are set in the file optimal_constants.txt. In the code, these parameters are referred to as 'constants' so as not to confuse them with the x,y-coordinates. It is a good idea to optimize these constants using optimize_constants.py. Run optimize_constants.py on your command line. This is just good old random search optimization. You will be prompted several times for input. Use a value of 'time steps' similar to what you want to use with PSO. When the random search is completed, you will be asked if you want to overwrite the file optimal_constants.txt. Do this if you would like to use these constants in PSO.py.

Using PSO

The main script is PSO.py. Run this in the command line. You will be asked if you want to change the number of evaluations. If the value you wish to set is much larger or smaller than the default value, it is advised you run optimize_constants.py again. Set the value, or use the default value and wait for the PSO to finish. You will see an animation of your swarm at the end.

Testing

Nose is used to test the code. All tests are located in the 'tests' folder.To run the tests, execute:

nosetests

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

optimusbeez-0.1.1.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

optimusbeez-0.1.1-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

Details for the file optimusbeez-0.1.1.tar.gz.

File metadata

  • Download URL: optimusbeez-0.1.1.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for optimusbeez-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8df001031fa50426eb3e5ebb1f02c5573707e809ca89d36b3001f7f2c2a8a144
MD5 6dae6881e60665f65c18116afe475bbe
BLAKE2b-256 e5beb37c30d12d193e94b8f80926980903efcdf0a7f7f1333f80c1ff16a18277

See more details on using hashes here.

File details

Details for the file optimusbeez-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: optimusbeez-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 18.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for optimusbeez-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c8596c939e89854ad07ea913dab1cf9ae9ed09c3393d3eb0f56b486da1f36a85
MD5 5a2c8d4012266b3fbea15b489d9e405e
BLAKE2b-256 748f45996cee22fc22012f7112329abdb663dadd27f3e26bc6dedb5d19ff6919

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