@@ -15,12 +15,32 @@ Demo Video
15
15
Prerequisites
16
16
-------------
17
17
18
- + ``python3 (3.8 or 3.9) ``
18
+ + ``python3 (3.8, 3.9, 3.10, 3.11 ) ``
19
19
+ ``ubuntu (>=16.04) ``
20
20
21
21
Installation
22
22
------------
23
23
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
+
24
44
Run the following commands to setup the SMARTS simulator.
25
45
26
46
.. code-block :: bash
@@ -61,9 +81,11 @@ Run the following commands to setup the SMARTS simulator.
61
81
# Install smarts with extras as needed. Extras include the following:
62
82
# `camera_obs` - needed for rendering camera observations, and for testing.
63
83
# `sumo` - needed for using SUMO scenarios.
64
- # `test` - needed for testing .
84
+ # `test` - needed for running tests .
65
85
# `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
67
89
68
90
# Run sanity-test and verify they are passing.
69
91
# If tests fail, check './sanity_test_result.xml' for test report.
0 commit comments