Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a "getting started" code template #131

Merged
merged 6 commits into from
Dec 29, 2022
Merged

Conversation

N-Wouda
Copy link
Owner

@N-Wouda N-Wouda commented Dec 27, 2022

Closes #130. This PR:

  • Introduces a "getting started" code template in the docs, and clarifies what a user needs to bring to the table.
  • Moves the example data files from examples/ to examples/data/.

@N-Wouda N-Wouda requested a review from leonlan December 27, 2022 12:53
@codecov
Copy link

codecov bot commented Dec 27, 2022

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% <ø> (ø)

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

@N-Wouda
Copy link
Owner Author

N-Wouda commented Dec 27, 2022

@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.

Copy link
Collaborator

@leonlan leonlan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, only some minor comments.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/setup/template.rst Outdated Show resolved Hide resolved
docs/source/setup/template.rst Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@N-Wouda N-Wouda merged commit 89622f9 into master Dec 29, 2022
@N-Wouda N-Wouda deleted the getting-started-template branch December 29, 2022 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Simple, cookie-cutter template to get started
2 participants