Add better dataset filtering system (and a left sidebar layout mode)

README.md

@@ -2,7 +2,7 @@
 
 Built using [Minimal Mistakes](https://github.com/mmistakes/minimal-mistakes) and [Jekyll](https://jekyllrb.com). 
 
-## Documentation for BLASTNet maintainers and contributors
+# Documentation for BLASTNet maintainers and contributors
 
 This repository contains all the code for the blastnet.github.io website. Most of the Minimal Mistakes features and layouts are not used (and will likely never be used) and so they have been removed for a smoother and lighter build experience. Yet, some new features like the data counters have also been added. Therefore, please read this documentation carefully.
 
@@ -76,7 +76,7 @@ gem install jekyll bundler
 
 First, clone the repository:
 ```bash
-git clone https://github.com/ihmegroup/website
+git clone https://github.com/blastnet/blastnet.github.io
 ```
 
 You can also fork the repository and clone that, if you prefer.
@@ -101,22 +101,13 @@ There are some options/flags that this command takes, the most pertinent of whic
 
 ### Important
 
-Make sure to correctly set the `url` and `baseurl` fields in `_config.yml` before building the webpage. The url should be `fxlab.stanford.edu` and baseurl blank, do not delete it.
+Make sure to not touch anything in the `_config.yml` file unless you know what you are doing. This file is used by Jekyll to build everything, so making a mistake here will likely break the entire website.
 
 ---
 
 ## Pushing to production
 
-**Never push to production on Fridays!** (jk)
-
-Once the site has been built, all the relevant files will be in the `_site` folder, ready to be uploaded to the Stanford domain. I also recommend cleaning up the CSS to remove unused classes, which speeds up loading time and reduces filesize, this can be done by running
-
-```bash
-purgecss -c purgecss.config.js
-```
-which will replace the CSS files in the `_site/assets/css/` folder with the purged css files.
-
-If using Github pages, simply run `bundle exec jekyll clean` to remove the build files, then commit changes and push to the `main` branch. I do recommend making major code-breaking or other stylistic changes on a development branch or fork, before making a pull request to the main branch.
+The site is built and hosted on Github pages, so it suffices to simply run `bundle exec jekyll clean` to remove the build files, then commit changes and push to the `master` branch. Please try to make major code-breaking or other stylistic changes on a development branch or fork, before making a pull request to the master branch.
 
 ---
 
@@ -154,9 +145,16 @@ description: Rayleigh-Bénard Convection DNS
 header:
   teaser: /assets/img/ico_roshan2024.png
   image: /assets/img/roshan2024.png
+categories:
+- nonreacting
+- channel
+- pipe
+- turbulent
+- threeD
+- numerical
 ---
 ```
-For each new dataset, count the number of cases and update the excerpt. Then, update the title and description as per normal. Header teaser corresponds to the icon displayed in the gallery (this keyword needs to be set or the gallery will not display correctly) and header image corresponds to the banner for the specific dataset; either set the keyword or include the banner as an image on the page using `![image](./assets/img/roshan2024.png)`. Additionally, for banner images that have a square-ish or vertical aspect ratio, it is possible to put the banner image in the sidebar like:
+For each new dataset, count the number of cases and update the excerpt. Add in relevant filter categories under the `categories` keyword as shown above. Then, update the title and description as per normal. Header teaser corresponds to the icon displayed in the gallery (this keyword needs to be set or the gallery will not display correctly) and header image corresponds to the banner for the specific dataset; either set the keyword or include the banner as an image on the page using, for example, `![image](./assets/img/roshan2024.png)`. Additionally, for banner images that have a square-ish or vertical aspect ratio, it is possible to put the banner image in the sidebar like:
 ```html
 <div class="sidebar__right" style="text-align: center; top: 160px;">
     <img src="./assets/img/gauding2022.png" alt="Image 1">
@@ -177,10 +175,7 @@ Once the new dataset is pushed to the repository, the website should automatical
 
 Adding new pages (for example, maybe new FlameAI) or editing the existing ones is simple - all the pages are rendered by markdown files located in `_pages` (except for the homepage, which is in the root folder and called `index.md`). General pages use the `single` layout; the dataset page uses the `datasets` custom layout and the homepage uses the `splash` layout, which has been significantly modified from the Minimal Mistakes file. ~~Yes, I know hardcoding is bad practice; no, I don't care.~~ The layout should be specified in the preamble using the `layout:` keyword. To add a new page or external link to the navigation menu, go to `_data/navigation.yml` and add a new entry under `main`. 
 
-## To-do list
-- Clean up the unused Minimal Mistakes code
-- Design a better color scheme
-- Better manipulation of the Kaggle API so that we can update more frequently
-- Update the Python script to only update the JSON if there are actual updates (perhaps add the ability to read the JSON file and match the values) --> this can reduce the number of updates to the Gist and reduce clutter
-- Think about whether we want to do a manual size calculation at every update or just cache the size permanently. Pros of cache: Much lower load, size shouldn't change by a lot anyway. Cons of cache: Less accurate; each subdataset has different number of downloads so the homepage total counter will also be inaccurate; does not capture versioning.
+## Filters
+
+The datasets summary page contains a list of filters which are generated from the list in `_data/filters.yml`. Filter category keywords from each of the dataset pages should correspond to these. To add more filters or filter groups, modify `_data/filters.yml`.
 

_data/filters.yml

@@ -0,0 +1,40 @@
+- title: "Flow Type"
+  group: "Reynolds"
+  items:
+    - { name: "Laminar", filter: ".laminar" }
+    - { name: "Turbulent", filter: ".turbulent" }
+
+- title: "Combustion"
+  group: "Combustion"
+  items:
+    - { name: "Reacting", filter: ".reacting" }
+    - { name: "Non-reacting", filter: ".nonreacting" }
+
+- title: "Dimensionality"
+  group: "Dimensionality"
+  items:
+    - { name: "2D", filter: ".twoD" }
+    - { name: "3D", filter: ".threeD" }
+
+- title: "Flow Configuration"
+  group: "FlowType"
+  items:
+    - { name: "HIT", filter: ".hit" }
+    - { name: "Pipe", filter: ".pipe" }
+    - { name: "Channel", filter: ".channel" }
+    - { name: "Jet", filter: ".jet" }
+    - { name: "Environmental", filter: ".environmental" }
+
+- title: ""
+  group: "ML"
+  comb: true
+  exclusive: false
+  items: 
+    - { name: "Benchmark Datasets", filter: ".benchmark" }
+
+- title: ""
+  group: "DataType"
+  items:
+    - { name: "Numerical", filter: ".numerical" }
+    - { name: "Experimental", filter: ".experimental" }
+

_datasets/brouzet2021.md

@@ -5,7 +5,12 @@ title: Reacting Jet Flows
 description: Turbulent Round Jet Premixed COFFEE CH4-air Premixed Flame DNS
 header:
   teaser: /assets/img/ico_brouzet2021.png
-categories: reacting
+categories:
+  - reacting
+  - turbulent
+  - threeD
+  - jet
+  - numerical
 ---
 
 <div class="sidebar__right" style="top:200px; text-align: center;">

_datasets/chung2022.md

@@ -5,7 +5,12 @@ excerpt: (1 case)
 header:
   teaser: /assets/img/ico_chung2022.png
 description: Compressible Inert CH4-O2 Homogeneous Isotropic Turbulence DNS
-categories: nonreacting
+categories: 
+- nonreacting
+- numerical
+- threeD
+- turbulent
+- hit
 ---
 
 ![image](./assets/img/chung2022.png)

_datasets/chung2024.md

@@ -5,7 +5,16 @@ excerpt:
 header:
   teaser: /assets/img/ico_chung2022.png
 description: Collection of BLASTNet Simulations
-categories: nonreacting
+categories: 
+- numerical
+- nonreacting
+- turbulent
+- threeD
+- hit
+- pipe
+- channel
+- jet
+- benchmark
 ---
 
 ![image](./assets/img/diversity.png)

_datasets/coulon.md

@@ -5,7 +5,12 @@ description: NH3-H2-Air Premixed Flame DNS
 excerpt: (1 case)
 header:
   teaser: /assets/img/ico_coulon2023.png
-categories: reacting
+categories: 
+- reacting
+- turbulent
+- threeD
+- jet
+- numerical
 ---
 
 <div class="sidebar__right" style="top: 130px; text-align: center;">

_datasets/gauding2022.md

@@ -5,7 +5,12 @@ title: Forced HIT
 description: Passive Scalar HIT DNS
 header:
   teaser: /assets/img/ico_gauding2022.png
-categories: nonreacting
+categories: 
+- nonreacting
+- threeD
+- hit
+- numerical
+- turbulent
 ---
 
 <div class="sidebar__right" style="text-align: center; top: 160px;">

_datasets/guo2022.md

@@ -4,7 +4,12 @@ title: Non-Reacting Channel Flow
 excerpt: (6 cases)
 header:
   teaser: /assets/img/ico_guo2022.png
-categories: nonreacting
+categories:
+- nonreacting
+- channel
+- turbulent
+- numerical
+- threeD
 description: Transcritical Channel Flow N2 Turbulence DNS
 ---
 

_datasets/ho2024.md

@@ -5,7 +5,12 @@ title: H2/CH4 Turbulent Jet Flows
 description: H2/CH4 Fuel Mixtures, Turbulent Round Jet Premixed Flame DNS
 header:
   teaser: /assets/img/ho2024_ico.png
-categories: reacting
+categories: 
+- reacting
+- jet
+- turbulent
+- threeD
+- numerical
 ---
 
 <div class="sidebar__right" style="top:200px; text-align: center;">

_datasets/jiang2021.md

@@ -5,7 +5,12 @@ excerpt: (1 case)
 header:
   teaser: /assets/img/ico_jiang2021.png
 description: Premixed Flame-wall Interaction CH4-Air DNS
-categories: reacting
+categories: 
+- reacting
+- channel
+- threeD
+- numerical
+- turbulent
 ---
 
 <div style="text-align: center;">

_datasets/jung2021.md

@@ -5,7 +5,12 @@ excerpt: (1 case)
 header:
   teaser: /assets/img/ico_jung2021.png
 description: Slot Burner Diluted Partially-Premixed H2-air Lifted Flame DNS
-categories: reacting
+categories: 
+- numerical
+- reacting
+- jet
+- turbulent
+- threeD
 ---
 
 <div style="text-align: center;">

_datasets/pkyeung2025.md

@@ -5,7 +5,12 @@ title: Forced HIT
 description: Forced Homogeneous Isotropic Turbulence DNS with 3 Passive Scalars
 header:
   teaser: /assets/img/ico_pkyeung2025.png
-categories: nonreacting
+categories: 
+- numerical
+- nonreacting
+- hit
+- threeD
+- turbulent
 ---
 <div style="text-align: center;">
     <img src="./assets/img/pkyeung2025.png" alt="Image 1" style="max-width: 100%;">
@@ -114,4 +119,4 @@ scalars — at a single instant in time. The three scalars are each subjected to
 https://meetings.aps.org/Meeting/DFD24/Session/R37.00003, 2024.  
 [2] R. S. Rogallo. Numerical experiments in homogeneous turbulence. NASA TM 81315, NASA Ames Research Center, Moffett Field, CA., 1981.  
 [3] D. A. Donzis and P. K. Yeung. Resolution effects and scaling in numerical simulations of passive
-scalar mixing in turbulence. Physica D, 239:1278–1287, 2010. 
+scalar mixing in turbulence. Physica D, 239:1278–1287, 2010. 

_datasets/poludnenko.md

@@ -5,7 +5,12 @@ excerpt: (1 case)
 description: CH4-Air Flame Interaction With Forced HIT DNS
 header:
   teaser: /assets/img/ico_poludnenko.png
-categories: reacting
+categories: 
+- reacting
+- hit
+- threeD
+- turbulent
+- numerical
 ---
 
 ![image](./assets/img/poludnenko.png)

_datasets/quentin2024.md

@@ -6,7 +6,12 @@ description: Premixed Flame H2-Air DNS in Slot Burner
 header:
   teaser: /assets/img/ico_quentin2024.png
 #   image: /assets/img/quentin2024.png
-categories: reacting
+categories: 
+- reacting
+- jet
+- threeD
+- turbulent
+- numerical
 ---
 <div style="text-align: center;">
     <img src="./assets/img/quentin2024.png" alt="Image 1" style="max-width: 100%;">

_datasets/roshan2024.md

@@ -6,7 +6,13 @@ description: Rayleigh-Bénard Convection DNS
 header:
   teaser: /assets/img/ico_roshan2024.png
   image: /assets/img/roshan2024.png
-categories: nonreacting
+categories: 
+- nonreacting
+- channel
+- pipe
+- turbulent 
+- threeD
+- numerical
 ---
 
 <!--

_datasets/savard.md

@@ -5,7 +5,11 @@ excerpt: (22 cases)
 header:
   teaser: /assets/img/ico_savard2019.png
 description: Vitiated H2-air Freely Propagating Flame DNS
-categories: reacting
+categories: 
+- reacting
+- threeD
+- turbulent
+- numerical
 ---
 
 <div style="text-align: center;">

_datasets/shantanu.md

@@ -5,7 +5,12 @@ title: Canonical Decaying HIT
 description: Decaying homogeneous isotropic turbulence DNS
 header:
   teaser: /assets/img/ico_shantanu2022.png
-categories: nonreacting
+categories: 
+- numerical
+- nonreacting
+- hit
+- turbulent
+- threeD
 ---
 
 <div style="text-align: center;">

_datasets/sharma2024.md

@@ -5,7 +5,12 @@ title: Lifted hydrogen jet flame
 description: Circular Burner Diluted Partially-Premixed H2-air Lifted Flame in 2D configuration
 header:
   teaser: /assets/img/ico_sharma2024.png
-categories: reacting
+categories: 
+- reacting
+- jet
+- twoD
+- laminar
+- numerical 
 ---
 
 <div style="text-align: center;">

_datasets/wang2024.md

@@ -6,7 +6,13 @@ description: LES of an ensemble of wildfire spread
 header:
   image: /assets/img/wang2024.png
   teaser: /assets/img/ico_wang2024.png
-categories: reacting
+categories: 
+- reacting
+- environmental
+- threeD
+- turbulent
+- numerical
+- benchmark
 ---
 
 <!--

_includes/archive-single.html

@@ -10,7 +10,7 @@
   {% assign title = post.title %}
 {% endif %}
 
-<div class="{% if post.categories %}{{ post.categories }}{% endif %} {{ include.type | default: 'list' }}__item">
+<div class="{% if post.categories %}{% for category in post.categories %}{{ category }} {% endfor %}{% endif %} {{ include.type | default: 'list' }}__item">
   <article class="archive__item" itemscope itemtype="https://schema.org/CreativeWork"{% if post.locale %} lang="{{ post.locale }}"{% endif %}>
     {% if include.type == "grid" and teaser %}
       <div class="archive__item-teaser">