Metadata-Version: 1.1
Name: pycsa
Version: 0.1.3
Summary: Python implementation of coupled simulated annealing (CSA)
Home-page: https://github.com/structurely/csa
Author: Boudhayan Banerjee, Evan 'Pete' Walsh
Author-email: ronnie@structurely.com, epwalsh@structurely.com
License: UNKNOWN
Description: Coupled simulated annealing
        ===========================
        
        |Build Status|
        |PyPI|
        
        **Homepage:**
        `github.com/structurely/csa <https://github.com/structurely/csa>`__.
        
        Coupled simulated annealing (CSA) is a generalization of simulated annealing (SA),
        which is an optimization algorithm that doesn't use any information about the derivates
        of a function. The original paper describing CSA can be found here:
        
        ftp://ftp.esat.kuleuven.be/sista/sdesouza/papers/CSA2009accepted.pdf
        
        Essentially, CSA is like multiple simulated annealing (i.e. ``m``
        independent SA processes run in parallel), except that the acceptance
        probability at each step is calculated as a function of the current
        state across *all* ``m`` processes. For a more complete description of
        the general CSA algorithm, see 
        `Description of CSA <https://docs.structurely.com/pycsa/v0.1.3/#description-of-csa>`__.
        
        Installation
        ------------
        
        Using ``pip``:
        
        ::
        
            pip install pycsa
        
        Directly from ``GitHub``:
        
        ::
        
            pip install git+https://github.com/structurely/csa.git
        
        Usage
        -----
        
        See
        `examples/travelling\_salesman.ipynb <https://github.com/structurely/csa/blob/dev/examples/travelling_salesman.ipynb>`__
        for an example of CSA applied to the `travelling salesman problem
        (TSP) <https://en.wikipedia.org/wiki/Travelling_salesman_problem>`__.
        
        Contributing
        ------------
        
        Feel free to submit issues at
        `github.com/structurely/csa/issues <https://github.com/structurely/csa/issues>`__
        and pull requests to the dev branch:
        `github.com/structurely/csa/tree/dev <https://github.com/structurely/csa/tree/dev>`__.
        
        License
        -------
        
        See
        `LICENSE.txt <https://github.com/structurely/csa/blob/dev/LICENSE.txt>`__.
        
        Related
        -------
        
        -  `perrygeo/simanneal <https://github.com/perrygeo/simanneal>`__: a
           Python implementation of (single) simulated annealing.
        -  `docs.scipy.org <https://docs.scipy.org/doc/scipy-0.15.1/reference/generated/scipy.optimize.anneal.html>`__:
           the SciPy implementation of simulated annealing.
        
        
        .. |Build Status| image:: https://travis-ci.org/structurely/csa.svg?branch=dev
           :target: https://travis-ci.org/structurely/csa
        
        .. |PyPI| image:: https://badge.fury.io/py/pycsa.svg
            :target: https://badge.fury.io/py/pycsa
        
Keywords: csa,sa,simulated annealing,annealing,coupled simulated annealing
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Scientific/Engineering
