Skip to content

Commit 2dcef1b

Browse files
authored
Update installation documentation. (#2093)
1 parent 03e7819 commit 2dcef1b

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

docs/setup.rst

+25-3
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,32 @@ Demo Video
1515
Prerequisites
1616
-------------
1717

18-
+ ``python3 (3.8 or 3.9)``
18+
+ ``python3 (3.8, 3.9, 3.10, 3.11)``
1919
+ ``ubuntu (>=16.04)``
2020

2121
Installation
2222
------------
2323

24+
Package
25+
^^^^^^^
26+
27+
This includes SMARTS but none of the examples.
28+
29+
.. code-block:: bash
30+
31+
# For Mac OS X users, ensure XQuartz is pre-installed.
32+
# Install the system requirements. You may use the `-y` option to enable
33+
# automatic assumption of "yes" to all prompts to avoid timeout from
34+
# waiting for user input.
35+
$ bash utils/setup/install_deps.sh
36+
37+
# This should install the latest version of SMARTS from package index (generally PyPI).
38+
$ pip install 'smarts[camera_obs,sumo,example]'
39+
40+
41+
Development
42+
^^^^^^^^^^^
43+
2444
Run the following commands to setup the SMARTS simulator.
2545

2646
.. code-block:: bash
@@ -61,9 +81,11 @@ Run the following commands to setup the SMARTS simulator.
6181
# Install smarts with extras as needed. Extras include the following:
6282
# `camera_obs` - needed for rendering camera observations, and for testing.
6383
# `sumo` - needed for using SUMO scenarios.
64-
# `test` - needed for testing.
84+
# `test` - needed for running tests.
6585
# `example` - needed for running examples.
66-
$ pip install -e .[camera_obs,sumo,test,example]
86+
# `--config-settings editable_mode=strict` - may be needed depending on version of setuptools.
87+
# See https://github.com/huawei-noah/SMARTS/issues/2090.
88+
$ pip install -e '.[camera_obs,sumo,test,example]' --config-settings editable_mode=strict
6789
6890
# Run sanity-test and verify they are passing.
6991
# If tests fail, check './sanity_test_result.xml' for test report.

0 commit comments

Comments
 (0)