Landingpage without screenshots

README.md

@@ -8,7 +8,7 @@
 
 * General configuration: [config/config.yaml](config/config.yaml)
 * Plot configuration: [config/plot_config.yaml](config/plot_config.yaml)
-* Meta information: [workflow/scripts/bokeh_plot/components/plot_css_html.py](workflow/scripts/bokeh_plot/components/plot_css_html.py)
+* Meta information: [workflow/scripts/plot/components/plot_css_html.py](workflow/scripts/plot/components/plot_css_html.py)
 
 ### Setup
 

config/config.yaml

@@ -22,6 +22,7 @@ DISPLAY_LAYOUT_BINARY: /srv/data/seiler/hibf_benchmark/display_layout
 FILENAMES_FILE: /srv/public/leonard/hibf_benchmarks/data/1024/1024.filenames
 QUERY_FILE: /srv/public/leonard/hibf_benchmarks/data/1024/reads_e2_250/all.fastq
 
+# All the parameters to run with raptor
 PARAMS:
   ALPHA: [60.0 ,40.0, 20.0, 10.0, 5.0, 2.0, 1.5, 1.3, 1.0, 0.7, 0.5]
   T_MAX: ?sorted([192, 768, 8192] + inclusive_range_mult(64, 2048, 2))
@@ -30,10 +31,11 @@ PARAMS:
   RELAXED_FPR: ?[0.05] + inclusive_range_add(0.1, 0.9, 0.1)
   MODE: [none, U, U+R] # [none, U, U+R]
 
-
+# Neccessary data parameters to run raptor 
 DATA_PARAMETERS:
   QUERY_ERRORS: 2
 
+# Default parameters to run raptor
 DEFAULT_PARAMS:
   ALPHA: 1.2
   T_MAX: 192
@@ -43,4 +45,5 @@ DEFAULT_PARAMS:
   M_FPR: 0.05
   MODE: U+R
 
-NUM_THREADS: 1 # Number of threads to use per task, not for parallel execution
+# Number of threads to use per task, not for parallel execution
+NUM_THREADS: 1

config/plot_config.yaml

@@ -1,7 +1,8 @@
-PLOT_NAME: "plot1"
-EXTRA_FILE_PLOTTING: True
+PLOT_NAME: "plot_name"
+EXTRA_FILE_PLOTTING: True # if True, ALL htmls in the results/html folder will be plotted
 
 
+# Names for the different keys in the plot
 KEYS:
   alpha: alpha
   hash: hash
@@ -12,6 +13,8 @@ KEYS:
   U+R: U+R
 
 
+# Format: all benchmark-times to plot
+# Names: names for the different keys in the plot
 TIME:
   FORMAT:
     - determine_query_length_in_seconds
@@ -42,6 +45,8 @@ TIME:
     generate_results_max_percentage: "Generate results (max) percentage"
 
 
+# Format: all benchmark-sizes to plot
+# Names: names for the different keys in the plot
 SIZE:
   FORMAT:
     - LEVEL_0_GB_SIZE

workflow/envs/landingpage.yml

@@ -3,3 +3,4 @@ channels:
   - conda-forge
 dependencies:
   - html2image=2.0.4.3
+  - beautifulsoup4=4.12.3

workflow/rules/plot.smk

@@ -5,7 +5,7 @@ rule plot_data:
     output:
         PLOT_FILE=f"results/html/{config['PLOT_NAME']}.html",
     params:
-        THEME="workflow/scripts/bokeh_plot/plot_theme.yaml",
+        THEME="workflow/scripts/plot/plot_theme.yaml",
         KEYS=config["KEYS"],
         TIME=config["TIME"],
         SIZE=config["SIZE"],
@@ -14,15 +14,14 @@ rule plot_data:
     conda:
         "../envs/bokeh.yml"
     script:
-        "../scripts/bokeh_plot/plot.py"
+        "../scripts/plot/plot.py"
 
 
 rule plot_landingpage:
     input:
         PLOT_FILE=f"results/html/{config['PLOT_NAME']}.html",
     output:
         OUTPUT_FILE="results/html/index.html",
-        PNG_FILE=f"results/html/{config['PLOT_NAME']}.png",
     params:
         EXTRA_FILE_PLOTTING=config["EXTRA_FILE_PLOTTING"],
         HTML_DIR="results/html",
@@ -31,4 +30,4 @@ rule plot_landingpage:
     conda:
         "../envs/landingpage.yml"
     script:
-        "../scripts/landingpage.py"
+        "../scripts/plot/landingpage.py"