Skip to content

Commit 305e020

Browse files
committed
update doc
1 parent 5f0a7dc commit 305e020

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

docs/source/pattern_simulation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ generated spots. Maps are built from specific cell templates:
1212

1313
* :func:`simfish.build_probability_map`
1414

15-
Several map are available in 2D or 3D:
15+
Several map are available in 3D:
1616

1717
* :func:`simfish.get_random_probability_map`
1818
* :func:`simfish.get_random_out_probability_map`

docs/source/utils.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,14 @@ Utility functions
66
.. currentmodule:: simfish
77

88
To simulate patterns consistent with cell morphology we use actual cell
9-
templates (dataset not available yet).
9+
templates. The dataset is available `here <https://doi.org/10.5281/zenodo.
10+
6106718>`_. This dataset includes 318 shapes (cell, nucleus and protrusion
11+
coordinates) we can used to build an authentic cell morphology. Precomputed
12+
distance maps and an index file saved as CSV are also available.
13+
14+
Download and extract the template dataset:
15+
16+
* :func:`simfish.load_extract_template`
1017

1118
Load an index dataframe that summarize templates metadata:
1219

@@ -17,6 +24,7 @@ Load and build templates:
1724
* :func:`simfish.build_templates`
1825
* :func:`simfish.build_template`
1926

27+
.. autofunction:: load_extract_template
2028
.. autofunction:: read_index_template
2129
.. autofunction:: build_templates
2230
.. autofunction:: build_template

0 commit comments

Comments
 (0)