Skip to content

Commit f5f396b

Browse files
committed
code doc update
1 parent 023e405 commit f5f396b

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

src/epicure/__init__.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
"""
2-
EpiCure: epithelia curation.
2+
**EpiCure: epithelia curation.**
33
44
Here, you can find the code API to guide you on the code organization, to call EpiCure functions from external scripts (e.g. jupyter notebooks) or to contribute to EpiCure's development.
55
66
EpiCure's main function is [epicuring](./epicure/epicuring.html). The classes [inspecting](./epicure/inspecting.html), [editing](./epicure/editing.html), [tracking](./epicure/tracking.html), [outputing](./epicure/outputing), [displaying](./epicure/displaying.html) corresponds to EpiCure Inspect, Edit, Track, Output and Display onglets respectively.
77
8+
The plugin is launched throught the [start epicuring](./epicure/start_epicuring.html) script that allows the user to choose the image to process, the corresponding segmentation and the epicure session parameters.
9+
810
The file [Utils](./epicure/Utils.html) contains a lot of small functions that are used by other functions and are general functions, independant of the current class/object.
911
"""

0 commit comments

Comments
 (0)