Skip to content

Commit 64672ba

Browse files
committed
Merge branch 'main' of github.com:bencardoen/SubPrecisionContactDetection.jl
2 parents 2f8e98d + ed9de56 commit 64672ba

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

docs/src/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# SubPrecisionContactDetection.jl Documentation
22

33
Welcome to the documentation for this package.
4+
This holds the implementation for [MCS-DETECT, published in JCB](https://doi.org/10.1083/jcb.202206109).
45
Please see the sidebar for relevant sections.
56

67
This package offers variable distance contact detection between two images (2/3D) when segmentation is not sufficiently accurate.

docs/src/tutorial.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,19 @@ For example:
4848

4949
![example](./assets/interactive.png)
5050

51+
This would work like this:
52+
53+
```julia
54+
using Pkg; Pkg.activate("."); # <CTRL+ENTER>
55+
using SubPrecisionContactDetection; # <CTRL+ENTER>
56+
@info "Test"; #CTRL+ENTER
57+
defs = get_defaults(); #CTRL+ENTER
58+
```
5159

5260
## Julia API
5361
While you can call the scripts from the command line, you can also do so from within Julia:
5462

5563
```julia
5664
using SubPrecisionInteractionDetection
5765
twochannel_contats(get_defaults());
58-
```
66+
```

0 commit comments

Comments
 (0)