Difference between revisions of "Contest Data Package"

From PC2wiki
Jump to: navigation, search
m (runs.properties file: moved section into its own article)
m (Layout / Structure: restructured into input and output files)
Line 93: Line 93:
 
=Layout / Structure=
 
=Layout / Structure=
  
==config/==
+
==Input Files==
 +
 
 +
These are files that are input/configuration files for a contest.
 +
 
 +
===config/===
  
 
Contains configuration (input) files to configure a CCS (pc2).
 
Contains configuration (input) files to configure a CCS (pc2).
 
  
 
* [[contest.yaml]]
 
* [[contest.yaml]]
Line 107: Line 110:
 
* [[userdata.tsv]]
 
* [[userdata.tsv]]
  
==images/logos/==
+
===images/logos/===
  
 
* contains 600x600 images of each team's logo, in logo<x>.png format.
 
* contains 600x600 images of each team's logo, in logo<x>.png format.
  
==images/teams/==
+
===images/teams/===
 
* contains 1920x1080 images of each team, in team<x>.jpg format.
 
* contains 1920x1080 images of each team, in team<x>.jpg format.
  
==submissions/==
+
==Output Files==
 +
 
 +
These are files that are output from a contest.
 +
 
 +
===submissions/===
 +
 
 
* contains a folder for each submission
 
* contains a folder for each submission
  
==submissions/##==
+
===submissions/##===
  
 
* contains run source file
 
* contains run source file
Line 123: Line 131:
 
* contains run.properties file (see below for contents)
 
* contains run.properties file (see below for contents)
  
==eventFeed/==
+
===eventFeed/===
  
 
* contains a finalized event feed events.xml.
 
* contains a finalized event feed events.xml.
Line 129: Line 137:
 
- may contain other files in the format "<x>-events.xml", e.g. "pc2-events.xml".
 
- may contain other files in the format "<x>-events.xml", e.g. "pc2-events.xml".
  
==results/==
+
===results/===
  
 
* contains results.tsv and other output files from the CCS.
 
* contains results.tsv and other output files from the CCS.
  
==results/<CCS>==
+
===results/<CCS>===
 
* contain CCS specific results files, ex. reports, ex results/pc2
 
* contain CCS specific results files, ex. reports, ex results/pc2
  
==video/reactions/==
+
===video/reactions/===
 
* contains recorded reaction videos for each submission, in reaction<X>.m2ts format.
 
* contains recorded reaction videos for each submission, in reaction<X>.m2ts format.
  
==backups/==
+
===backups/===
 
* contains a final backups of each team's working folder in the form team<X>.tar.gz.
 
* contains a final backups of each team's working folder in the form team<X>.tar.gz.
 
  
 
=File Formats=
 
=File Formats=

Revision as of 20:11, 6 November 2014

A contest data package (CDP) is a description of files/directories that are input and output from a contest.

Introduction

This standard contains a description of the organization of contest data. Both the data that is input to the contest and the results of the contest.

Here are two example of the standard.

To learn how pc2 imports and exports the data see the Import/Export section below.

Sample One

config/hello/problem.yaml
config/hello/data/secret/hello.ans
config/hello/data/secret/hello.in
config/hello/data/problem_statement/problem.tex
config/teams.tsv
config/sumit/problem.yaml
config/sumit/data/secret/sumit.in
config/sumit/data/secret/sumit.ans
config/sumit/data/problem_statement/problem.tex
config/contest.yaml
config/problemset.yaml
config/groups.tsv
config/userdata.tsv

submissions/1/A.java
submissions/3/C.java
submissions/3/A.java
submissions/2/A.java

results/runs.tsv
results/scoreboard.tsv
results/results.tsv
backups/team1.tar.gz
backups/team2.tar.gz
backups/team3.tar.gz
video/reactions/reaction3.m2ts
video/reactions/reaction1.m2ts
video/reactions/reaction2.m2ts
images/teams/team3.jpg
images/teams/team2.jpg
images/teams/team1.jpg
images/logos/logo1.png
images/logos/logo3.png
images/logos/logo2.png

eventFeed/eventfeed.json
eventFeed/eventfeed.xml

Sample Two

backups/team1.tar.gz
backups/team2.tar.gz
backups/team3.tar.gz
config/contest.yaml
config/groups.tsv
config/problemset.yaml
config/teams.tsv
config/userdata.tsv
config/hello/problem.yaml
config/hello/data/problem_statement/problem.tex
config/hello/data/secret/hello.ans
config/hello/data/secret/hello.in
config/sumit/data/problem_statement/problem.tex
config/sumit/data/secret/sumit.ans
config/sumit/data/secret/sumit.in
config/sumit/problem.yaml
eventFeed/events.json
eventFeed/events.xml
images/logos/logo1.png
images/logos/logo2.png
images/logos/logo3.png
images/teams/team1.jpg
images/teams/team2.jpg
images/teams/team3.jpg
results/results.tsv
results/runs.tsv
results/scoreboard.tsv
submissions/1/run.properties
submissions/1/A.java
submissions/2/A.java
submissions/2/run.properties
submissions/3/run.properties
submissions/3/A.java
submissions/3/C.java
video/reactions/reaction1.m2ts
video/reactions/reaction2.m2ts
video/reactions/reaction3.m2ts

Layout / Structure

Input Files

These are files that are input/configuration files for a contest.

config/

Contains configuration (input) files to configure a CCS (pc2).

images/logos/

  • contains 600x600 images of each team's logo, in logo<x>.png format.

images/teams/

  • contains 1920x1080 images of each team, in team<x>.jpg format.

Output Files

These are files that are output from a contest.

submissions/

  • contains a folder for each submission

submissions/##

  • contains run source file
  • contains run.properties file (see below for contents)

eventFeed/

  • contains a finalized event feed events.xml.

- may contain other files in the format "<x>-events.xml", e.g. "pc2-events.xml".

results/

  • contains results.tsv and other output files from the CCS.

results/<CCS>

  • contain CCS specific results files, ex. reports, ex results/pc2

video/reactions/

  • contains recorded reaction videos for each submission, in reaction<X>.m2ts format.

backups/

  • contains a final backups of each team's working folder in the form team<X>.tar.gz.

File Formats

PC² Import/Export

For each file or set of files, click on the link to learn how to import / export from PC². The articles also describe the contents of the files.

Notes

To start/configure a contest the only required folder is config/. A contest archive with only config/ is only useful for loading into a CCS to start configuring a contest.

Once the contest is complete, the final event feed and submission files should be added back into the archive.

Other content is added as available, e.g. some contests will have backups, reaction videos, or logos, and others won't.

See Also