From 5a8a2f292222df10133b627c9398345f1969e034 Mon Sep 17 00:00:00 2001 From: Minjae Gwon Date: Thu, 7 Dec 2023 21:58:55 +0900 Subject: [PATCH 1/2] config: disable stdout logging --- log4j2.properties | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/log4j2.properties b/log4j2.properties index 0f54042..dfe44ab 100644 --- a/log4j2.properties +++ b/log4j2.properties @@ -4,12 +4,6 @@ status = warn # Name of the configuration name = ConsoleFileLogConfigDemo -# Console appender configuration -appender.console.type = Console -appender.console.name = consoleLogger -appender.console.layout.type = PatternLayout -appender.console.layout.pattern = %d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n - # File appender configuration appender.file.type = File appender.file.name = fileLogger @@ -17,9 +11,5 @@ appender.file.fileName = logs/app.log appender.file.layout.type = PatternLayout appender.file.layout.pattern = %d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n -# Root logger level -rootLogger.level = info - -# Root logger referring to both console and file appenders -rootLogger.appenderRef.stdout.ref = consoleLogger +# Root logger referring to both console and file appender rootLogger.appenderRef.file.ref = fileLogger From 9c5a9ed8ef1f147dc5c217e609cab4e2851ac98b Mon Sep 17 00:00:00 2001 From: Minjae Gwon Date: Thu, 7 Dec 2023 22:28:19 +0900 Subject: [PATCH 2/2] docs: update readme --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 45 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7c15aa4..f3c8e52 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,56 @@ [![CSED434@POSTECH](https://img.shields.io/badge/CSED434-POSTECH-c80150)](https://www.postech.ac.kr/eng) [![CSED434@POSTECH](https://img.shields.io/badge/Fall-2023-775E64)](https://www.postech.ac.kr/eng) -**Paranode** is a project developed as part of POSTECH's CSED434 curriculum, dedicated to the implementation of distributed and parallel sorting for key-value records using the Scala programming language. Its primary objective is the development of a robust sorting system tailored for the distribution of extensive datasets, surpassing the limitations of available RAM and storage capacity. Leveraging Scala, Paranode orchestrates parallel data processing across multiple machines, preserving record integrity through key-based sorting. +**Paranode** is a project developed as part of POSTECH's CSED434 curriculum, dedicated to the implementation of **distributed and parallel sorting system** for key-value records using the Scala programming language. Its primary objective is the development of a robust sorting system tailored for the distribution of extensive datasets, surpassing the limitations of available RAM and storage capacity. Leveraging Scala, Paranode orchestrates parallel data processing across multiple machines, preserving record integrity through key-based sorting. -## Getting Started +## Usage -### Development Environment +### Build -#### Install pre-commit hooks +To build the project, follow these instructions: + +1. Clone the repository. +1. Run `sbt assembly`. + +### Run + +To launch a master node and worker nodes, follow these steps: + +1. Build the project using the instructions above. +1. Run [`master` script](bin/master) with parameters. + - For example, execute `./master ` from the [`bin`](bin) directory. +1. Run [`worker` script](bin/worker) with parameters. + - For example, `./worker : -I <...> -O ` from the [`bin`](bin) directory. + +It is possible to run jar files downloaded from releases page instead of building the project. + +## Development + +### Environment + +- Scala 2.13.12 +- SBT 1.9.6 +- Java 20 + +### Test + +To run unit tests, follow the instructions below: + +1. Clone the repository. +1. Run `sbt test`. + +To run e2e tests, follow the instructions below: + +1. Clone the repository. +1. Run `sbt e2e/test`. + +### Pre-commit hooks 1. Install `pre-commit` package by [instructions](https://pre-commit.com/#installation). 1. Run `pre-commit install`. Note that `pre-commit install` should be re-run if [`.pre-commit-config.yaml`](.pre-commit-config.yaml) changed. + +## Disclaimer + +This project is developed as part of the CSED434 course at POSTECH, and is not intended for production or commercial use. Any usage is at your own risk, and the contributors are not responsible for any potential issues.