|
7 | 7 | | Information | Links | |
8 | 8 | | :-------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
9 | 9 | | **Package** | [][vuegen-pypi] [][vuegen-conda] [][vuegen-pypi] [][vuegen-docker-quay] [][vuegen-license] | |
10 | | -| **Documentation** | [][vuegen-docs] [](https://www.sphinx-doc.org/)  | |
| 10 | +| **Documentation** | [][vuegen-docs] [](https://www.sphinx-doc.org/)  | |
11 | 11 | | **Build** | [][ci-gh-action] [][ci-docs] | |
12 | 12 | | **Examples** | [][emp-html-demo] [][emp-st-demo] | |
13 | 13 | | **Discuss on GitHub** | [][issues] [][pulls] | |
@@ -129,7 +129,7 @@ vuegen --directory docs/example_data/Earth_microbiome_vuegen_demo_notebook --rep |
129 | 129 |
|
130 | 130 | ### Folder structure |
131 | 131 |
|
132 | | -Your input directory should follow a **nested folder structure**, where first-level folders are treated as **sections** and second-level folders as **subsections**, containing the components (plots, tables, networks, Markdown text, and HTML files). If the component files are in the first-level folders, an `overview` subsection will be created automatically. |
| 132 | +Your input directory should follow a **nested folder structure**, where first-level folders are treated as **sections** and second-level folders as **subsections**, containing the components (plots, tables, networks, Markdown text, and HTML files). If the component files are in the first-level folders, an `overview` subsection will be created automatically. |
133 | 133 |
|
134 | 134 | Here is an example layout: |
135 | 135 |
|
@@ -245,15 +245,15 @@ The **bundle GUI** with the VueGen package is available under the |
245 | 245 | You will need to unzip the file and run `vuegen_gui` in the unpacked main folder. |
246 | 246 | Most dependencies are included into the bundle using [PyInstaller][pyinstaller]. |
247 | 247 |
|
248 | | -Streamlit works out of the box as a purely Python based package. For the rest of report types you |
| 248 | +Streamlit works out of the box as a purely Python based package. For the rest of report types you |
249 | 249 | will have to have a **Python 3.12** installation with the `jupyter` package installed, as `quarto` needs to start |
250 | 250 | a kernel for execution. This is also true if you install `quarto` globally on your machine. |
251 | 251 |
|
252 | 252 | > [!TIP] |
253 | 253 | > It is advisable to create a virtual environment to manage depenendencies and avoid conflicts with existing packages. You can use the virtual environment manager of your choice, such as `poetry`, `conda`, or `pipenv`. We recommend using [miniforge][conda-download] to install Python and the `conda` package manager. |
254 | 254 |
|
255 | | -We assume you have installed the `miniforge` distribution for your machine (MacOS with arm64/ apple silicon |
256 | | -or x86_64/ intel or Windows x86_64). Also, download the |
| 255 | +We assume you have installed the `miniforge` distribution for your machine (MacOS with arm64/ apple silicon |
| 256 | +or x86_64/ intel or Windows x86_64). Also, download the |
257 | 257 | [latest `vuegen_gui` bundle](https://github.com/Multiomics-Analytics-Group/vuegen/releases/latest) |
258 | 258 | from the releases page according to your operating system. |
259 | 259 |
|
@@ -326,11 +326,10 @@ This advanced case study demonstrates the application of VueGen in a real-world |
326 | 326 |
|
327 | 327 | ### 3. ChatBot Component |
328 | 328 |
|
329 | | -This case study highlights VueGen’s capability to embed a chatbot component into a report subsection, |
330 | | -enabling interactive conversations inside the report. This component is streamlit-specific and is not |
| 329 | +This case study highlights VueGen’s capability to embed a chatbot component into a report subsection, |
| 330 | +enabling interactive conversations inside the report. This component is streamlit-specific and is not |
331 | 331 | available for other report types. |
332 | 332 |
|
333 | | - |
334 | 333 | Two API modes are supported: |
335 | 334 |
|
336 | 335 | - **Ollama-style streaming chat completion** |
@@ -359,7 +358,7 @@ to support more flexible and general-purpose response formats in future releases |
359 | 358 |
|
360 | 359 | Once a Streamlit report is generated, it can be deployed as a web application to make it accessible online. There are multiple ways to achieve this: |
361 | 360 |
|
362 | | -### Streamlit Community Cloud |
| 361 | +### Streamlit Community Cloud |
363 | 362 |
|
364 | 363 | Deploy your report easily using [Streamlit Cloud][st-cloud], as demonstrated in the [EMP VueGen Demo][emp-st-demo]. The process involves moving the necessary scripts, data, and a requirements.txt file into a GitHub repository. Then, the app can be deployed via the Streamlit Cloud interface. The deployment example is available in the `streamlit-report-example` branch. |
365 | 364 |
|
|
0 commit comments