Skip to content

Commit

Permalink
Merge pull request #654 from srobo/code-submitter
Browse files Browse the repository at this point in the history
Document use of the code-submitter
  • Loading branch information
PeterJCLaw authored Dec 23, 2024
2 parents 675fefc + f7b5515 commit c21e6bb
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 2 deletions.
2 changes: 2 additions & 0 deletions _data/sidebar_tree.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ tree:
title: Updating your brain board
- url: /tutorials/discord
title: How to use Discord
- url: /tutorials/code_submitter
title: Using the Code Submitter
- url: /rules/
title: Rules
tree:
Expand Down
5 changes: 3 additions & 2 deletions robots_101/programme_structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ as volunteers able to help with the kits and hands-on guidance with your robot.

## Virtual League

The Virtual League is often the first change you'll have to test your
strategies against other teams. You'll submit your robot code for running
The Virtual League is often the first chance you'll have to test your strategies
against other teams. You'll [submit][code-submitter] your robot code for running
against other teams in the [simulator][simulator]. The matches are livestreamed
on our [YouTube Channel][youtube] and you'll get a copy of your robot's logs
afterwards so you can continue to improve it.
Expand Down Expand Up @@ -100,5 +100,6 @@ afternoon you'll advance into the knockout stages, and can go on to win prizes.
[kit]: {{ site.baseurl }}/kit/
[discord]: {{ site.baseurl }}/tutorials/discord
[tech-days]: {{ site.baseurl }}/robots_101/tech_days
[code-submitter]: {{ site.baseurl }}/tutorials/code_submitter
[simulator]: {{ site.baseurl }}/simulator/
[youtube]: https://www.youtube.com/@studentrobotics
27 changes: 27 additions & 0 deletions tutorials/code_submitter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
layout: page
title: Using the Code Submitter
---

# Using the Code Submitter

For virtual aspects of the competition, such as the [Virtual League][virtual-league], you will submit your code using the [code-submitter][code-submitter].
Your code will then be run alongside other teams' code in the [simulator][simulator].

To prepare your code for upload, you should create a zip archive containing all the code you want to submit.
As with running the code in the simulator locally or on your robot, this must include a file named _exactly_ **`robot.py`**, placed in the root of the archive (not within a subfolder).
You can also provide other files as well and use them from your `robot.py` file, however the code-submitter will always look for a `robot.py` file as that is what the simulator will run.

Once you have prepared the archive containing your code:

1. Visit the [Code Submitter][code-submitter]
1. Log in using:
* your team's TLA as the username, in UPPERCASE\
(your team's channel in Discord is named like `#team-tla`)
* the same password as you used to get access to your team's area in Discord\
(check with your supervisor if you're not sure what this is)
1. Upload the archive to the Code Submitter

[virtual-league]: {{ site.baseurl }}/robots_101/programme_structure#virtual-league
[simulator]: {{ site.baseurl }}/simulator/
[code-submitter]: https://studentrobotics.org/code-submitter/

0 comments on commit c21e6bb

Please sign in to comment.