Skip to content

Commit 8d2ae09

Browse files
committed
Update README.md
1 parent 1dd5f54 commit 8d2ae09

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/dfci/CellBox/version_for_revision) [![Build Status](https://travis-ci.org/dfci/CellBox.svg?branch=master)](https://travis-ci.org/dfci/CellBox)
22

3+
# CellBox
4+
This is CellBox scripts developed in Sander lab.
5+
6+
Maintained by Bo Yuan and Judy Shen.
7+
8+
If you want to discuss the usage or to report a bug, please use the 'Issues' function here on GitHub.
9+
10+
If you find CellBox useful for your research, please consider citing the corresponding publication.
11+
bioRxiv: [link](https://www.biorxiv.org/content/10.1101/746842v3)
12+
13+
For more information, please find our contact information [here](https://www.sanderlab.org/#/).
314
# Quick Start
415

516
Easily try PertBio online with Binder
@@ -9,7 +20,7 @@ Easily try PertBio online with Binder
920
3. Run the following command for a short example of model training process:
1021

1122
```
12-
python scripts/main.py -config=configs/debugger.cellbox.json
23+
python scripts/main.py -config=configs/Example.random_partition.json
1324
```
1425

1526
Alternatively, in project folder, do the same command
@@ -65,7 +76,7 @@ pertbio.VERSION
6576
The experiment type configuration file is specified by --experiment_config_path OR -config
6677

6778
```
68-
python scripts/main.py -config=configs/random_partition.cfg.json
79+
python scripts/main.py -config=configs/Example.random_partition.cfg.json
6980
```
7081

7182
Note: always run the script in the root folder.
@@ -74,7 +85,7 @@ Note: always run the script in the root folder.
7485
A random seed can also be assigned by using argument --working_index OR -i
7586

7687
```
77-
python scripts/main.py -config=configs/random_partition.cfg.json -i=1234
88+
python scripts/main.py -config=configs/Example.random_partition.cfg.json -i=1234
7889
```
7990

8091

0 commit comments

Comments
 (0)