-
Notifications
You must be signed in to change notification settings - Fork 665
docs(install): fix required system libs, replay size, and library-ins… #2320
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
72a87bd
369b782
fb3fae7
9851f9e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,10 +4,12 @@ | |
| # install homebrew | ||
| /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" | ||
| # install dependencies | ||
| brew install gnu-sed gcc portaudio git-lfs libjpeg-turbo python pre-commit | ||
| brew install gnu-sed gcc portaudio git-lfs libjpeg-turbo python | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why drop pre-commit?
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. in both os install instructions pre-commit is used if using as a git-checkout |
||
|
|
||
| # install uv | ||
| curl -LsSf https://astral.sh/uv/install.sh | sh && export PATH="$HOME/.local/bin:$PATH" | ||
| # NOTE: the `export` above only affects the current shell. Open a new terminal so `uv` is on | ||
| # PATH in later sessions — the installer adds it to your shell profile (e.g. ~/.zprofile). | ||
| ``` | ||
|
|
||
| ## Using DimOS as a library | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,10 +2,20 @@ | |
|
|
||
| ```sh skip | ||
| sudo apt-get update | ||
| sudo apt-get install -y curl g++ portaudio19-dev git-lfs libturbojpeg python3-dev pre-commit | ||
| # Required system libraries. libturbojpeg + portaudio19-dev cover image/audio; libgl1 + | ||
| # libegl1 are the OpenGL runtime for open3d and rerun-sdk (both always-installed core deps). | ||
| # Without libgl1/libegl1 the visualizer fails at runtime with | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why all these comments? |
||
| # "libGL.so.1: cannot open shared object file" (e.g. on minimal/headless/Docker installs). | ||
| sudo apt-get install -y curl g++ portaudio19-dev git-lfs libturbojpeg libgl1 libegl1 python3-dev | ||
|
|
||
| # optional: graphviz enables blueprint-graph visualization. Without it dimos logs | ||
| # "graphviz not found, skipping blueprint graph" at startup (everything else still works). | ||
| # sudo apt-get install -y graphviz | ||
|
|
||
| # install uv | ||
| curl -LsSf https://astral.sh/uv/install.sh | sh && export PATH="$HOME/.local/bin:$PATH" | ||
| # NOTE: the `export` above only affects the current shell. Open a new terminal (or run | ||
| # `source ~/.bashrc`) so `uv` is on PATH in later sessions — the installer also adds it there. | ||
| ``` | ||
|
|
||
| ## Using DimOS as a library | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Dreamsorcerer if we put this key as required config value for a module, will we be able to auto-crash? not to have a special case here