Basic how-to-use information added

Nolte-Group · Sep 30, 2025 · b8dcff2 · b8dcff2
1 parent 6092d5a
commit b8dcff2
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.env_template b/.env_template
@@ -0,0 +1,2 @@
+DATA_PATH=PATH/TO/YOUR/DATA/DIRECTORY
+SHARED_MEMORY_SIZE=[number_for_memory_size][unit_t,g,m,k]
diff --git a/README.md b/README.md
@@ -2,6 +2,19 @@
 
 Geonosis is a synthetic data generator based on transformer architecture.
 
+## Setting up
+
+Change the .env_template file to .env and set the environment variables in it
+accordingly for the system.
+
+Go to `setup` directory and run `setup.sh` or `setup.ps1` depending on the OS.
+
+## Usage
+
+To enter the docker container, run `launch.sh` for Linux or `winlaunch.ps1` for
+Windows. Once inside, change directory to `/app/code` and run the desired
+script.
+
 Inputs:
 .mat files in the file dump
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		DATA_PATH=PATH/TO/YOUR/DATA/DIRECTORY
		SHARED_MEMORY_SIZE=[number_for_memory_size][unit_t,g,m,k]