From 082edde0475a246528e8dc6fec0ad6538bf59601 Mon Sep 17 00:00:00 2001 From: moshi Date: Fri, 4 Aug 2023 23:30:04 +0900 Subject: [PATCH] Update README & docs --- README.md | 8 ++++---- docs/gui-docs/pgv-gui.md | 5 +++-- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 91d2b47..31ed67b 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ For more information, please see full documentation [here](https://moshi4.github :sparkles: GUI (Web browser) functionality is newly added from v0.4.0 ![pygenomeviz_gui.gif](https://raw.githubusercontent.com/moshi4/pyGenomeViz/main/src/pygenomeviz/gui/assets/pgv_demo.gif) -**Fig.2 pyGenomeViz GUI (Web browser) version example** +**Fig.2 pyGenomeViz GUI (Web browser) version example ([Demo Page](https://pygenomeviz.streamlit.app))** ## Installation @@ -395,9 +395,9 @@ Download example dataset: `pgv-download-dataset -n escherichia_coli` ## GUI (Web browser) -pyGenomeViz implements GUI (Web browser) functionality using [Streamlit](https://github.com/streamlit/streamlit) as an option. -Users can easily perform data visualization of Genbank files and genome comparison -results using MUMmer or MMseqs. See [pgv-gui document](https://moshi4.github.io/pyGenomeViz/gui-docs/pgv-gui/) for details. +pyGenomeViz implements GUI (Web browser) functionality using [streamlit](https://github.com/streamlit/streamlit) as an option ([Demo Page](https://pygenomeviz.streamlit.app)). +Users can easily perform data visualization of Genbank files and genome comparison results using MUMmer or MMseqs. +See [pgv-gui document](https://moshi4.github.io/pyGenomeViz/gui-docs/pgv-gui/) for details. ![pygenomeviz_gui.gif](https://raw.githubusercontent.com/moshi4/pyGenomeViz/main/src/pygenomeviz/gui/assets/pgv_demo.gif) diff --git a/docs/gui-docs/pgv-gui.md b/docs/gui-docs/pgv-gui.md index 6e023df..bffc81d 100644 --- a/docs/gui-docs/pgv-gui.md +++ b/docs/gui-docs/pgv-gui.md @@ -5,6 +5,7 @@ Users can easily perform data visualization of Genbank files and genome comparis results using MUMmer or MMseqs. ![pygenomeviz_gui.gif](https://raw.githubusercontent.com/moshi4/pyGenomeViz/main/src/pygenomeviz/gui/assets/pgv_demo.gif) +**Fig.pyGenomeViz GUI (Web browser) version example ([Demo Page](https://pygenomeviz.streamlit.app))** ## Installation @@ -21,7 +22,7 @@ MUMmer and MMseqs are also required to enable the genome comparison functionalit In Ubuntu22.04, MUMmer and MMseqs can be installed with apt command below. - sudo apt install mummer mmseqs + sudo apt install mummer mmseqs2 ### Docker @@ -29,6 +30,6 @@ In Ubuntu22.04, MUMmer and MMseqs can be installed with apt command below. ## Usage -The following command launches a GUI browser, which can be accessed at . +The following command launches a GUI browser, which can be accessed at . pgv-gui