Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document use of the code-submitter #654

Merged
merged 3 commits into from
Dec 23, 2024
Merged

Document use of the code-submitter #654

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a057f0a
Document use of the code-submitter
PeterJCLaw Dec 21, 2024
39fc2d4
Fix typo
PeterJCLaw Dec 21, 2024
f7b5515
Clarify the title
PeterJCLaw Dec 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _data/sidebar_tree.yaml
View file
Open in desktop
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: How to Submit Code
PeterJCLaw marked this conversation as resolved.
Show resolved Hide resolved
- url: /rules/
title: Rules
tree:
Expand Down
5 changes: 3 additions & 2 deletions robots_101/programme_structure.md
View file
Open in desktop
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
PeterJCLaw marked this conversation as resolved.
Show resolved Hide resolved
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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
layout: page
title: How to Submit Code
---

# How to Submit Code

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to give any information about how to make a zip archive? Even if that's something like "on windows, you can do this by selecting all the files you wish to include, right clicking, and selecting archive files"

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What level of competency do we assume? It might be good however I assume that we would then want to also include guides for Linux and MacOS?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about this, but opted not to for simplicity/speed ... and intended to leave a comment about it but then forgot. Very open to that being added, but felt this page was valuable enough without it and I'm not well placed right now to chase down exactly how to do this across platforms.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We typically provide info for Windows & MacOS. I think omitting Linux is probably ok (as Linux feels likely to only be personal devices and the plethora of desktop environments makes it harder anyway), though I do think we should start including Chromebooks (see #655).

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. More info can't hurt.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For clarity: I am still proposing that we aim to ship this PR without any platform walkthroughs and that we can add that later if/when needed.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy with that.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are instructions for this here: https://studentrobotics.org/docs/tutorials/getting_code_on_the_robot

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That isn't quite what we're after as we specifically are talking about instructions for creating a .zip folder

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]
ShadowLord2005 marked this conversation as resolved.
Show resolved Hide resolved
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/
ShadowLord2005 marked this conversation as resolved.
Show resolved Hide resolved
Loading