Skip to content
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

Update installation documentation. #2093

Merged
merged 1 commit into from
Oct 11, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions docs/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,32 @@ Demo Video
Prerequisites
-------------

+ ``python3 (3.8 or 3.9)``
+ ``python3 (3.8, 3.9, 3.10, 3.11)``
+ ``ubuntu (>=16.04)``

Installation
------------

Package
^^^^^^^

This includes SMARTS but none of the examples.

.. code-block:: bash

# For Mac OS X users, ensure XQuartz is pre-installed.
# Install the system requirements. You may use the `-y` option to enable
# automatic assumption of "yes" to all prompts to avoid timeout from
# waiting for user input.
$ bash utils/setup/install_deps.sh

# This should install the latest version of SMARTS from package index (generally PyPI).
$ pip install 'smarts[camera_obs,sumo,example]'


Development
^^^^^^^^^^^

Run the following commands to setup the SMARTS simulator.

.. code-block:: bash
Expand Down Expand Up @@ -61,9 +81,11 @@ Run the following commands to setup the SMARTS simulator.
# Install smarts with extras as needed. Extras include the following:
# `camera_obs` - needed for rendering camera observations, and for testing.
# `sumo` - needed for using SUMO scenarios.
# `test` - needed for testing.
# `test` - needed for running tests.
# `example` - needed for running examples.
$ pip install -e .[camera_obs,sumo,test,example]
# `--config-settings editable_mode=strict` - may be needed depending on version of setuptools.
# See https://github.com/huawei-noah/SMARTS/issues/2090.
$ pip install -e '.[camera_obs,sumo,test,example]' --config-settings editable_mode=strict

# Run sanity-test and verify they are passing.
# If tests fail, check './sanity_test_result.xml' for test report.
Expand Down
Loading