https://github.com/haozeke/anneal

A python package for simmulated annealing and quenching
https://github.com/haozeke/anneal

Last synced: 22 days ago
JSON representation

A python package for simmulated annealing and quenching

• Host: GitHub
• URL: https://github.com/haozeke/anneal
• Owner: HaoZeke
• License: mit
• Created: 2023-02-05T23:29:50.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-17T00:53:47.000Z (9 months ago)
• Last Synced: 2024-09-19T16:18:37.773Z (about 2 months ago)
• Language: Python
• Size: 805 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
![Logo](./branding/logo/anneal_logo.png)

# Anneal [![DOI](https://zenodo.org/badge/597892274.svg)](https://zenodo.org/doi/10.5281/zenodo.10672746)

This is a `python` package for simulated annealing (and quenching) in all its

many guises. The design decisions are described in the corresponding [ArXiV preprint](https://arxiv.org/abs/2302.02811v2).

## Development

`pdm` is used throughout.

``` sh

micromamba create -f environment.yml

micromamba activate anneal-dev

```

## Contributing

> All contributions are welcome!!

- We follow the [NumPy commit guidelines](https://numpy.org/doc/stable/dev/development_workflow.html#writing-the-commit-message).

- Please run `pdm all` and ensure no linting or test errors exist

- [Co-author commits](https://github.blog/2018-01-29-commit-together-with-co-authors/) generously

# License

MIT.