Skip to content

Commit fb268fa

Browse files
committed
update README.md and add .env.example
1 parent 5a8849b commit fb268fa

File tree

1 file changed

+55
-2
lines changed

1 file changed

+55
-2
lines changed

README.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,55 @@
1-
# pathcomp
2-
# pathcomp
1+
# PathComp
2+
PathComp is a web-based competition for school ages participaants. This competition is forcused on asking the competition participants to attem to "Beat the Pathologists" by annotating a seriese of WSI. The competition is compsed of four levels: Mild, Hot, Spicy and Superchater. Participants begins from Mild level and correctly annotates at least half of the cells so that they can continue to the next level.
3+
4+
# Getting Started
5+
First, install
6+
- Docker [here](https://www.docker.com/get-started).
7+
- Docker-Compose [here](https://docs.docker.com/compose/install/)
8+
9+
# Annotation Data Setup
10+
There are two patch image folders for competition and practice.
11+
## Competition:
12+
It has 1, 2, 3 and 4 sub-folder which maps to Mild, Hot, Spicy and Superchager level respectively.
13+
14+
Each level folder must have **image** and **json** sub-folder. Any fatch image used for the competition has to be saved in **image** folder' and the ground true for each patch image has to be savved in **json** folder.
15+
16+
It is important that each fatch image and ground true have to the same name. e.g.) patch1.png -> patch1.json
17+
18+
## Practice
19+
At the moment, It has 1 and 2 which maps to Mild and Hot respectively.
20+
21+
The structure of each level folder is the same as the Competition.
22+
23+
# Setup Guide
24+
## Database Setup
25+
Copy .env.example to .env
26+
Set the datasetbse values
27+
- DB_ROOT_PASSWORD=
28+
- DB_NAME=
29+
- DB_USERNAME=
30+
- DB_PASSWORD=
31+
- DB_PORT=
32+
33+
Any database data is saved to **/mysql/data** folder.
34+
35+
## Development Setup
36+
Copy docker-compose.yml.example to docker-compose.yml
37+
38+
To run the PathComp
39+
```docker-compose
40+
docker-compose up -d
41+
```
42+
43+
To stop the PathComp
44+
```docker-compose
45+
docker-compose down
46+
```
47+
48+
# Annotation data for paticipants
49+
There is **annotation** folder existed.
50+
Each participant will have own folder in **annotation** folder based on an account.
51+
52+
Each participant folder havs two sub-folders: **competition** and **history**.
53+
- competition: keep data related to the current working on
54+
- history: keep data done previously
55+

0 commit comments

Comments
 (0)