Skip to content

Commit deae6db

Browse files
authored
Update README.md
1 parent c9f73ea commit deae6db

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
[![Licenses](https://img.shields.io/badge/license-bsd-orange.svg)](https://opensource.org/licenses/BSD-3-Clause)
55
[![GitHub Repository](https://img.shields.io/badge/GitHub-Repository-blue.svg)](https://github.com/nucleome/nucleserver)
66

7-
[*NucleServer*](http://doc.nucleome.org/data/server) is a simple standalone tool to host a data service for [*Nucleome Browser*](https://vis.nucleome.org). A typical usage is to host a set of cumtomized genome data files that is not on the default server, such as additional genome tracks in [bigWig](https://genome.ucsc.edu/goldenpath/help/bigWig.html), [bigBed](https://genome.ucsc.edu/goldenpath/help/bigBed.html) and [.hic](https://github.com/aidenlab/Juicebox/blob/master/HiC_format_v8.docx) formats. To facilitate users with limited commandline experience, we also implemented an simple GUI called [*NucleData*](https://github.com/nucleome/nucledata). However, it's only working for setting up a **local server** on a personal PC for now.
8-
7+
[*NucleServer*](http://doc.nucleome.org/data/server) is a simple standalone tool to host a genomic data service for [*Nucleome Browser*](https://vis.nucleome.org).
8+
A typical usage is to host a set of cumtomized genome data files that is not on the default server, such as additional genome tracks in [bigWig](https://genome.ucsc.edu/goldenpath/help/bigWig.html), [bigBed](https://genome.ucsc.edu/goldenpath/help/bigBed.html), [.hic](https://github.com/aidenlab/Juicebox/blob/master/HiC_format_v8.docx) and [tabix](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC3042176/) formats.
99

1010
## Quick Start
1111
This is a quick demo on setting up a typical server with sample data. To start, you can download the pre-compiled excutables from the main server (Current Build Version: 01-07-2020 v0.1.5). If they are not compatible to your machine, you can try to compile it from source.
@@ -26,6 +26,10 @@ The following command will start the data server.
2626
```
2727
nucleserver start -i nucle.xlsx
2828
```
29+
30+
Then open [Nucleome Browser](https://vis.nucleome.org/) to browse the bigBed data in Genome Browser Panel.
31+
32+
2933
If you would like to add local files.
3034

3135
- In the Config sheet, define the root variable as a PATH to the data folder, such as `/home/yourusername/trackdata`.

0 commit comments

Comments
 (0)