Metadata-Version: 2.1
Name: josiann
Version: 1.1.7
Summary: Simulated Annealing for noisy cost function
License: LICENSE
Keywords: simulated annealing,optimization,noisy
Author: Matteo Bouvier
Author-email: m.bouvier@vidium-solutions.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: CeCILL-B Free Software License Agreement (CECILL-B)
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Provides-Extra: docs
Provides-Extra: plot
Requires-Dist: attrs (>=23.2.0,<24.0.0)
Requires-Dist: numpy (>=1.26.4,<2.0.0)
Requires-Dist: tqdm (>=4.66.2,<5.0.0)
Project-URL: Documentation, https://josiann.readthedocs.io/
Project-URL: Source, https://github.com/Vidium/josiann
Description-Content-Type: text/markdown

# Josiann: Just anOther SImulated ANNealing

Josiann is a Python library which implements the simulated annealing algorithm for noisy cost functions. It has
support for vectorized functions, multiprocessing and provides a parallel mode for optimizing several similar but
independent problems at once.

Source code (CeCILL-B): [https://github.com/Vidium/josiann](https://github.com/Vidium/josiann)

Documentation: [https://josiann.readthedocs.io/en/latest/index.html](https://josiann.readthedocs.io/en/latest/index.html)

## Installation
Josiann requires Python 3.8+ to run and relies on the following libraries :
- Numpy
- attrs
- tqdm

### Pip installation

```bash
pip install josiann
```

Optional diagnostic plots need the library `plotly` to be generated. You can install it alongside with Josiann :

```bash
pip install josiann[plot]
```

## Examples

Several examples of using Josiann can be found in the `docs/tutorials` folder.

