N-Wouda / ALNS

Adaptive large neighbourhood search (and more!) in Python.
https://alns.readthedocs.io/en/latest/
MIT License
442 stars 123 forks source link

Add a "getting started" code template #131

Closed N-Wouda closed 1 year ago

N-Wouda commented 1 year ago

Closes #130. This PR:

codecov[bot] commented 1 year ago

Codecov Report

Merging #131 (d769000) into master (a37e484) will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #131   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           28        28           
  Lines          668       668           
=========================================
  Hits           668       668           
Impacted Files Coverage Δ
alns/ALNS.py 100.00% <ø> (ø)

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

N-Wouda commented 1 year ago

@leonlan I think this is most of what I want to do for the "quickstart" template. I've also added a few notes here and there about e.g. copying in the destroy operators, and how to model a maximisation problem. Can you have a read?

The notebooks haven't changed - I just moved the data files into a separate directory, and updated/reran the notebooks.