You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/docs/guide/started/installation.md
+18-3Lines changed: 18 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,20 +4,35 @@ description: Details of installation procedure
4
4
weight: 10
5
5
---
6
6
7
-
## Prerequisites
7
+
There are two installation packages available for the Simulation.
8
+
9
+
- Windows MSI File
10
+
- ZIP file
11
+
12
+
## Windows MSI
13
+
14
+
This approach provides a shrink wrapped installation of the UI application. It does not contain the headless server version. This can be downloaded from Assets section in [Releases](https://github.com/mars-sim/mars-sim/releases) as a MSI file that is applicable for a Windows installation.
15
+
16
+
This has no prerequisites.
17
+
18
+
## ZIP File
19
+
20
+
This approach is more complex but provides a wider range of options. Command lines arguments can be used.
21
+
22
+
### Prerequisites
8
23
9
24
Currently, mars-sim supports Java 21 which is a LTS (Long Term Support release). Requires only JRE 21 for running mars-sim. See [JDK21](https://jdk.java.net/java-se-ri/21)
10
25
11
26
The application supports Windows or Linux. MacOS is supported but not via a command script; Java must be called directly.
12
27
13
-
## Applications
28
+
###Applications
14
29
15
30
The installation consists of 2 application:
16
31
17
32
- A UI application based on Java Swing
18
33
- A headless server version that can be accessed remotely via an SSH interface.
19
34
20
-
## Installation Process
35
+
###Installation Process
21
36
22
37
The installation process is simple requiring command line access.
The _New_ option start a new Simulation using the [Default](../../../definitions/scenario/default) Scenario. Whilst the _Select Scenario_ allows the selecting of a different pre-defined Scenario in a new Simulation.
15
+
16
+
## Command Line Starting Sequence
17
+
18
+
The ZIP distribution supports both Windows and Linux and uses a command line starting sequence.
19
+
9
20
It also provides 2 variants of the mars-sim application.
10
21
1. Swing based UI
11
22
2. Console based engine that is accessed via SSH
@@ -21,16 +32,16 @@ Start commands are:
21
32
Common command line arguments are:
22
33
-baseurl <URL to remote content> URL to the remote content repository
23
34
(defaults to master in GitHub)
24
-
-crew <true|false> Enable or disable use of the crews
35
+
-configdir <directory> Directory for configurations files
25
36
-datadir <path to data directory> Path to the data directory for
0 commit comments