Setting_up_a_MSP_development_environment_with_the_command_line
(1) Required Development Software
The Mars Simulation Project requires the following software for checking out, building, and running from the command line:
a. A Java Development Kit version 1.8 or newer. OpenJDK or Oracle's JDK should work fine.
Note : as of mars-sim 3.08-snapshot version, OpenJDK does NOT work. Use Oracle's JDK instead.
b. Subversion version 1.6 or newer.
c. Maven version 3.0 or newer.
(2) Checking out mars-sim from Subversion Code Repository
a. If you are a developer on the project and have read/write access to the code repository, you can check the code out the code as follows:
svn checkout --username=<your sourceforge user name> svn+ssh://<your sourceforge user name>@svn.code.sf.net/p/mars-sim/code/trunk mars-sim-code
b. If you aren't a developer on the project or you just want to check out from the code repository with read-only access:
svn checkout svn://svn.code.sf.net/p/mars-sim/code/trunk mars-sim-code
Note: more info on checking out the project from the code repository can be found on the project's SourceForge code page.
(3) Building and Running mars-sim
Method 1
a. From the directory in which you checked out the Mars Simulation Project code, go to the "mars-sim" subdirectory.
b. Run the following three commands in one line to compile the classes in all of the maven projects.
mvn clean package install
Note that this will wipe clean the old compiled files, run unit tests on all of the maven projects and generate artifact jar files for them in the local maven repository.
c. Go to the mars-sim-main/target/ directory. You should see the compiled jar called "mars-sim-main-version#-jar-with-dependencies.jar".
d. To start the simulation, just double click this jar to run it.
e. Alternatively, you may want to see the logging statements in the console by typing in the following to start the simulation:
java -jar mars-sim-main-version#-jar-with-dependencies.jar
Method 2
a. From the directory in which you checked out the Mars Simulation Project code, go to the "mars-sim" subdirectory.
b. Run the following command to compile the classes in all of the maven projects.
mvn compile
c. Next, run the following command to install:
mvn install
d. Run the following to download the webstart-maven-plugin to start the simulation :
mvn exec:java -Dexec.mainClass="org.mars_sim.msp.MarsProject"
NOTE: as of mars-sim 3.08-snapshot version, the step (d) above no longer works. Use method 1 instead.
(4) Working with the Subversion Code Repository
a. To see what files are different from your local checked-out copy of the project and the subversion repository, type:
svn status
b. To update your local checked-out copy of the project from the subversion repository to the latest build, type:
svn update
c. To commit the changes in your local checked-out copy of the project back into the repository, type:
svn commit
Note : for more information on using subversion, see Version Control with Subversion.
