chore: Add description of the 'scripts' folder

VIDA-NYU · Jan 14, 2025 · f2e783c · f2e783c
1 parent d0237aa
commit f2e783c
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/scripts/README.md b/scripts/README.md
@@ -0,0 +1,7 @@
+# Miscellaneous Scripts
+
+This folder contains miscellaneous scripts that are not directly involved in running the bdi-kit library. These scripts serve as utilities for preprocessing or post-processing data required by bdi-kit.
+
+Below are the subfolders and their purposes:
+
+- `format_schema`: Contains scripts for formatting various schemas into the bdi-kit format. These scripts generate the resources used by bdi-kit.
diff --git a/scripts/format_gdc.py → scripts/format_schema/format_gdc.py b/scripts/format_gdc.py → scripts/format_schema/format_gdc.py
@@ -3,7 +3,7 @@
 
 
 RAW_GDC_PATH = join(dirname(__file__), "./gdc_raw_schema.json")
-FORMATTED_GDC_PATH = join(dirname(__file__), "../bdikit/resource/gdc_schema.json")
+FORMATTED_GDC_PATH = join(dirname(__file__), "../../bdikit/resource/gdc_schema.json")
 
 metadata = {}
 

diff --git a/scripts/gdc_raw_schema.json → scripts/format_schema/gdc_raw_schema.json b/scripts/gdc_raw_schema.json → scripts/format_schema/gdc_raw_schema.json