Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 2.06 KB

README.md

File metadata and controls

64 lines (44 loc) · 2.06 KB

Spring 2022 CS170 Project Skeleton

Requirements

A Python skeleton is available in the python subdirectory. The Python skeleton was developed using Python 3.9, but it should work with Python versions 3.6+.

Usage

Generating instances

To generate instances, read through python/instance.py, which contains a dataclass (struct) that holds the data for an instance, as well as other relevant methods. Then modify the python/generate.py file by filling in the make_{small,medium,large}_instance functions.

After you have filled in those functions, you can run make generate in the python directory to generate instances into the input directory.

To run unit tests, run make check.

Solving

We've created a solver skeleton at python/solve.py.

The solver writes the solution to stdout. To write to a file, use your shell's stdout redirection:

python3 solve.py case.in --solver=naive > case.out

Visualizing Instances

To visualize problem instances, run python3 visualize.py, passing in the path to your .in file as the first argument (or - to read from standard input). To visualize a solution as well, pass in a .out file to the option --with-solution.

By default, the output visualization will be written as a SVG file to standard output. To redirect it to a file, use your shell's output redirection or pass in an output file as an additional argument.

For example, you could run

python3 visualize.py my_input.in out.svg

to create an out.svg file visualizing the my_input.in problem instance.

To visualize a solution file for this instance as well, you could run

python3 visualize.py my_input.in --with-solution my_soln.out out.svg

Other tooling

We may provide additional tooling, including a tool that calls a solver on all inputs in the inputs directory, and a tool that merges input directories, taking the best solutions. We may also provide a C++ skeleton.

If we release these, they will be released by the time that all inputs are released.