Adding Docker for reproducable runs and standard python version. #9
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added running locally and with docker section to Readme Added requirements.txt, Added docker_run.sh script for docker build and run, Added standard .gitignore
|
#8 is related to this PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There is no indication about what version of python and numpy will be used to run the code. This can cause issues if someone is using 3.9 syntax and the tournament will run on 3.6. I suggest explicitly stating what version will be used. To help solve this any and many other issues that can arise with people running on different platforms (Windows/Mac/Linux) I have added a Dockerfile that can be used as a standard testing and running environment.
The Dockerfile uses python 3.9.5 (latest) and runs on Debian Buster. Docker can be run on every OS and should have reproducible results. This also avoids breaking people's systems by installing dependencies directly to their system python.
It is very easy to run all the test code. Simply add your .py file as you normally would, then run
./run.sh. The docker container will be built, and theprisonersDilemma.pyscript will be run in the correct directory. The results will be loaded to your local system in the expectedcode/results.txtfile.