README.md 1.42 KB
Newer Older
David Kouřil's avatar
David Kouřil committed
1
## Chromoskein
kiraacorsac's avatar
init  
kiraacorsac committed
2

David Kouřil's avatar
David Kouřil committed
3
Chromoskein is a tool for visualizing genomic data with a special focus 3D chromatin structures predicted from Hi-C.
kiraacorsac's avatar
init  
kiraacorsac committed
4

David Kouřil's avatar
David Kouřil committed
5
*The project uses WebGPU which is currently under development. In order to run Chromoskein, you will need experimental versions of modern browsers. **We recommend Google Chrome Canary.***
kiraacorsac's avatar
init  
kiraacorsac committed
6

David Kouřil's avatar
David Kouřil committed
7
### Development
kiraacorsac's avatar
init  
kiraacorsac committed
8

David Kouřil's avatar
David Kouřil committed
9
Chromoskein is developed at [VisitLab](http://visitlab.fi.muni.cz) from Masaryk University, Brno, Czech Republic.
kiraacorsac's avatar
init  
kiraacorsac committed
10
11
12
13
14
15
16
17
18
19
20
21
22

#### Project initialization

Windows 10 (Creator's update and later): 
 - Enable 'Developer mode'
 - Clone with symlinks enabled
  
    `git clone -c core.symlinks=true`

Run dev server
- `cd app`
- `npm run serve`

David Kouřil's avatar
David Kouřil committed
23
24
#### Browser setup:
- Google Chrome Canary
25
    - Enable *Unsafe WebGPU* flag: `chrome://flags/#enable-unsafe-webgpu`
David Kouřil's avatar
David Kouřil committed
26
    - Make sure hardware acceleration is enabled: `chrome://settings/system` > Use hardware acceleration when available
27
        - Graphics status can be checked in: `chrome://gpu` 
28
    - Chromoskein on macOS refreshes when data is loaded in 3D viewport? Disable *Back-forward cache* flag: `chrome://flags/#back-forward-cache`. This is probably a bug in Chrome and the flag won't be needed in the future. 
David Kouřil's avatar
David Kouřil committed
29
30
31



kiraacorsac's avatar
init  
kiraacorsac committed
32
33


34
35
### Demo
Exemplary deployed version of ChromoSkein is available at https://visitlab.pages.fi.muni.cz/chromatin/chromoskein/
David Kouril's avatar
David Kouril committed
36

37
38
39
A demo workspace with sample dataset can be found under Workspace > Open exemplary workspace

![Demo workspace](app/demo-workspace.png)