janniklinde commented on code in PR #2388: URL: https://github.com/apache/systemds/pull/2388#discussion_r2630462580
########## docs/site/run_extended.md: ########## @@ -0,0 +1,253 @@ +# Running SystemDS + +This guide explains how to run SystemDS regardless of whether you installed it from a Release or built it from Source. All execution modes -local, Spark, and federated- are covered in this document. + +--- + +- [1. Prerequisites](#1-prerequisites) +- [2. Set SYSTEMDS_ROOT and PATH](#2-set-systemds_root-and-path) +- [3. Run a Simple Script Locally](#3-run-a-simple-script-locally) +- [4. Run a Script on Spark](#4-run-a-script-on-spark) +- [5. Run a Script in Federated Mode](#5-run-a-script-in-federated-mode) + +--- + +# 1. Prerequisites + +### Java Requirement ### +For compatability with Spark execution and parser components, **Java 17** is strongly recommended for SystemDS. + +Verify Java version: + +```bash +java -version +``` + +### Spark (required only for Spark execution) ### + +- Use Spark 3.x. +- Spark 4.x is not supported due to ANTLR runtime incompatibilities. + +Verify Spark version: + +```bash +spark-submit --version +``` + +--- + +# 2. Set SYSTEMDS_ROOT and PATH + +This step is required for both Release and Source-build installations. Run the following in the root directory of your SystemDS installation: + +```bash +export SYSTEMDS_ROOT=$(pwd) +export PATH="$SYSTEMDS_ROOT/bin:$PATH" +``` + +It can be beneficial to enter these into your `~/.profile` or `~/.bashrc` for linux, +(but remember to change `$(pwd` to the full folder path) +or your environment variables in windows to enable reuse between terminals and restarts. + +```bash +echo 'export SYSTEMDS_ROOT='$(pwd) >> ~/.bashrc +echo 'export PATH=$SYSTEMDS_ROOT/bin:$PATH' >> ~/.bashrc +``` Review Comment: I would mention that in `release_install` as well. Otherwise, after restarting the terminal people might get confused when only following quickstart. Also, for prerequisites that are already mentioned in the install guides reference them rather than repeating the same thing. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
