PySA: Fast Simulated Annealing in Native Python

PySA is an extensible platform to optimize classical cost function.

PySA is a heuristic solver that does not provide bounds or guarantees on optimality of solutions.

Getting Started

Tutorials on how to use PySA can be found in pysa/tutorials.

Contributors

Salvatore Mandrà (PySA core)
Humberto Munoz-Bauza (PySA core)
Ata Akbari Asanjan (Restricted Boltzmann Machine)
Lucas Brady (Restricted Boltzmann Machine)
Aaron Lott (Restricted Boltzmann Machine)
David Bernal Neira (Hyper Parameters Optimization)

Available Modules

PySA provides multiple modules that can be independently installed: * Generator of Random McEliece instances (pysa-mceliece) * Stern Algorithm to solve unstructured decoding problems (pysa-stern) * Branch-and-Bound Library with Workload Autobalance Between Threads and Nodes (pysa-branching) * WalkSAT algorithm for SAT problems (pysa-walksat) * DPLL Implementation for SAT based on pysa-braching (pysa-dpll)

Installation

PySA can be installed by using pip directly from the GitHub repository: pip install git+https://github.com/nasa/pysa using a zip file: pip install pysa.zip or by using conda: conda env create -f envinronment.yml

NASA Open Source Agreement and Contributions

See NOSA.

Notices

Copyright @ 2023, United States Government, as represented by the Administrator of the National Aeronautics and Space Administration. All rights reserved.

Disclaimer

No Warranty: THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL BE ERROR FREE, OR ANY WARRANTY THAT DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE SUBJECT SOFTWARE. THIS AGREEMENT DOES NOT, IN ANY MANNER, CONSTITUTE AN ENDORSEMENT BY GOVERNMENT AGENCY OR ANY PRIOR RECIPIENT OF ANY RESULTS, RESULTING DESIGNS, HARDWARE, SOFTWARE PRODUCTS OR ANY OTHER APPLICATIONS RESULTING FROM USE OF THE SUBJECT SOFTWARE. FURTHER, GOVERNMENT AGENCY DISCLAIMS ALL WARRANTIES AND LIABILITIES REGARDING THIRD-PARTY SOFTWARE, IF PRESENT IN THE ORIGINAL SOFTWARE, AND DISTRIBUTES IT "AS IS."

Waiver and Indemnity: RECIPIENT AGREES TO WAIVE ANY AND ALL CLAIMS AGAINST THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT. IF RECIPIENT'S USE OF THE SUBJECT SOFTWARE RESULTS IN ANY LIABILITIES, DEMANDS, DAMAGES, EXPENSES OR LOSSES ARISING FROM SUCH USE, INCLUDING ANY DAMAGES FROM PRODUCTS BASED ON, OR RESULTING FROM, RECIPIENT'S USE OF THE SUBJECT SOFTWARE, RECIPIENT SHALL INDEMNIFY AND HOLD HARMLESS THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT, TO THE EXTENT PERMITTED BY LAW. RECIPIENT'S SOLE REMEDY FOR ANY SUCH MATTER SHALL BE THE IMMEDIATE, UNILATERAL TERMINATION OF THIS AGREEMENT.

Licence

Copyright © 2023, United States Government, as represented by the Administrator of the National Aeronautics and Space Administration. All rights reserved.

The PySA, a powerful tool for solving optimization problems is licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.