8000 Improve installation and demo package documentation (#818) by viradiyashivali-cmd · Pull Request #856 · esmini/esmini · GitHub
[go: up one dir, main page]

Skip to content
Open
Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Repository: <https://github.com/esmini/esmini>

User guide: https://esmini.github.io

Pre-built demo packages are available [here](https://github.com/esmini/esmini/releases/latest). Unzip, navigate to "esmini\run\esmini" and run any of the example scripts. See more info below under [Binaries and demos](#binaries-and-demos).
Pre-built demo packages are available [here](https://github.com/esmini/esmini/releases/latest). Unzip, navigate to "esmini-demo/run/esmini" and run any of the example scripts. See more info below under [Binaries and demos](#binaries-and-demos).

esmini supports OpenSCENARIO XML v1.0 - v1.3. However, please note that feature [coverage](https://github.com/esmini/esmini/blob/master/osc_coverage.txt) is limited. The functionality grows slow but steady, based on need and contributions.

Expand All @@ -46,7 +46,7 @@ Windows, Linux and Mac supported

Latest release including source, binaries and demo packages is found here: https://github.com/esmini/esmini/releases/latest

Some example scenarios make use of pre-created 3D models, which are included in the demo packages. They are also available [here](https://dl.dropboxusercontent.com/s/5gk8bvgzqiaaoco/models.7z?dl=0). Unpack into esmini/resources. These assets works on all platforms.
Some example scenarios make use of pre-created 3D models, which are included in the demo packages. They are also available [here](https://www.dropbox.com/scl/fi/3jwz3ie6xkgpga33cbyju/models_with_lights.7z?rlkey=9obptnofidldoagn4154iyntl&st=zxoupatb&dl=1). Unpack into esmini/resources (into a `models` subfolder). These assets work on all platforms.
Environment models (roads, landscape, buildings...) have been created using [VIRES Road Network Editor](https://vires.mscsoftware.com/solutions/3d-environment-road-network).

See [User Guide](https://esmini.github.io) for more information.
Expand Down
27 changes: 17 additions & 10 deletions docs/user_guide/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@ endif::monolith[]

Download latest release from here: https://github.com/esmini/esmini/releases/latest

First time make sure to pick the demo package for your platform (Windows, Linux or Mac). In addition to application binaries it also includes some content like example scenarios and basic 3D models. The binary (bin) packages includes only executables and libraries.
First time make sure to pick the demo package for your platform (Windows, Linux or Mac), e.g. `esmini-demo_Windows.zip`, `esmini-demo_Linux.zip`, or `esmini-demo_macOS.zip`. In addition to application binaries it also includes some content like example scenarios and basic 3D models. The binary (bin) packages include only executables and libraries.

On Windows, make sure the zip file is not blocked: Right click, click Properties, at bottom right check Unblock. For more info, see link:support-qa.html#_blocked_by_windows_defender_smartscreen[Blocked by Windows Defender SmartScreen].

To install the package, just unzip it anywhere. A single subfolder named `esmini` is created. This is the root folder for esmini. No files are stored outside this folder structure and no system files or registry is modified in any way.
To install the demo package, just unzip it anywhere. A single subfolder named `esmini-demo` is created. This is the root folder for the demo. No files are stored outside this folder structure and no system files or registry is modified in any way.

=== Run esmini

Try to run one of the examples:

* go to folder esmini/run/esmini
* go to folder `esmini-demo/run/esmini`
* double click on a .bat file, e.g. `run_cut-in.bat` or run it from a command line.

These scripts should work on all platforms (in spite extension ".bat").
These scripts should work on all platforms (in spite of the extension ".bat").

You can also run the examples explicitly from a command line:
You can also run the examples explicitly from a command line (from the `esmini-demo` root folder):

``./bin/esmini --window 60 60 800 400 --osc ./resources/xosc/cut-in.xosc``

Expand All @@ -34,14 +34,21 @@ For common Mac issues, please see link:support-qa.html#_mac_issues_and_limitatio
=== Get complete esmini
The demo package contains only a subset of esmini tools and content (e.g. scenario examples, scripts and models).

To get the complete content, first download or clone the project from GitHub: https://github.com/esmini/esmini. E.g: +
To get the complete content, first obtain the project repository (creating the `esmini` root folder):

* Download the source archive for the matching release (e.g. `esmini-fullsrc.zip` or the source code zip from https://github.com/esmini/esmini/releases) and extract it. This ensures alignment with the precompiled binaries and is easy for users not familiar with Git.
* Or clone the repository from GitHub: +
`git clone \https://github.com/esmini/esmini.git`

Then either build yourself, see step 2 in next chapter <<Build esmini - quick guide>>, or:
Then either build yourself, see <<Build esmini - quick guide>>, or:

. Download the pre-built binary package for your system (`esmini-bin_Windows.zip`, `esmini-bin_Linux.zip`, or `esmini-bin_macOS.zip`) from latest release:
https://github.com/esmini/esmini/releases. Copy/extract the content into the `esmini` root folder (this will populate `esmini/bin` with executables/libraries and `esmini/EnvironmentSimulator` with headers and wrappers).
. Download the complete 3D model package from https://www.dropbox.com/scl/fi/3jwz3ie6xkgpga33cbyju/models_with_lights.7z?rlkey=9obptnofidldoagn4154iyntl&st=zxoupatb&dl=1[here]. Unpack into `esmini/resources` (it should end up in a `models` subfolder, i.e. `esmini/resources/models`). These assets work on all platforms. The environment models (roads, landscape, buildings...) have been created using https://vires.mscsoftware.com/solutions/3d-environment-road-network[VIRES Road Network Editor].

. Download pre-built binary package for your system (e.g. esmini-bin_win_x64.zip) from latest release:
https://github.com/esmini/esmini/releases. Copy the content into the esmini-demo folder.
. Download the complete 3D model package from https://www.dropbox.com/scl/fi/3jwz3ie6xkgpga33cbyju/models_with_lights.7z?rlkey=9obptnofidldoagn4154iyntl&st=zxoupatb&dl=1[here]. Unpack into esmini/resources (it should end up in a `models` subfolder). These assets work on all platforms. The environment models (roads, landscape, buildings...) have been created using https://vires.mscsoftware.com/solutions/3d-environment-road-network[VIRES Road Network Editor].
Now you can run any of the complete scenarios and examples, for instance from `esmini/run/esmini` or directly from the `esmini` root folder:

``./bin/esmini --window 60 60 800 400 --osc ./resources/xosc/cut-in.xosc``

=== Build esmini - quick guide

Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/scenario-construction-tips.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Commonly used conditions are:

Here follows a few scenario examples highlighting various useful features.

To run the examples, grab and unzip the latest esmini *demo* (not bin) package, from https://github.com/esmini/esmini/releases/latest[here]. The run instructions assume you’re located in esmini root folder.
To run the examples, grab and unzip the latest esmini *demo* (not bin) package, from https://github.com/esmini/esmini/releases/latest[here]. The run instructions assume you’re located in the `esmini-demo` root folder.

==== Example 1: scenario_nurb_straight_road
Scenariofile: https://github.com/esmini/esmini/blob/dev/resources/scenario_construct_examples/scenario_nurb_straight_road.xosc[scenario_nurb_straight_road.xosc]
Expand Down