ClementP commited on
Commit
875a806
·
verified ·
1 Parent(s): 8a4f801

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +73 -59
README.md CHANGED
@@ -1,59 +1,73 @@
1
- # DN-AI
2
-
3
- This is the official repository for DN-AI, an automated tool for measurement of differentiated DNA replication in fluorescence microscopy images.
4
-
5
- DN-AI offers different solutions for biologists to measure DNA replication in fluorescence microscopy images, without requiring programming skills. See the [Installation](#installation) section for instructions on how to install DN-AI.
6
-
7
- ## Features
8
-
9
- - **Automated DNA replication measurement**: DN-AI can automatically measure the amount of DNA replication in fluorescence microscopy images. We use a deep learning model to segment the images and measure the amount of DNA replication.
10
- - **User-friendly interface**: DN-AI provides a web-based user-friendly interface that allows users to easily upload images and view the results. Both jpeg and tiff images are supported.
11
- - **Batch processing**: DN-AI can process multiple images at once, making it easy to analyze large datasets. It also supports comparing ratios between different batches of images.
12
-
13
-
14
- ## Installation
15
-
16
- DN-AI relies on Python. We recommend installing its latest version (3.10 or higher) and using a virtual environment to avoid conflicts with other packages.
17
-
18
- ### Prerequisites
19
- Before installing DN-AI, make sure you have the following prerequisites installed:
20
- - [Python 3.10 or higher](https://www.python.org/downloads/)
21
- - [pip](https://pip.pypa.io/en/stable/installation/) (Python package installer)
22
-
23
- ### Python Package
24
- To install DN-AI as a Python package, you can use pip:
25
-
26
- ```bash
27
- pip install git+https://github.com/ClementPla/DeepFiberQ.git
28
- ```
29
-
30
-
31
- ### Graphical User Interface (GUI)
32
-
33
- To run the DN-AI graphical user interface, you can use the following command:
34
-
35
- ```bash
36
- DNAI
37
- ```
38
-
39
- Make sure you are running this command in the terminal where you have installed DN-AI. This will start a local web server and you will see output similar to:
40
-
41
-
42
- Then open your web browser and go to `http://localhost:8501` to access the DN-AI interface.
43
-
44
- Screenshots of the GUI:
45
-
46
- ![DN-AI GUI](imgs/screenshot.png)
47
-
48
-
49
-
50
- ### Docker
51
- A Docker image is available for DN-AI. You can pull the image from Docker Hub:
52
-
53
- ```bash
54
- docker pull clementpla/dnafiber
55
- ```
56
-
57
- ### Google Colab
58
- We also provide a Google Colab notebook for DN-AI. You can access it [here](https://colab.research.google.com/github/ClementPla/DeepFiberQ/blob/main/Colab/DNA_Fiber_Q.ipynb).
59
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: DNAI
3
+ emoji: 🚀
4
+ colorFrom: red
5
+ colorTo: red
6
+ sdk: docker
7
+ app_port: 8501
8
+ tags:
9
+ - streamlit
10
+ pinned: false
11
+ short_description: DNA Fiber semantic segmentation for replication assessment
12
+ license: mit
13
+ ---
14
+
15
+ # DN-AI
16
+
17
+ This is the official repository for DN-AI, an automated tool for measurement of differentiated DNA replication in fluorescence microscopy images.
18
+
19
+ DN-AI offers different solutions for biologists to measure DNA replication in fluorescence microscopy images, without requiring programming skills. See the [Installation](#installation) section for instructions on how to install DN-AI.
20
+
21
+ ## Features
22
+
23
+ - **Automated DNA replication measurement**: DN-AI can automatically measure the amount of DNA replication in fluorescence microscopy images. We use a deep learning model to segment the images and measure the amount of DNA replication.
24
+ - **User-friendly interface**: DN-AI provides a web-based user-friendly interface that allows users to easily upload images and view the results. Both jpeg and tiff images are supported.
25
+ - **Batch processing**: DN-AI can process multiple images at once, making it easy to analyze large datasets. It also supports comparing ratios between different batches of images.
26
+
27
+
28
+ ## Installation
29
+
30
+ DN-AI relies on Python. We recommend installing its latest version (3.10 or higher) and using a virtual environment to avoid conflicts with other packages.
31
+
32
+ ### Prerequisites
33
+ Before installing DN-AI, make sure you have the following prerequisites installed:
34
+ - [Python 3.10 or higher](https://www.python.org/downloads/)
35
+ - [pip](https://pip.pypa.io/en/stable/installation/) (Python package installer)
36
+
37
+ ### Python Package
38
+ To install DN-AI as a Python package, you can use pip:
39
+
40
+ ```bash
41
+ pip install git+https://github.com/ClementPla/DeepFiberQ.git
42
+ ```
43
+
44
+
45
+ ### Graphical User Interface (GUI)
46
+
47
+ To run the DN-AI graphical user interface, you can use the following command:
48
+
49
+ ```bash
50
+ DNAI
51
+ ```
52
+
53
+ Make sure you are running this command in the terminal where you have installed DN-AI. This will start a local web server and you will see output similar to:
54
+
55
+
56
+ Then open your web browser and go to `http://localhost:8501` to access the DN-AI interface.
57
+
58
+ Screenshots of the GUI:
59
+
60
+ ![DN-AI GUI](imgs/screenshot.png)
61
+
62
+
63
+
64
+ ### Docker
65
+ A Docker image is available for DN-AI. You can pull the image from Docker Hub:
66
+
67
+ ```bash
68
+ docker pull clementpla/dnafiber
69
+ ```
70
+
71
+ ### Google Colab
72
+ We also provide a Google Colab notebook for DN-AI. You can access it [here](https://colab.research.google.com/github/ClementPla/DeepFiberQ/blob/main/Colab/DNA_Fiber_Q.ipynb).
73
+