Contents: Background | Installation | Running | Contributing |
This repository uses PGA Shotlink Data to infer the ideal locations to hit golf shots on the PGA Tour. A user can select a tournament, and for each hole, analyse the shot distribution on a given hole that lead to a sub-, even-, or over-par score for all pin locations.
The data comes from a test set of PGA Shotlink data, from the GitHub repo pga-golf-data. This is added as a submodule in third-party. Ensure to initialise the submodules appropriately.
For this repository to function as intended, a few tools have been provided to ensure the application can be containerised and sent to the appropriate container repository.
The content of the Makefile should only be modified if the standard behaviour is not achieved using the default. Standard commands are as follows:
| Command | Dependencies | Action |
|---|---|---|
make run |
run |
Runs image for local development |
make build |
build |
Builds image |
docker-compose up --build |
docker-compose.yaml |
Builds and deploys images to run on designated server |
The scripts folder must maintain the following, which are indirectly run from the Makefile in the root directory. The build script is customizable per the application, but it must build a local image of the application which can be uploaded the container repository for use in the cluster pipeline. The run script is utilised for local development.
| Script | Inputs | Output |
|---|---|---|
| build.sh | NAME TAG | Application image is created locally, tagged with input args |
| run.sh | NAME TAG | Application image is run locally |
For now, use the docker-compose file to spin up the application and the nginx server. Run docker-compose up --build. The application is available at localhost, 127.0.0.1 on the local machine, or the IP address of the machine, if accessed from another computer on the network. nginx.conf needs to be configured appropriately.
For development, simply run make run and the development environment will start. To edit or run the notebook run jupyter notebook --allow-root. This will provide a link that you can copy into your browser.
In order to use the map plots, i.e., overlay shots on the course map, the user must add latitude and longitude information for 3 or more locations on the golf course.
It is recommended to use the centre of a green, and then use the method calibrate_green_loc from ShotDistribution. Pass in a list of greens that you want the average ShotLink coordiante for. Add this information to configs/course_coords.yml. Add by the appropriate tournament ID (NOT COURSE ID).
The guidelines for contributing are laid out here.
- Install Docker for creating a nice virtual container to run in.
- Install Docker Compose.
- See Running.
No untested code will be allowed to merge onto Master. A 90% coverage and test passing report is required for all Master PRs.
This library uses pytest for testing. To run the full test suite use the command pytest tests/ --cov=lib --cov-report=html.
Code style is handled and enforced with Black, Flake8 and some additional stylers and formatters. A pre-commit hook is provided with this repository so that all code is automatically kept consistent. If there are any issues with formatting, please submit a formal PR to this repository.
Docstrings will be formatted according to the Google docstring formatting, and as best as possible, styled as per the PEP 8 style guide.