Update pages

Author: folmate

.github/workflows/deploy.yml

@@ -3,7 +3,7 @@ name: Deploy to GitHub Pages
 on:
   push:
     branches:
-      - main
+      - pages
     # Review gh actions docs if you want to further define triggers, paths, etc
     # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
 
@@ -51,5 +51,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4
-        
+        uses: actions/deploy-pages@v4

documentation/docs/setup/index.mdx

@@ -5,6 +5,8 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import {os2} from '@site/src/helpers/os.ts';
 import BrowserOnly from '@docusaurus/BrowserOnly';
+import Details from '@theme/Details';
+import CodeBlock from '@theme/CodeBlock';
 
 # Setup
 
@@ -20,14 +22,36 @@ The container also functions as a Remote Desktop Server (RDP) with preconfigured
 
 ## Build docker image
 
-Change directory to the repository. Expected location is `.../ProbabilisticGraphQuery$`
+In this repository, the `devenv` folder contains scripts and source files to recreate the development and measurement environment.
+
+<Details summary="Dockerfile for the environment">
+import Dockerfile from '!!../../src/helpers/partial-loader!!@site/../devenv/dockerfile';
+
+<CodeBlock language="c">{Dockerfile}</CodeBlock>
+</Details>
+
+
+Before cuntinuing, ensure that the current working driectory is `devenv` od the repository. (`ProbabilisticGraphQuery/devenv`)
 
 Build your own docker image with the following command:
-```
-docker build -t pgq-devenv devenv/dockerfile
-```
+
+
+<Tabs groupId="os">
+  <TabItem value="win" label="Windows">
+import BuildWin from '!!../../src/helpers/partial-loader?lines=5-*!!@site/../devenv/build.bat';
+
+    <CodeBlock language="bash">{BuildWin}</CodeBlock>
+  </TabItem>
+  <TabItem value="linux" label="Posix">
+    ```bash
+    docker build -t pgq-devenv dockerfile
+    ```
+  </TabItem>
+</Tabs>
+
 :::tip[Note]
-Downloading eclipse takes a lot of time. Be patient, or download the eclipse instance manually and replace `RUN wget 'https://www.eclipse.org/downloads ...` with `COPY <your file> eclipse.tar.gz`
+* Downloading eclipse takes a lot of time. Be patient, or download the eclipse instance manually and replace `RUN wget 'https://www.eclipse.org/downloads ...` with `COPY <your file> eclipse.tar.gz`
+* Building storm model checker can take up to an hour. It also takes significant memory to compile. To lower resource usage, adjust the `make -j12` flag in the dockerfile to use less CPU cores.
 :::
 
 Alternatively, import the image using the following command:
@@ -39,52 +63,53 @@ docker image load -i <my image file>
 ## Create container
 
 Create container with the following command.
-<Tabs groupId="data">
-    <TabItem value="posix" label="Linux">
+<Tabs groupId="os">
+    <TabItem value="win" label="Windows">
+import InitWin from '!!../../src/helpers/partial-loader?lines=5-*!!@site/../devenv/init.bat';
+
+    <CodeBlock language="bash">{InitWin}</CodeBlock>
+    </TabItem>
+    <TabItem value="linux" label="Posix">
     ```
     docker run -d -u root \
-      --name=pgq-devenv \
+      --name=pgq-devenv-storm \
       --security-opt seccomp=unconfined \
       -p 4100:3389 \
       --shm-size="1gb" \
       -v $(pwd):/config/ProbabilisticGraphQuery \
       pgq-devenv
     ```
     </TabItem>
-    <TabItem value="win" label="Windows">
-    ```
-    docker run -d -u root ^
-      --name=pgq-devenv ^
-      --security-opt seccomp=unconfined ^
-      -p 4100:3389 ^
-      --shm-size="1gb" ^
-      -v $(pwd):/config/ProbabilisticGraphQuery ^
-      pgq-devenv
-    ```
-    </TabItem>
+
 </Tabs>
 
 (Delayed) You can stop the container with:
 ```
-docker container stop pgq-devenv
+docker container stop pgq-devenv-storm 
 ```
 (Delayed) You can restart the container with:
 ```
-docker container start pgq-devenv
+docker container start pgq-devenv-storm 
 ```
 :::tip[Note]
 If you use `docker exec`, don't forget to set the user to `abc`.
 ```
-docker exec -u abc -it -w /config pgq-devenv /bin/bash
+docker exec -u abc -it -w /config pgq-devenv-storm /bin/bash
 ```
 :::
 
 ## Configuring container
 
+### Download compile runtime dependencies
+
+```
+docker exec -u abc -w /config/ProbabilisticGraphQuery/sources/hu.bme.mit.delta.api/libs/ pgq-devenv-storm ./download.sh
+docker exec -u abc -w /config/ProbabilisticGraphQuery/sources/hu.bme.mit.inf.measurement.utilities/libs/ pgq-devenv-storm ./download.sh
+```
+
+### Configure editor
+
 * Connect to the running container from an RDP client (address: `localhost:4100`, username: `abc`, password: `abc`)
-* Donload jar dependencies.
-  * `/config/ProbabilisticGraphQuery/sources/hu.bme.mit.delta.api/libs/download.sh`
-  * `/config/ProbabilisticGraphQuery/sources/hu.bme.mit.inf.measurement.utilities/libs/download.sh`
 * Launch Eclipse from `Applications -> Development -> Modeling 2024-03`
 * Pick a workplace. (Any directory works, but we recommend picking `/config/ProbabilisticGraphQuery/devenv/workplace`)
 * Import all projects from  `/config/ProbabilisticGraphQuery/sources` (`File -> Import -> General -> Existing Projects into Workspace -> Next -> Select root directory -> /config/ProbabilisticGraphQuery/sources -> Projects -> Select All -> Finish`)

documentation/docusaurus.config.ts

@@ -42,7 +42,7 @@ const config: Config = {
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
           editUrl:
-            'https://github.com/PELAB-LiU/ProbabilisticGraphQuery/TODO/docs',
+            'https://github.com/PELAB-LiU/ProbabilisticGraphQuery/blob/main/documentation',
         },
         blog: false,
         theme: {

documentation/src/helpers/partial-loader.js

@@ -0,0 +1,88 @@
+const path = require('path');
+
+/**
+ * import Setup2 from '!!../src/util/partial-loader?start=^static\ void\ [*]setup_main_stack[(]&end=^[}]!!@site/../example_solutions/2025/userprog/process.c';
+ * 
+ * @param {*} options 
+ * @returns 
+ */
+function functionLoader(lines, options){
+  var target = [];
+  const start = new RegExp(options.start);
+  const end = new RegExp(options.end);
+  var idx = 0;
+  while(idx<lines.length && !start.test(lines[idx])){
+    idx++;
+  }
+  while(idx<lines.length && !end.test(lines[idx])){
+    target.push(lines[idx]);
+    idx++;
+  }
+  if(idx<lines.length){
+    target.push(lines[idx]);
+  }
+  return target;
+}
+
+function lineLoader(lines, options){
+  var target = [];
+  options.lines.split(',').forEach(interval => {
+    if (interval.includes('-')) {
+      const numeric_interval = interval.replace('*',lines.length)
+
+      // Parse start and end of the range
+      const [start, end] = numeric_interval.split('-').map(num => parseInt(num.trim()));
+
+      if (isNaN(start) || isNaN(end) || start <=0 || end <= 0 || start > end || end > lines.length) {
+        throw new Error(`Invalid range: "${interval}".`);
+      }
+
+      // Collect elements within the range
+      for (let i = start; i <= end; i++) {
+        target.push(lines[i-1]);
+      }
+    } else {
+      // Parse single index
+      const index = parseInt(interval.trim())-1;
+      if (isNaN(index)) {
+        throw new Error(`Invalid index: "${interval}".`);
+      }
+      if (index >= 0 && index < lines.length) {
+        target.push(lines[index]);
+      }
+    }
+  });
+  return target;
+}
+
+/**
+ * A function to select specific lines from a raw text file.
+ * Specify: ?lines=(line|(start-end))[,(line|(start-end))]+
+ * @param {*} source 
+ * @returns 
+ */
+module.exports = function (source) {
+  // Split the content into lines and trim the first 5 lines
+  const contentLines = source.toString().split(/\r?\n/);
+  // Retrieve the query parameter (interval of lines to trim)
+  const options = this.getOptions() || {};
+
+  var target = [];
+
+  if(options.start && options.end){
+    target = functionLoader(contentLines, options);
+  } else if(options.lines){
+    target = lineLoader(contentLines, options);
+  } else {
+    target = contentLines;
+  }
+
+  // Join the remaining lines back together
+  const trimmedContent = target.join('\n');
+
+  // Return the processed content
+  return `module.exports = ${JSON.stringify(trimmedContent)}`;
+};
+
+// Webpack needs to know that the loader is usable for text files
+module.exports.raw = true; // Indicates that the loader can accept raw file buffers*/