CLI tool for creating sio2 task packages
Project description
sinol-make
sinol-make is a CLI tool for creating and verifying problem packages
for sio2
with features such as:
- measuring time and memory in the same deterministic way as sio2,
- running the solutions in parallel,
- keeping a git-friendly report of solutions' scores,
- catching mistakes in the problem packages as early as possible,
- and more.
Contents
Why?
The purpose of the tool is to make it easier to create good problem packages
for official competitions, which requires collaboration with other people
and using a multitude of "good practices" recommendations.
While there are several excellent CLI tools for creating tests and solutions,
they lack some built-in mechanisms for verifying packages and finding mistakes
before uploading the package to the judge system.
As sinol-make was created specifically for the sio2 problem packages,
by default it downloads and uses sio2's deterministic mechanism of measuring
solutions' runtime, called oiejq.
Installation
It's possible to directly install sinol-make through Python's package manager pip, which usually is installed alongside Python:
pip3 install sinol-make
pip installs the sinol-make executable in ~/.local/bin/ directory,
so make sure this directory is in your PATH.
Here's how to add a directory to PATH.
As oiejq works only on Linux-based operating systems,
we do not recommend using operating systems such as Windows or macOS.
Nevertheless sinol-make supports those operating systems,
though there are additional installation steps required to use
other tools for measuring time (which are non-deterministic and produce reports different from sio2):
- Debian-based systems (Ubuntu, usually Windows WSL):
apt install time - Arch-based systems:
pacman -S time - macOS:
brew install gnu-time coreutils
Autocompletion (optional)
If you would like to have autocompletion for sinol-make commands,
run the following command and refresh the shell (e.g. by opening a new terminal):
activate-global-python-argcomplete
Usage
The availabe commands (see sinol-make --help) are:
sinol-make run-- Runs selected solutions (by default all solutions) on selected tests (by default all tests) with a given number of CPUs. Measures the solutions' time with oiejq, unless specified otherwise. After running the solutions, it compares the solutions' scores with the ones saved in config.yml. If you're using oiejq, make sure you are not running on efficiency cpu cores. You can check if you have them like this. To run on normal cpu cores, usetaskset -c 8-15 sinol-make ..., assuming that cpu cores 8-15 are not efficiency cores. Runsinol-make run --helpto see available flags.sinol-make gen-- Generate input files using ingen program (for example prog/abcingen.cpp for abc task). Whenever the new input differs from the previous one, the model solution will be used to generate the new output file. You can also specify your ingen source file which will be used. Runsinol-make gen --helpto see available flags.sinol-make ingen-- Generate input files using ingen program (for example prog/abcingen.cpp for abc task). You can also specify your ingen source file which will be used. Runsinol-make ingen --helpto see available flags.sinol-make outgen-- Generate output files using the model solutions. Runsinol-make outgen --helpto see available flags.sinol-make inwer-- Verifies whether input files are correct using your "inwer.cpp" program. You can specify what inwer program to use, what tests to check and how many CPUs to use. Runsinol-make inwer --helpto see available flags.sinol-make export-- Creates archive ready to upload to sio2 or szkopul. Runsinol-make export --helpto see all available flags.sinol-make doc-- Compiles all LaTeX files in doc/ directory to PDF. Runsinol-make doc --helpto see all available flags.sinol-make verify-- Verifies the package. This command runs stress tests (if available), verifies the config, generates tests, generates problem statements, runs inwer and run all solutions. Ingen and inwer are compiled with address and UB sanitizers. Runsinol-make verify --helpto see all available flags.sinol-make init [id]-- Creates package from template on github and sets task id to provided[id]. Requires an internet connection to run.
You can also run multiple commands at once, for example:
sinol-make gen prog/abcingen2.cpp inwer --cpus 4 run --tests abc1*.in doc export --no-statement
Reporting bugs and contributing code
- Want to report a bug or request a feature? Open an issue.
- Want to help us build
sinol-make? Create a Pull Request and we will gladly review it.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sinol_make-1.6.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2bb1d49f120726189e07521013ce7f66964d1b4d4e561e98822fc6f40591e480 |
|
| MD5 | 1af74bd68cd14c0d56d40c02679a5356 |
|
| BLAKE2b-256 | 26e07900f8531b120507825c500b4146fb1f374eab9accfc7c3ee9cbc413ad4b |
