https://github.com/peterjclaw/srcomp-scorer
Scorer Tool for Student Robotics.
https://github.com/peterjclaw/srcomp-scorer
srcomp
Last synced: 3 months ago
JSON representation
Scorer Tool for Student Robotics.
- Host: GitHub
- URL: https://github.com/peterjclaw/srcomp-scorer
- Owner: PeterJCLaw
- Created: 2014-04-18T12:14:22.000Z (about 12 years ago)
- Default Branch: main
- Last Pushed: 2025-02-15T16:42:01.000Z (over 1 year ago)
- Last Synced: 2025-04-08T22:34:44.947Z (about 1 year ago)
- Topics: srcomp
- Language: Python
- Homepage: https://github.com/PeterJCLaw/srcomp/wiki/Component-Overview#srcomp-scorer
- Size: 233 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
SRComp Scorer
=============
|Build Status|
A web UI to edit scores from SRComp score files.
Deployment
----------
For using the scorer at an event:
.. code:: shell
script/install.sh
The install script prints instructions regarding the setup of the corresponding
compstate as well as how to run the resulting instance. Currently this is aimed
at install on a user's own machine rather than being hosted externally.
Publishing Scores
~~~~~~~~~~~~~~~~~
Scores are expected to be published using the SRComp CLI ``deploy`` command.
Typically this is arranged by having SSHD running on the machine at the
score-entry desk, allowing the person who deploys the scores to *pull* them onto
their own machine before both deploying them to the various compboxes and
pushing them to archival storage (typically GitHub).
From the perspective of the person deploying the scores these steps might look like:
.. code:: shell
git pull $SCORER_MACHINE master
git push
srcomp deploy .
ssh $SCORER_MACHINE 'cd compstate && git pull --ff-only'
This setup enables the person deploying the scores to optionally act as a
reviewer, perhaps by running the scorer on their own machine in order to view
the scores without relying on physical proximity to the score-entry desk.
Development
-----------
**Install**:
.. code:: shell
pip install -e .
**Run**:
``python -m sr.comp.scorer`` (see the ``--help``) for details.
Developers may wish to use the `SRComp Dev`_ repo to setup a dev instance.
.. |Build Status| image:: https://circleci.com/gh/PeterJCLaw/srcomp-scorer.png?branch=main
:target: https://circleci.com/gh/PeterJCLaw/srcomp-scorer
.. _`SRComp Dev`: https://github.com/PeterJCLaw/srcomp-dev