Skip to content

Commit

Permalink
{Documentation} VRS Tools
Browse files Browse the repository at this point in the history
Summary:
- Add a page on VRSPlayer
- Show how to install the VRS tools

Reviewed By: nickcharron

Differential Revision: D63327930

fbshipit-source-id: d0fb0d4507472681fda7c3f78867674805da594c
  • Loading branch information
SeaOtocinclus authored and facebook-github-bot committed Sep 24, 2024
1 parent ba9f157 commit 6beb665
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 0 deletions.
4 changes: 4 additions & 0 deletions website/docs/data_formats/aria_vrs/aria_vrs_command_line.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,7 @@ vrs copy original.vrs --to new.vrs --range 149002622 158702622
:::Note
For more in-depth details feel free to explore this [VRS Cli Tool page](https://facebookresearch.github.io/vrs/docs/VrsCliTool).
:::

## VRS tools installation

Please follow our [VRS Tools installation guide](aria_vrs_tools_installation.mdx)
26 changes: 26 additions & 0 deletions website/docs/data_formats/aria_vrs/aria_vrs_tools_installation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
sidebar_position: 50
title: VRS Tools installation
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

`VRS Tools` can easily be installed on your system using our prepackaged versions.

<Tabs groupId="package-manager">
<TabItem value="conda" label="Conda">
```bash
# conda https://conda.io/projects/conda/en/latest/user-guide/install/index.html
conda install vrs
```
</TabItem>
<TabItem value="pixi" label="Pixi">
```bash
# Pixi https://prefix.dev/
# Local install
pixi add vrs
# Global install
# pixi global install vrs
```
</TabItem>
</Tabs>
22 changes: 22 additions & 0 deletions website/docs/data_formats/aria_vrs/aria_vrsplayer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_position: 40
title: VRSPlayer
---

import Link from '@docusaurus/Link';

# The VRSPlayer App

The `vrsplayer` application lets you "play" a VRS like a multi-stream video, with audio if an audio stream is present.

![vrsplayer](/img/data_formats/aria_vrs/vrs_player_preview.png)

## Open a file

You can either play a file from the `File menu`, or using the command line `vrsplayer sample_file.vrs`.

If you want to know more about VRSPlayer, please visit the [VRSPlayer VRS's documentation page](https://facebookresearch.github.io/vrs/docs/vrsplayer).

## VRS tools installation

Please follow our [VRS Tools installation guide](aria_vrs_tools_installation.mdx)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6beb665

Please sign in to comment.