mirror of https://github.com/titanscouting/tra-analysis.git synced 2024-11-09 22:44:44 +00:00

Titan Robotics 2022 Strategy Team Analysis Repository

data-analysis frc frc-scouting hacktoberfest python

Go to file

Arthur Lu 468bd48b07 fixed readme with proper pip installation Signed-off-by: Arthur Lu <learthurgo@gmail.com>		2020-08-11 01:36:30 +00:00
.devcontainer	modified README	2020-08-11 00:29:23 +00:00
.github	run on publish	2020-08-10 14:46:07 -05:00
analysis-master	removed old bins under analysis-master/dist/	2020-08-10 21:37:41 +00:00
data-analysis	readded old config files	2020-08-10 23:32:50 +00:00
.gitattributes	Initial commit	2018-11-06 21:56:51 -06:00
.gitignore	Merge branch 'master' into tra-service	2020-08-10 16:11:38 -05:00
CONTRIBUTING.md	Contributing guideline changes (#11 )	2020-05-13 11:56:52 -05:00
LICENSE	Update LICENSE	2020-05-13 12:04:59 -05:00
MAINTAINERS	Merge branch 'master' into tra-service	2020-08-10 16:11:38 -05:00
README.md	fixed readme with proper pip installation	2020-08-11 01:36:30 +00:00

README.md

Red Alliance Analysis ·

Titan Robotics 2022 Strategy Team Repository for Data Analysis Tools. Included with these tools are the backend data analysis engine formatted as a python package, associated binaries for the analysis package, and premade scripts that can be pulled directly from this repository and will integrate with other Red Alliance applications to quickly deploy FRC scouting tools.

Getting Started

Prerequisites

Python >= 3.6
Pip which can be installed by running
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python get-pip.py
after installing python, or with a package manager on linux. Refer to the pip installation instructions for more information.

Installing

Standard Platforms

For the latest version of tra-analysis, run pip install tra-analysis or pip install tra_analysis. The requirements for tra-analysis should be automatically installed.

Exotic Platforms (Android)

Termux is recommended for a linux environemnt on Android. Consult the documentation for advice on installing the prerequisites. After installing the prerequisites, the package should be installed normally with pip install tra-analysis or pip install tra_analysis.

Use

tra-analysis operates like any other python package. Consult the documentation for more information.

Supported Platforms

Although any modern 64 bit platform should be supported, the following platforms have been tested to be working:

AMD64 (Tested on Zen, Zen+, and Zen 2)
Intel 64/x86_64/x64 (Tested on Kaby Lake)
ARM64 (Tested on Broadcom BCM2836 SoC, Broadcom BCM2711 SoC)

The following OSes have been tested to be working:

Linux Kernel 3.16, 4.4, 4.15, 4.19, 5.4
- Ubuntu 16.04, 18.04, 20.04
- Debian (and Debian derivaives) Jessie, Buster
Windows 7, 10

The following python versions are supported:

python 3.6 (not tested)
python 3.7
python 3.8

Contributing

Read our included contributing guidelines (CONTRIBUTING.md) for more information and feel free to reach out to any current maintainer for more information.