-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #71 from pr3d4t0r/00070-ssscore-CLI
00070 ssscore cli
- Loading branch information
Showing
12 changed files
with
921 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,111 @@ | ||
.\" Automatically generated by Pandoc 3.1.3 | ||
.\" | ||
.\" Define V font for inline verbatim, using C font in formats | ||
.\" that render this, and otherwise B font. | ||
.ie "\f[CB]x\f[]"x" \{\ | ||
. ftr V B | ||
. ftr VI BI | ||
. ftr VB B | ||
. ftr VBI BI | ||
.\} | ||
.el \{\ | ||
. ftr V CR | ||
. ftr VI CI | ||
. ftr VB CB | ||
. ftr VBI CBI | ||
.\} | ||
.TH "ssscore" "1" "" "Version 1.8.2" "Speed Skydiving Scoring command line tool" | ||
.hy | ||
.SH NAME | ||
.PP | ||
\f[B]sscore\f[R] - Speed Skydiving Scoring tool for processing spped | ||
dive FlySight files | ||
.SH SYNOPSIS | ||
.IP | ||
.nf | ||
\f[C] | ||
pip install -U ssscoring | ||
\f[R] | ||
.fi | ||
.PP | ||
\f[V]ssscore\f[R] will be located in either of these paths: | ||
.IP \[bu] 2 | ||
\f[V]$VIRTUAL_ENV/bin/ssscore\f[R] | ||
.IP \[bu] 2 | ||
\f[V]/usr/local/bin/ssscore\f[R] | ||
.PP | ||
Command after installation: | ||
.IP | ||
.nf | ||
\f[C] | ||
ssscore datalake | ||
\f[R] | ||
.fi | ||
.PP | ||
Where \f[V]datalake\f[R] is a directory containing one or more speed | ||
skydiving tracks, either in the topmost level or nested. | ||
\f[V]ssscore\f[R] ignores all files present in the data lake that | ||
aren\[cq]t speed skydives, even if they are FlySight-compatible CSV | ||
files. | ||
.PP | ||
Examples: | ||
.PP | ||
Scores all of Joe\[cq]s files in his speed skydiving directory: | ||
.IP | ||
.nf | ||
\f[C] | ||
ssscore /Users/joe/speed-skydiving/tracks | ||
\f[R] | ||
.fi | ||
.PP | ||
Score all the files present in the FlySight device mounted at | ||
\f[V]/mnt\f[R]: | ||
.IP | ||
.nf | ||
\f[C] | ||
mount /dev/sda1 /mnt/FLYSIGHT1 | ||
ssscore /mnt/FLYSIGHT1 | ||
umount /mnt/FLYSIGHT1 | ||
\f[R] | ||
.fi | ||
.SH DESCRIPTION | ||
.PP | ||
\f[V]ssscore\f[R] processes speed skydiving FlySight files in bulk. | ||
Track files can be in versions 1 or 2, or even in SkyTrax format. | ||
The program scores files according to the International Skydiving | ||
Commission, the International Speed Skydiving Association, and the | ||
United States Parachute Association scoring and competition rules. | ||
.PP | ||
\f[V]ssscore\f[R] writes only to stdout. | ||
It\[cq]s output may be redicrected or piped as required. | ||
.SH ARGUMENTS | ||
.PP | ||
\f[V]datalake\f[R] is a directory containing one or more speed skydiving | ||
tracks, either at the topmost level or nested. | ||
\f[V]ssscore\f[R] ignores all files present in the data lake that | ||
aren\[cq]t speed skydives, even if they are FlySight-compatible CSV | ||
files. | ||
.PP | ||
The man page or README.md file for the SSScoring API have a longer | ||
description of what a data lake is and how \f[V]ssscore\f[R] treats it. | ||
.SH OOPTIONS | ||
.PP | ||
None. | ||
.SH FILES | ||
.PP | ||
/usr/local/bin/ssscore if installed via \f[V]pip\f[R] to the derault | ||
Python run-time $VIRTUAL_ENV/bin/ssscore if installed to an active | ||
virtual environment | ||
.SH BUGS AND NOTES | ||
.PP | ||
None. | ||
.SH SEE ALSO | ||
.PP | ||
ssscoring(3) | ||
.PP | ||
Project: https://github.com/pr3d4t0r/SSScoring | ||
.SH LICENSE | ||
.PP | ||
The \f[B]SSScoring\f[R] package, documentation and examples are licensed | ||
under the BSD-3 open source | ||
license (https://github.com/pr3d4t0r/SSScoring/blob/master/LICENSE.txt). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
% ssscore(1) Version 1.8.2 | Speed Skydiving Scoring command line tool | ||
|
||
NAME | ||
==== | ||
|
||
**sscore** - Speed Skydiving Scoring tool for processing spped dive FlySight | ||
files | ||
|
||
|
||
SYNOPSIS | ||
======== | ||
```bash | ||
pip install -U ssscoring | ||
``` | ||
|
||
`ssscore` will be located in either of these paths: | ||
|
||
- `$VIRTUAL_ENV/bin/ssscore` | ||
- `/usr/local/bin/ssscore` | ||
|
||
Command after installation: | ||
|
||
```bash | ||
ssscore datalake | ||
``` | ||
|
||
Where `datalake` is a directory containing one or more speed skydiving tracks, | ||
either in the topmost level or nested. `ssscore` ignores all files present in | ||
the data lake that aren't speed skydives, even if they are FlySight-compatible | ||
CSV files. | ||
|
||
Examples: | ||
|
||
Scores all of Joe's files in his speed skydiving directory: | ||
|
||
```bash | ||
ssscore /Users/joe/speed-skydiving/tracks | ||
``` | ||
|
||
Score all the files present in the FlySight device mounted at `/mnt`: | ||
|
||
```bash | ||
mount /dev/sda1 /mnt/FLYSIGHT1 | ||
ssscore /mnt/FLYSIGHT1 | ||
umount /mnt/FLYSIGHT1 | ||
``` | ||
|
||
|
||
DESCRIPTION | ||
=========== | ||
`ssscore` processes speed skydiving FlySight files in bulk. Track files can | ||
be in versions 1 or 2, or even in SkyTrax format. The program scores files | ||
according to the International Skydiving Commission, the International Speed | ||
Skydiving Association, and the United States Parachute Association scoring and | ||
competition rules. | ||
|
||
`ssscore` writes only to stdout. It's output may be redicrected or piped as | ||
required. | ||
|
||
|
||
ARGUMENTS | ||
========= | ||
`datalake` is a directory containing one or more speed skydiving tracks, | ||
either at the topmost level or nested. `ssscore` ignores all files present in | ||
the data lake that aren't speed skydives, even if they are FlySight-compatible | ||
CSV files. | ||
|
||
The man page or README.md file for the SSScoring API have a longer description | ||
of what a data lake is and how `ssscore` treats it. | ||
|
||
|
||
OOPTIONS | ||
======== | ||
None. | ||
|
||
|
||
FILES | ||
===== | ||
/usr/local/bin/ssscore if installed via `pip` to the derault Python run-time | ||
$VIRTUAL_ENV/bin/ssscore if installed to an active virtual environment | ||
|
||
|
||
BUGS AND NOTES | ||
============== | ||
None. | ||
|
||
|
||
SEE ALSO | ||
======== | ||
ssscoring(3) | ||
|
||
Project: https://github.com/pr3d4t0r/SSScoring | ||
|
||
|
||
LICENSE | ||
======= | ||
The **SSScoring** package, documentation and examples are licensed under the | ||
[BSD-3 open source license](https://github.com/pr3d4t0r/SSScoring/blob/master/LICENSE.txt). | ||
|
Oops, something went wrong.