You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+45-5Lines changed: 45 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,12 @@
6
6
7
7
| Information | Links |
8
8
| :--- | :--- |
9
-
|**Package**|[][vuegen-pypi][][vuegen-pypi][![Docker Repository on Quay](https://quay.io/repository/dtu_biosustain_dsp/vuegen/status"Docker Repository on Quay")][vuegen-docker-quay]|
-[Credits and acknowledgements](#credits-and-acknowledgements)
23
+
-[Citation](#citation)
22
24
-[Contact and feedback](#contact-and-feedback)
23
25
24
26
## About the project
@@ -39,13 +41,14 @@ An extended version of the class diagram with attributes and methods is availabl
39
41
The VueGen documentation is available at [vuegen.readthedocs.io][vuegen-docs], where you can find detailed information of the package’s classes and functions, installation and execution instructions, and case studies to demonstrate its functionality.
40
42
41
43
## Installation
44
+
### Pip
42
45
Vuegen is available on [PyPI][vuegen-pypi] and can be installed using pip:
43
46
44
47
```bash
45
48
pip install vuegen
46
49
```
47
50
48
-
You can also install the package for development from this repository by running the following command:
51
+
You can also install the package for development by cloning this repository and running the following command:
49
52
50
53
```bash
51
54
pip install -e path/to/vuegen # specify location
@@ -55,6 +58,14 @@ pip install -e . # in case your pwd is in the vuegen directory
55
58
> [!TIP]
56
59
> It is recommended to install VueGen inside 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`.
57
60
61
+
### Conda
62
+
Vuegen is also available on [Bioconda][vuegen-conda] and can be installed using conda:
63
+
64
+
```bash
65
+
conda install bioconda::vuegen
66
+
```
67
+
68
+
### Dependencies
58
69
Vuegen uses [Quarto][quarto] to generate various report types. The pip insallation includes quarto using the [quarto-cli Python library][quarto-cli-pypi]. To test if quarto is installed in your computer, run the following command:
59
70
60
71
```bash
@@ -64,9 +75,13 @@ quarto check
64
75
> [!TIP]
65
76
> If quarto is not installed, you can download the command-line interface from the [Quarto website][quarto-cli] for your operating system.
66
77
78
+
### Docker
67
79
If you prefer not to install VueGen on your system, a pre-configured Docker container is available. It includes all dependencies, ensuring a fully reproducible execution environment. See the [Execution section](#execution) for details on running VueGen with Docker. The official Docker image is available at [quay.io/dtu_biosustain_dsp/vuegen][vuegen-docker-quay].
68
80
69
81
## Execution
82
+
> [!IMPORTANT]
83
+
> Here we use the `Earth_microbiome_vuegen_demo_notebook` directory and the `Earth_microbiome_vuegen_demo_notebook.yaml` configuration file as examples, which are available in the `docs/example_data` and `docs/example_config_files` folders, respectively. Make sure to clone this reposiotry to access these contents, or use your own directory and configuration file.
84
+
70
85
Run VueGen using a directory with the following command:
@@ -134,12 +149,36 @@ These options provide flexibility depending on whether the goal is online access
134
149
- VueGen relies on the work of numerous open-source projects like [Streamlit](streamlit), [Quarto][quarto], and others. A big thank you to their authors for making this possible!
135
150
- The vuegen logo was designed based on an image created by [Scriberia][scriberia] for The [Turing Way Community][turingway], which is shared under a CC-BY licence. The original image can be found at [Zenodo][zenodo-turingway].
136
151
152
+
## Citation
153
+
If you use VueGen in your research or publications, please cite it as follows:
154
+
155
+
**APA:**
156
+
157
+
Ayala-Ruano, S., Webel, H., & Santos, A. (2025). *VueGen: Automating the generation of scientific reports*. bioRxiv. https://doi.org/10.1101/2025.03.05.641152
158
+
159
+
**BibTeX:**
160
+
161
+
```bibtex
162
+
@article{Ayala-Ruano2025VueGen,
163
+
author = {Ayala-Ruano, Sebastian and Webel, Henry and Santos, Alberto},
164
+
title = {VueGen: Automating the generation of scientific reports},
We appreciate your feedback! If you have any comments, suggestions, or run into issues while using VueGen, feel free to [open an issue][new-issue] in this repository. Your input helps us make VueGen better for everyone.
0 commit comments