Skip to content

Commit be98c5d

Browse files
committed
improve documentation
1 parent e828675 commit be98c5d

File tree

4 files changed

+74
-0
lines changed

4 files changed

+74
-0
lines changed
90.9 KB
Loading
49.3 KB
Loading
52.8 KB
Loading

src/docs/asciidoc/index.adoc

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,77 @@ Jorge Aguilera <jorge@incsteps.com>
33
:toc: left
44
:imagesdir: images
55

6+
A Nextflow plugin that provides a web-based interface for visualizing and exploring Nextflow pipeline executions directly in your browser.
7+
8+
== Overview
9+
10+
nf-cachebrowser is a powerful Nextflow plugin that allows you to visualize pipeline executions through an intuitive web interface.
11+
Monitor your workflows, explore execution details, and analyze pipeline performance without leaving your browser.
12+
13+
== Features
14+
15+
- 🌐 **Web-based Interface** - Access pipeline execution data through a modern web UI
16+
- 📊 **Real-time Monitoring** - Track running pipelines in real-time (only in not blocking supported storages)
17+
- 🔍 **Detailed Execution View** - Explore individual process executions and their outputs
18+
- 📈 **Performance Analytics** - Analyze execution times, resource usage, and bottlenecks
19+
- 🗂️ **Cache Management** - Browse and manage Nextflow work directories and cached results
20+
- 🔄 **Resume Capabilities** - Visualize pipeline resume points and execution flow
21+
- 📱 **Responsive Design** - Works seamlessly on desktop and mobile devices
22+
23+
== Screenshots
24+
25+
First, run some pipeline with `--resume` flag
26+
27+
[source]
28+
----
29+
nextflow run hello --resume
30+
----
31+
32+
After some executions run the plugin:
33+
34+
[source]
35+
----
36+
nextflow plugin nf-cachebrowser:run
37+
----
38+
39+
The run command execute a web server at port 9999 so you can navigate to http://localhost:9999
40+
41+
INFO:: By the moment, to close the web server you need to send a kill signal (or Ctrl+C)
42+
43+
.executions list
44+
image::screenshot1.png[]
45+
46+
.execution tasks list
47+
image::screenshot2.png[]
48+
49+
.task detail
50+
image::screenshot3.png[]
51+
52+
== Parameters
53+
54+
- -p --port , the web server port, 9999 by default
55+
56+
- --directory, the directory where .nextflow is located, current dir by default
57+
58+
59+
== Local Storage (default)
60+
61+
nf-cachebrowser is able to visualize different "storages".
62+
63+
Typical storage is "local", the default implementation of Nextflow, using an embedded database to store all
64+
executions details located in the `.nextflow/cache` folder
65+
66+
WARNING:: Due the blocking nature of the library used by Nextflow, two process *can't* read/write at the same time
67+
the database, so use nf-cachebrowser once your pipelines are ended.
68+
69+
== DuckDB Storage (experimental)
70+
71+
Incremental Steps has been working in `nf-duckdbcache` plugin to reemplace the default implementation.
72+
73+
DuckDB allows multiple process to access to the database so it expected you can execute pipelines and at the same
74+
time use nf-cachebrowser
75+
76+
== Postgres Storage (TODO!!)
77+
78+
In the same way as DuckDB database, we're working in a plugin to use Postgres as cache. nf-cachebrowser will allow
79+
inspect this storage

0 commit comments

Comments
 (0)