Skip to content

Commit

Permalink
Update README & docs
Browse files Browse the repository at this point in the history
  • Loading branch information
moshi4 committed Aug 4, 2023
1 parent d07e24d commit 082edde
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)

Expand Down
5 changes: 3 additions & 2 deletions docs/gui-docs/pgv-gui.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -21,14 +22,14 @@ 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

docker run --rm -p 8501:8501 ghcr.io/moshi4/pygenomeviz:latest pgv-gui

## Usage

The following command launches a GUI browser, which can be accessed at <https://localhost:8501>.
The following command launches a GUI browser, which can be accessed at <http://localhost:8501>.

pgv-gui

0 comments on commit 082edde

Please sign in to comment.