read me

README.md

@@ -104,46 +104,142 @@ It is particularly useful for comparing:
 
 ## Access Patterns
 
-The dataset can be accessed in multiple ways depending on research needs. Scripts for downloading specific subsets are provided on [Github](https://github.com/tobischimanski/pdfQA).
+The dataset supports multiple access patterns depending on research
+needs.
 
-The repository supports multiple usage patterns:
+All official download scripts are available in the GitHub repository:
 
-#### Download Everything
+👉 https://github.com/tobischimanski/pdfQA
 
-Clone the entire repository (includes Git LFS objects).
+Scripts are provided in both:
 
-#### Download by Category
+-   **Bash (git + Git LFS)** --- recommended for large-scale downloads\
+-   **Python (huggingface_hub API)** --- recommended for programmatic
+    workflows
 
-Download only `real-pdfQA/` or only `syn-pdfQA/`.
+------------------------------------------------------------------------
 
-#### Download by Dataset
+### 1️⃣ Download Everything
 
-Download a specific dataset across all file types.
+Download the entire repository (all categories, types, and datasets).
 
-#### Download by Dataset + Type
+#### Bash (git + LFS)
 
-Example:
+``` bash
+./tools/download_using_bash/download_all.sh
+```
+
+[Bash script](https://github.com/tobischimanski/pdfQA/blob/main/tools/download_using_bash/download_all.sh)
+
+
+#### Python (HF API)
+
+``` bash
+python tools/download_using_python/download_all.py
+```
+
+[Python script](https://github.com/tobischimanski/pdfQA/blob/main/tools/download_using_python/download_all.py)
+
+------------------------------------------------------------------------
+
+### 2️⃣ Download by Category
+
+Download only:
+
+-   `real-pdfQA/`
+-   or `syn-pdfQA/`
+
+#### Example
+
+``` bash
+./tools/download_using_bash/download_category.sh syn-pdfQA
+```
 
-* Only PDFs for a dataset
-* Only CSV annotations for a dataset
-* Only raw source files for a dataset
+[Bash script](https://github.com/tobischimanski/pdfQA/blob/main/tools/download_using_bash/download_category.sh)
 
-#### Download Single File
+[Python script](https://github.com/tobischimanski/pdfQA/blob/main/tools/download_using_python/download_category.py)
 
-Individual files can be downloaded directly via the Hugging Face API.
+------------------------------------------------------------------------
 
-Example (Python):
+### 3️⃣ Download by Dataset (All Types)
+
+Download a single dataset across all three file-type folders:
+
+-   `01.1_Input_Files_Non_PDF/`
+-   `01.2_Input_Files_PDF/`
+-   `01.3_Input_Files_CSV/`
+
+#### Example
+
+``` bash
+./tools/download_using_bash/download_dataset.sh syn-pdfQA books
+```
+
+[Bash script](https://github.com/tobischimanski/pdfQA/blob/main/tools/download_using_bash/download_dataset.sh)
+
+[Python script](https://github.com/tobischimanski/pdfQA/blob/main/tools/download_using_python/download_dataset.py)
+
+------------------------------------------------------------------------
+
+### 4️⃣ Download Arbitrary Folders
+
+Download one or multiple arbitrary folder paths.
+
+#### Example
+
+``` bash
+./tools/download_using_bash/download_folders.sh \
+  "syn-pdfQA/01.2_Input_Files_PDF/books" \
+  "syn-pdfQA/01.3_Input_Files_CSV/books"
+```
 
-```python
+[Bash script](https://github.com/tobischimanski/pdfQA/blob/main/tools/download_using_bash/download_folders.sh)
+
+[Python script](https://github.com/tobischimanski/pdfQA/blob/main/tools/download_using_python/download_folders.py)
+
+------------------------------------------------------------------------
+
+### 5️⃣ Download Specific Files
+
+Download one or more individual files.
+
+#### Example (Bash)
+
+``` bash
+./tools/download_using_bash/download_files.sh \
+  "syn-pdfQA/01.2_Input_Files_PDF/books/file1.pdf"
+```
+
+[Bash script](https://github.com/tobischimanski/pdfQA/blob/main/tools/download_using_bash/download_files.sh)
+
+[Python script](https://github.com/tobischimanski/pdfQA/blob/main/tools/download_using_python/download_files.py)
+
+------------------------------------------------------------------------
+
+### 6️⃣ Direct API Access (Single File)
+
+Files can also be downloaded directly using the Hugging Face API. Example:
+
+``` python
 from huggingface_hub import hf_hub_download
 
 hf_hub_download(
-    repo_id="pdfqa/pdfQA",
+    repo_id="pdfqa/pdfQA-Benchmark",
     repo_type="dataset",
     filename="syn-pdfQA/01.2_Input_Files_PDF/FinQA/AAL_2010.pdf"
 )
 ```
 
+------------------------------------------------------------------------
+
+## Recommended Usage
+
+-   For **large-scale research experiments** → use **Bash + git LFS**
+    (fully resumable).
+-   For **automated pipelines** → use **Python scripts**.
+-   For **fine-grained subset control** → use folder or file-based
+    scripts.
+
 ---
 
 ## Data Modalities
@@ -156,15 +252,7 @@ Depending on the dataset:
 * Table-heavy documents
 * Mixed structured/unstructured content
 
-Formats may include:
-
-* PDF
-* CSV
-* XLS/XLSX
-* EPUB
-* HTML/HTM
-* TEX
-* TXT
+Formats may include: `PDF`, `CSV`, `XLS/XLSX`, `EPUB`, `HTML/HTM`, `TEX`, `TXT`
 
 ---
 
@@ -186,24 +274,6 @@ This enables:
 
 ---
 
-## Limitations
-
-* Some datasets originate from external benchmarks and inherit their constraints.
-* Synthetic datasets may not reflect real-world noise distribution.
-* File sizes can be large due to preservation of raw formats.
-* Users must install Git LFS for full cloning.
-
----
-
-## License
-
-Each sub-dataset inherits the license of its original source.
-Users must ensure compliance with the licensing terms of individual datasets.
-
-If you use this collection, please cite the original datasets in addition to this repository.
-
----
-
 ## Citation
 
 If you use **pdfQA**, please cite: