Skip to content

Commit

Permalink
docs(installation): add minimum hardware requirements (#137)
Browse files Browse the repository at this point in the history
* docs: update troubleshooting guide (#107)

* docs: update troubleshooting guide

Signed off by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

* ci(pre-commit): autofix

* Removed TOC and updated the setup section title

* Update docs/support/troubleshooting.md

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>

* Update docs/support/troubleshooting.md

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>

* Update docs/support/troubleshooting.md

Add swap configuration steps

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>

* ci(pre-commit): autofix

* fix code blocks

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>

* Create troubleshooting.md

Reworded the CUDA warning to specify the supported version, fixed the code block for the swap config steps and added the Digital Ocean link back in.

* ci(pre-commit): autofix

* Update docs/support/troubleshooting.md

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>

* Update docs/support/troubleshooting.md

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(installation): update installation pages (#104)

* docs: rename developper settings

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* ci(pre-commit): autofix

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* fix: link

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* fix

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* docs(autoware-interfaces): add autoware interface design (#69)

* docs(autoware-interfaces): add autoware interface design

Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>

* docs(autoware-interfaces): remove version from api name

Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>

* docs(autoware-interfaces): mention the local interface

Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>
Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* fix: url

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* fix: rm duplication

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: rm old ref

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: edit name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: lead to support

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* rm duplication

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* ci(pre-commit): autofix

* chore: fix wording

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix link

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: rename

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Takagi, Isamu <43976882+isamu-takagi@users.noreply.github.com>
Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* fix(support): remove dead link (#116)

* fix(support): remove dead link

Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>

* Update docs/support/troubleshooting.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

* Update troubleshooting.md

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>
Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* feat: add integrate autoware with your vehicle (#109)

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* chore: sync files (#106)

Signed-off-by: GitHub <noreply@github.com>

Co-authored-by: kenji-miyake <kenji-miyake@users.noreply.github.com>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs: fix dead link in how-to-guides (#121)

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

Co-authored-by: Shark Liu <huiyuan.liu@autocore.ai>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(installation): add arm64 docker installation (#120)

* add arm64 docker installation

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* ci(pre-commit): autofix

* docs: remove the -arm64 tag from image tag

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* ci(pre-commit): autofix

* Update docs/installation/autoware/docker-installation.md

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>

* Update docs/installation/autoware/docker-installation.md

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>

Co-authored-by: Shark Liu <huiyuan.liu@autocore.ai>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(tutorial): ss2 instructions (#118)

* Update and rename rosbag-replay-simulation.md to Installation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Rename Installation.md to installation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update and rename digital-twin-simulation.md to scenario-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update and rename planning-simulation.md to random-test-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update and rename scenario-simulation.md to scenario-test-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update .pages

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update random-test-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update scenario-test-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* ci(pre-commit): autofix

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update random-test-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* ci(pre-commit): autofix

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update scenario-test-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update random-test-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Add files via upload

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update random-test-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update scenario-test-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update docs/tutorials/scenario-simulation/random-test-simulation.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update docs/tutorials/scenario-simulation/scenario-test-simulation.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* ci(pre-commit): autofix

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update docs/tutorials/scenario-simulation/random-test-simulation.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update docs/tutorials/scenario-simulation/scenario-test-simulation.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update docs/tutorials/scenario-simulation/random-test-simulation.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Create rosbag-replay-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Create digital-twin-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update .pages

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* changed structure of files

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update installation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update installation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* ci(pre-commit): autofix

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* fix .pages

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* move images

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update installation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update scenario-test-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update random-test-simulation.md

Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update docs/tutorials/scenario-simulation/planning-simulation/random-test-simulation.md

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>
Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

* Update docs/tutorials/scenario-simulation/planning-simulation/scenario-test-simulation.md

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>
Signed-off-by: Wojciech Jaworski <wojciech.jaworski@robotec.ai>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Co-authored-by: Kenji Miyake <kenji.miyake@tier4.jp>
Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* ci(pre-commit): autoupdate (#122)

updates:
- [github.com/scop/pre-commit-shfmt: v3.4.3-1 → v3.5.0-1](scop/pre-commit-shfmt@v3.4.3-1...v3.5.0-1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(components): add vehicle dimensions page (#79)

Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs: replace "ROS2" with "ROS 2" (#133)

* docs: replace "ROS2" with "ROS 2"

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>

* fix invalid links

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* Perf: Add Ubuntu 2204 and ROS in prerequisites

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs: add minimum hardware requirments

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(installation): fix styles

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* ci(pre-commit): autofix

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(installation): fix style

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(installation): fix typo

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(concepts): add explanation of Core/Universe from AI and Auto (#132)

* docs(concepts): add explanation of Core/Universe from AI and Auto

Signed-off-by: mitsudome-r <ryohsuke.mitsudome@tier4.jp>

* ci(pre-commit): autofix

* docs: fix from spell-check

Signed-off-by: mitsudome-r <ryohsuke.mitsudome@tier4.jp>

* docs: apply suggested change

Signed-off-by: mitsudome-r <ryohsuke.mitsudome@tier4.jp>

* ci(pre-commit): autofix

* Fix warning admonition code block

Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>

* Fix bullet points in issues list

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>

* Update description of Autoware.AI

Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>

* Update description of issues with Autoware.AI development

Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>

* ci(pre-commit): autofix

* Update Autoware.Auto descripiton to match Autoware.AI

Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>

* Update Autoware.Auto description

Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>

* docs(concepts): apply suggeted changes

Signed-off-by: mitsudome-r <ryohsuke.mitsudome@tier4.jp>

* ci(pre-commit): autofix

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(how-to guides): add runninng Autoware without CUDA (#128)

* added files

Signed-off-by: kminoda <koji.m.minoda@gmail.com>

* ci(pre-commit): autofix

* reflected reviews

Signed-off-by: kminoda <koji.m.minoda@gmail.com>

* ci(pre-commit): autofix

* added concrete configurations for object detection

Signed-off-by: kminoda <koji.m.minoda@gmail.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(how-to guides): how to integrate differential drive vehicles (#125)

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(design): add autoware design overview (#86)

* docs(design): add autoware design

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* update .pages

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* update

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* update

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* update

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* add warning

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* rename directories

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* update

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* update

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* update

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* update

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* update

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* update

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* update

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(tutorials): update tutorials main page (#124)

* docs(tutorials): rename tutorials section

Renaming "Tutorials" section to "Simulation tutorials"

Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

* Revert folder and filename changes

Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

* Update contents of tutorials/index.md

Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

* ci(pre-commit): autofix

* Update note about traffic light handling with the Planning Simulator

Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

* Add what localization and perception modules do

* ci(pre-commit): autofix

* Update docs/tutorials/index.md

Add details about rosbag replay simulation

Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

* ci(pre-commit): autofix

* Spelling fix

Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

* Fix planning simulator descriptin

Removed note about traffic light handling and moved this to the main description.

Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Takeshi Ishita <ishitah.takeshi@gmail.com>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs: fix styles (#139)

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* feat: update planning architecture document (#135)

* feat: update planning architecture document

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* fix typo

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* pre-commit

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* fix link

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* fix link

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

* update

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* ci(pre-commit): autofix

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* ci(pre-commit): autofix

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* Perf: Add Ubuntu 2204 and ROS in prerequisites

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* ci(pre-commit): autofix

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(installation): fix style

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs(installation): fix typo

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* docs: fix styles (#139)

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* ci(pre-commit): autofix

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* Update docs/installation/autoware/source-installation.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

* ci(pre-commit): autofix

Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>
Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>
Co-authored-by: Takagi, Isamu <43976882+isamu-takagi@users.noreply.github.com>
Co-authored-by: kminoda <44218668+kminoda@users.noreply.github.com>
Co-authored-by: awf-autoware-bot[bot] <94889083+awf-autoware-bot[bot]@users.noreply.github.com>
Co-authored-by: kenji-miyake <kenji-miyake@users.noreply.github.com>
Co-authored-by: Shark Liu <huiyuan.liu@autocore.ai>
Co-authored-by: Wojciech Jaworski <85557834+WJaworskiRobotec@users.noreply.github.com>
Co-authored-by: Kenji Miyake <kenji.miyake@tier4.jp>
Co-authored-by: M. Fatih Cırıt <xmfcx@users.noreply.github.com>
Co-authored-by: Ryohsuke Mitsudome <43976834+mitsudome-r@users.noreply.github.com>
Co-authored-by: Takamasa Horibe <horibe.takamasa@gmail.com>
Co-authored-by: Takeshi Ishita <ishitah.takeshi@gmail.com>
  • Loading branch information
16 people authored Jun 7, 2022
1 parent d66062d commit 1347743
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 5 deletions.
13 changes: 12 additions & 1 deletion docs/installation/autoware/source-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,18 @@

## Prerequisites

- [Ubuntu 20.04](https://releases.ubuntu.com/20.04/)
- OS

- [Ubuntu 20.04](https://releases.ubuntu.com/20.04/)
- [Ubuntu 22.04](https://releases.ubuntu.com/22.04/) (**will be supported from Q3 2022**)

- ROS

- ROS 2 Galactic
- ROS 2 Humble (**will be supported from Q3 2022**)

For ROS 2 system dependencies, refer to [REP-2000](https://www.ros.org/reps/rep-2000.html) .

- [Git](https://git-scm.com/)
- [Registering SSH keys to GitHub](https://github.com/settings/keys) is preferable.

Expand Down
21 changes: 17 additions & 4 deletions docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,25 @@ The Autoware Foundation provides no support on other platforms than those listed
- amd64
- arm64

### ROS version
### Minimum hardware requirements

- ROS 2 Galactic (**active development**)
- ROS 2 Humble (**will be supported in 2022**)
!!! info

For the system dependencies, refer to [REP-2000](https://www.ros.org/reps/rep-2000.html).
Autoware is scalable and can be customized to work with distributed or less powerful hardware.
The minimum hardware requirements given below are just a general recommendation.
However, performance will be improved with more cores, RAM and a higher-spec graphics card or GPU core.

- CPU with 8 cores
- 16GB RAM
- [Optional] NVIDIA GPU (4GB RAM)

> Although GPU is not required to run basic functionality, it is mandatory to enable the following neural network related functions:
>
> - LiDAR based object detection
> - Camera based object detection
> - Traffic light detection and classification
For details of how to enable object detection and traffic light detection/classification without a GPU, refer to the [Running Autoware without CUDA](https://autowarefoundation.github.io/autoware-documentation/main/how-to-guides/running-autoware-without-cuda/).

## Installing Autoware

Expand Down

0 comments on commit 1347743

Please sign in to comment.