https://github.com/taubatexasrobotics/resources
Useful resources/modules from year to year
https://github.com/taubatexasrobotics/resources
first-robotics-competition frc pyfrc robot robotpy simulator
Last synced: 5 months ago
JSON representation
Useful resources/modules from year to year
- Host: GitHub
- URL: https://github.com/taubatexasrobotics/resources
- Owner: TaubatexasRobotics
- Created: 2022-02-01T03:09:31.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-29T19:21:03.000Z (over 2 years ago)
- Last Synced: 2025-01-20T06:13:58.500Z (over 1 year ago)
- Topics: first-robotics-competition, frc, pyfrc, robot, robotpy, simulator
- Language: Python
- Homepage:
- Size: 110 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Resources and test files/modules
### WARNING: These entire sections are intended for beginners (KISS). If you consider yourself more experienced, you may skip it.
This repository contains files separated by category. The file will depend on the type of test you would like to perform on the robot or directly on a third-party simulator.
## Setup & Installation
For more information about the setup of RobotPy's packages, click here.
### Prerequisites
After cloning the repository, the system must have Python 3 and pip installed on your computer.
#### Windows
The most common way to set up Python on Windows is to download it directly using the official Windows installer. It is recommended to avoid any restrictions related to administrator privileges and to ensure there are no character limitations in the `PATH`.
Additionally, verify that the Python 3 installation directory and pip are correctly added to the Windows `PATH` environment variable. You also could use Windows Subsystem for Linux and proceed with the Linux section on it.
#### Linux
Many Linux distributions use Python internally for system tools, scripts, and utilities. For this reason, it is strongly recommended to create and use a Python virtual environment (`venv`) to avoid conflicts with system packages.
```
python3 -m venv env
source env/bin/activate
```
As an (dangerous) alternative, you can use `--break-system-packages` inside your pip commands (not recommended).
### Installing packages
It is recommended to use `robotpy sync`, but you can use pip directly as an alternative.
### Windows
- Using pip command directly
```
py -3 -m pip install -r requirements.txt
```
- Sync to install/update 3rd party packages
```
py -3 -m robotpy sync
```
### Linux/macOS
- Using pip command directly
```
python3 -m pip install -r requirements.txt
```
- Sync to install/update 3rd party packages
```
python3 -m robotpy sync
```
## Testing code
For more information, click here.
Since 2024, you must need to initialize a RobotPy package to create a new `pyproject.toml` file.
### Windows
- Initialize a FRC Python project
```
py -3 -m robotpy init
```
- Executing Robot Simulator
```
py -3 -m robotpy sim
```
- Deploy to the robot
```
py -3 -m robotpy deploy
```
---
### Linux/macOS
- Initialize a FRC Python project
```
python3 -m robotpy init
```
- Executing Robot Simulator
```
python3 -m robotpy sim
```
- Deploy to the robot
```
python3 -m robotpy deploy
```
## Using Robot Simulator (Reminder highlighted in red)
### Do not forget to enable a robot state!
## Contributions
Please check out the RobotPy's porting guide for a variety of guidelines for new examples.