yiseungmi87 commented on code in PR #2388: URL: https://github.com/apache/systemds/pull/2388#discussion_r2704073643
########## docs/site/run_extended.md: ########## @@ -0,0 +1,269 @@ +# 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 + +This guide assumes that SystemDS has already been installed successfully. + +Please make sure you have followed one of the installation guides: +- [Install SystemDS from a Release](release_install.html) +- [Install SystemDS from Source](source_install.html) + +In particular, ensure that: +- Java 17 is installed +- Spark 3.x is available if you plan to run SystemDS on Spark + +--- + +# 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 persist these variables in your `~/.profile` or `~/.bashrc`(Linux/macOS) or as environment variables on Windows, so that SystemDS is available across terminal sessions. Make sure to replace the path below with the absolute path to your SystemDS installation. + +```bash +echo 'export SYSTEMDS_ROOT=/absolute/path/to/systemds-<VERSION>' >> ~/.bashrc +echo 'export PATH="$SYSTEMDS_ROOT/bin:$PATH"' >> ~/.bashrc +source ~/.bashrc +``` +--- Review Comment: Replaced it with a short bullet points to prerequisites. -- 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]
