Pyswarms

------------------

This new version adds support for parallel particle evaluation, better
documentation, multiple fixes, and updated build dependencies.

- **NEW**: Updated API documentation - `344`_
- **NEW**: Relaxed dependencies when installing pyswarms - `345`_
- **NEW**: We're now using Azure Pipelines for our builds! - `327`_
- **NEW**: Add notebook for electric circuits - `288`_ . Thank you `miguelcocruz`_ !
- **NEW**: Parallel particle evaluation - `312`_ . Thahnk you once more `danielcorreia96`_ !
- **FIX**: Fix optimise methods returning incorrect best_pos - `322`_ . Thank you `ichbinjakes`_ !
- **FIX**: Fix SearchBase parameter - `328`_ . Thank you `Kutim` !
- **FIX**: Fix basic optimization example - `329`_ . Thank you `IanBoyanZhang`_ !
- **FIX**: Fix global best velocity equation - `330`_ . Thank you `craymichael`_ !
- **FIX**: Update sample code to new API - `296`_ . Thank you `ndngo`_ !

.. _288: https://github.com/ljvmiranda921/pyswarms/pull/288
.. _296: https://github.com/ljvmiranda921/pyswarms/pull/296
.. _312: https://github.com/ljvmiranda921/pyswarms/pull/312
.. _322: https://github.com/ljvmiranda921/pyswarms/pull/322
.. _327: https://github.com/ljvmiranda921/pyswarms/pull/327
.. _328: https://github.com/ljvmiranda921/pyswarms/pull/328
.. _329: https://github.com/ljvmiranda921/pyswarms/pull/329
.. _330: https://github.com/ljvmiranda921/pyswarms/pull/330
.. _344: https://github.com/ljvmiranda921/pyswarms/pull/344
.. _345: https://github.com/ljvmiranda921/pyswarms/pull/345
.. _danielcorreia96: https://github.com/danielcorreia96
.. _miguelcocruz: https://github.com/miguelcocruz
.. _ichbinjakes: https://github.com/ichbinjakes
.. _Kutim: https://github.com/Kutim
.. _IanBoyanZhang: https://github.com/IanBoyanZhang
.. _craymichael: https://github.com/craymichael
.. _ndngo: https://github.com/ndngo

~~~~~~~~~~~~~~~~~~

* **FIX:** BinaryPSO should return final best position instead of final swarm - `293`_ . Thank you once more `danielcorreia96`_ !

.. _293: https://github.com/ljvmiranda921/pyswarms/pull/293
.. _danielcorreia96: https://github.com/danielcorreia96

~~~~~~~~~~~~~~~~~~

* **FIX:** Handlers memory management so that it works all the time - `286`_ . Thanks for this `whzup`_ !
* **FIX:** Re-introduce fix for multiple optimization function calls - `290`_ . Thank you once more `danielcorreia96`_ !

.. _286: https://github.com/ljvmiranda921/pyswarms/pull/286
.. _290: https://github.com/ljvmiranda921/pyswarms/pull/290
.. _whzup: https://github.com/whzup
.. _danielcorreia96: https://github.com/danielcorreia96

------------------

This is the first major release of PySwarms. Starting today, we will be adhering to a `better semantic versioning guidelines`_. We will be updating the project wikis shortly after. The maintainers believe that PySwarms is mature enough to merit a version 1, this would also help us release more often (mostly minor releases) and create patch releases as soon as possible.

Also, we will be maintaining a quarterly release cycle, where the **next minor release (v.1.0.0) will be on June**. All enhancements and new features will be staged on the :code:`development` branch, then will be merged back to the :code:`master` branch at the end of the cycle. However, bug fixes and documentation errors will merit a patch release, and will be merged to :code:`master` immediately.

* **NEW:** Boundary and velocity handlers to resolve stuck particles - `238`_ . All thanks for our maintainer, `whzup`_ !
* **FIX:** Duplication function calls during optimization, hopefully your long-running objective functions won't take doubly long. - `266`_. Thank you `danielcorreia96`_ !

.. _better semantic versioning guidelines: https://semver.org/
.. _238: https://github.com/ljvmiranda921/pyswarms/pull/238
.. _266: https://github.com/ljvmiranda921/pyswarms/pull/266
.. _whzup: https://github.com/whzup
.. _danielcorreia96: https://github.com/danielcorreia96

------------------

* **NEW:** The console output is now generated by the :code:`Reporter` module - `227`_
* **NEW:** A :code:`cost` decorator which automatically scales to the whole swarm - `226`_
* **FIX:** A bug in the topologies where the best position in some topologies was not calculated using the nearest neighbours - `253`_
* **FIX:** Swarm init positions - `249`_ Thanks `dfhljf`_!
* **IMPROVED:** Better naming for the benchmark functions - `222`_ Thanks `nik1082`_!
* **IMPROVED:** Error handling in the :code:`Optimizers` - `232`_
* **IMPROVED:** New management method for dependencies - `263`_
* **DEPRECATED:** The `environments` module is now deprecated - `217`_

.. _217: https://github.com/ljvmiranda921/pyswarms/pull/217
.. _222: https://github.com/ljvmiranda921/pyswarms/pull/222
.. _226: https://github.com/ljvmiranda921/pyswarms/pull/226
.. _227: https://github.com/ljvmiranda921/pyswarms/pull/227
.. _232: https://github.com/ljvmiranda921/pyswarms/pull/232
.. _249: https://github.com/ljvmiranda921/pyswarms/pull/249
.. _253: https://github.com/ljvmiranda921/pyswarms/pull/253
.. _263: https://github.com/ljvmiranda921/pyswarms/pull/263
.. _nik1082: https://github.com/nik1082
.. _dfhljf: https://github.com/dfhljf

~~~~~~~~~~~~~~~~~~

* **NEW:** New collaboration tool using Vagrantfiles - `193`_. Thanks a lot `jdbohrman <https://github.com/jdbohrman>`_!
* **NEW:** Add configuration file for pyup.io - `210`_
* **FIX:** Fix incomplete documentation in ReadTheDocs - `208`_
* **IMPROVED:** Update dependencies via pyup - `204`_

.. _193: https://github.com/ljvmiranda921/pyswarms/pull/193
.. _204: https://github.com/ljvmiranda921/pyswarms/pull/204
.. _208: https://github.com/ljvmiranda921/pyswarms/pull/208
.. _210: https://github.com/ljvmiranda921/pyswarms/pull/210