Skip to content

Commit 83600c6

Browse files
github-actions[bot]github-actions[bot]
committed
Deployed 5fc7cac with MkDocs version: 1.6.1
0 parents  commit 83600c6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+9805
-0
lines changed

‎.nojekyll‎

Whitespace-only changes.

‎404.html‎

Lines changed: 209 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,209 @@
1+
<!DOCTYPE html>
2+
<html lang="en" data-bs-theme="light">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
8+
9+
10+
<link rel="shortcut icon" href="/img/favicon.ico">
11+
<title>StarryNight Documentation</title>
12+
<link href="/css/bootstrap.min.css" rel="stylesheet">
13+
<link href="/css/fontawesome.min.css" rel="stylesheet">
14+
<link href="/css/brands.min.css" rel="stylesheet">
15+
<link href="/css/solid.min.css" rel="stylesheet">
16+
<link href="/css/v4-font-face.min.css" rel="stylesheet">
17+
<link href="/css/base.css" rel="stylesheet">
18+
<link id="hljs-light" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" >
19+
<link id="hljs-dark" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css" disabled>
20+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
21+
<script>hljs.highlightAll();</script>
22+
</head>
23+
24+
<body>
25+
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
26+
<div class="container">
27+
<a class="navbar-brand" href="/.">StarryNight Documentation</a>
28+
<!-- Expander button -->
29+
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar-collapse" aria-controls="navbar-collapse" aria-expanded="false" aria-label="Toggle navigation">
30+
<span class="navbar-toggler-icon"></span>
31+
</button>
32+
33+
<!-- Expanded navigation -->
34+
<div id="navbar-collapse" class="navbar-collapse collapse">
35+
<!-- Main navigation -->
36+
<ul class="nav navbar-nav">
37+
<li class="nav-item">
38+
<a href="/." class="nav-link">Home</a>
39+
</li>
40+
<li class="nav-item dropdown">
41+
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Getting Started</a>
42+
<ul class="dropdown-menu">
43+
44+
<li>
45+
<a href="/getting-started/installation/" class="dropdown-item">Installation</a>
46+
</li>
47+
48+
<li>
49+
<a href="/getting-started/quickstart/" class="dropdown-item">Quick Start Guide</a>
50+
</li>
51+
</ul>
52+
</li>
53+
<li class="nav-item dropdown">
54+
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">User Guide</a>
55+
<ul class="dropdown-menu">
56+
57+
<li>
58+
<a href="/user/core-concepts/" class="dropdown-item">Core Concepts</a>
59+
</li>
60+
61+
<li>
62+
<a href="/user/parser-configuration/" class="dropdown-item">Parser Configuration</a>
63+
</li>
64+
65+
<li>
66+
<a href="/user/modules/" class="dropdown-item">Processing Modules</a>
67+
</li>
68+
69+
<li>
70+
<a href="/user/example-pipeline-cli/" class="dropdown-item">Example CLI Pipeline</a>
71+
</li>
72+
</ul>
73+
</li>
74+
<li class="nav-item dropdown">
75+
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Algorithms</a>
76+
<ul class="dropdown-menu">
77+
78+
<li>
79+
<a href="/user/algorithms/" class="dropdown-item">Overview</a>
80+
</li>
81+
82+
<li>
83+
<a href="/user/algorithms/DOCUMENTATION_GUIDE/" class="dropdown-item">Documentation Guide</a>
84+
</li>
85+
86+
<li>
87+
<a href="/user/algorithms/illum_calc/" class="dropdown-item">Illumination Calculation</a>
88+
</li>
89+
90+
<li>
91+
<a href="/user/algorithms/illum_apply/" class="dropdown-item">Illumination Apply</a>
92+
</li>
93+
94+
<li>
95+
<a href="/user/algorithms/align/" class="dropdown-item">Alignment</a>
96+
</li>
97+
98+
<li>
99+
<a href="/user/algorithms/preprocess/" class="dropdown-item">Preprocessing</a>
100+
</li>
101+
102+
<li>
103+
<a href="/user/algorithms/presegcheck/" class="dropdown-item">Pre-segmentation Check</a>
104+
</li>
105+
106+
<li>
107+
<a href="/user/algorithms/segcheck/" class="dropdown-item">Segmentation Check</a>
108+
</li>
109+
110+
<li>
111+
<a href="/user/algorithms/stitchcrop/" class="dropdown-item">Stitch and Crop</a>
112+
</li>
113+
114+
<li>
115+
<a href="/user/algorithms/analysis/" class="dropdown-item">Analysis</a>
116+
</li>
117+
</ul>
118+
</li>
119+
<li class="nav-item dropdown">
120+
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Development</a>
121+
<ul class="dropdown-menu">
122+
123+
<li>
124+
<a href="/developer/developer-guide/" class="dropdown-item">Developer Guide</a>
125+
</li>
126+
</ul>
127+
</li>
128+
<li class="nav-item">
129+
<a href="/misc/faq/" class="nav-link">FAQ</a>
130+
</li>
131+
</ul>
132+
133+
<ul class="nav navbar-nav ms-md-auto">
134+
<li class="nav-item">
135+
<a href="https://github.com/broadinstitute/starrynight" class="nav-link"><i class="fa-brands fa-github"></i> GitHub</a>
136+
</li>
137+
</ul>
138+
</div>
139+
</div>
140+
</div>
141+
142+
<div class="container">
143+
<div class="row">
144+
145+
<div class="row-fluid">
146+
<div id="main-content" class="span12">
147+
<h1 id="404-page-not-found" style="text-align: center">404</h1>
148+
<p style="text-align: center"><strong>Page not found</strong></p>
149+
</div>
150+
</div>
151+
152+
153+
</div>
154+
</div>
155+
156+
<footer class="col-md-12">
157+
<hr>
158+
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
159+
</footer>
160+
<script src="/js/bootstrap.bundle.min.js"></script>
161+
<script>
162+
var base_url = "/",
163+
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
164+
</script>
165+
<script src="/js/base.js"></script>
166+
167+
<div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
168+
<div class="modal-dialog">
169+
<div class="modal-content">
170+
<div class="modal-header">
171+
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
172+
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
173+
</div>
174+
<div class="modal-body">
175+
<table class="table">
176+
<thead>
177+
<tr>
178+
<th style="width: 20%;">Keys</th>
179+
<th>Action</th>
180+
</tr>
181+
</thead>
182+
<tbody>
183+
<tr>
184+
<td class="help shortcut"><kbd>?</kbd></td>
185+
<td>Open this help</td>
186+
</tr>
187+
<tr>
188+
<td class="next shortcut"><kbd>n</kbd></td>
189+
<td>Next page</td>
190+
</tr>
191+
<tr>
192+
<td class="prev shortcut"><kbd>p</kbd></td>
193+
<td>Previous page</td>
194+
</tr>
195+
<tr>
196+
<td class="search shortcut"><kbd>s</kbd></td>
197+
<td>Search</td>
198+
</tr>
199+
</tbody>
200+
</table>
201+
</div>
202+
<div class="modal-footer">
203+
</div>
204+
</div>
205+
</div>
206+
</div>
207+
208+
</body>
209+
</html>

‎assets/create_starrynight_example.sh‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
2+
BUCKET=XXXXXX
3+
PROJECT=XXXXXX
4+
BATCH=XXXXXX
5+
6+
export S3_PATH="s3://${BUCKET}/projects/${PROJECT}/${BATCH}"
7+
export INPUT_DIR='./scratch/starrynight_example_input'
8+
export OUTPUT_BASELINE_DIR='./scratch/starrynight_example_output_baseline'
9+
10+
# Inputs
11+
12+
## SBS images
13+
14+
parallel mkdir -p ${INPUT_DIR}/Source1/Batch1/images/Plate1/20X_c{1}_SBS-{1}/ ::: 1 2 3
15+
16+
parallel --match '.*' --match '(.*) (.*) (.*)' \
17+
aws s3 cp "${S3_PATH}/images/Plate1/20X_c{1}_SBS-{1}/Well{2.1}_Point{2.1}_{2.2}_ChannelC,A,T,G,DAPI_Seq{2.3}.ome.tiff" \
18+
"${INPUT_DIR}/Source1/Batch1/images/Plate1/20X_c{1}_SBS-{1}/" ::: \
19+
1 2 3 ::: \
20+
"A1 0000 0000" "A1 0001 0001" "A2 0000 1025" "A2 0001 1026" "B1 0000 3075" "B1 0001 3076"
21+
22+
## Cell Painting images
23+
24+
mkdir -p ${INPUT_DIR}/Source1/Batch1/images/20X_CP_Plate1_20240319_122800_179
25+
26+
parallel --match '(.*) (.*) (.*)' \
27+
aws s3 cp "${S3_PATH}/images/Plate1/20X_CP_Plate1_20240319_122800_179/Well{1.1}_Point{1.1}_{1.2}_ChannelPhalloAF750,ZO1-AF488,DAPI_Seq{1.3}.ome.tiff" \
28+
"${INPUT_DIR}/Source1/Batch1/images/Plate1/20X_CP_Plate1_20240319_122800_179/" ::: \
29+
"A1 0000 0000" "A1 0001 0001" "A2 0000 1025" "A2 0001 1026" "B1 0000 3075" "B1 0001 3076"
30+
31+
# Outputs
32+
33+
## Illumination correction images
34+
35+
mkdir -p ${OUTPUT_BASELINE_DIR}/Source1/Batch1/illum/Plate1
36+
parallel \
37+
aws s3 cp "${S3_PATH}/illum/Plate1/Plate1_Cycle{1}_Illum{2}.npy" "${OUTPUT_BASELINE_DIR}/Source1/Batch1/illum/Plate1/" ::: \
38+
1 2 3 ::: \
39+
DNA A T G C
40+
41+
parallel \
42+
aws s3 cp "${S3_PATH}/illum/Plate1/Plate1_Illum{1}.npy" "${OUTPUT_BASELINE_DIR}/Source1/Batch1/illum/Plate1/" ::: \
43+
DNA Phalloidin ZO1
44+
45+
## Cell Painting images: Illumination corrected
46+
47+
parallel \
48+
aws s3 cp "${S3_PATH}/images_corrected/painting/Plate1-Well{1}/Plate_Plate1_Well_Well{1}_Site_{2}_Corr{3}.tiff" \
49+
"${OUTPUT_BASELINE_DIR}/Source1/Batch1/images_corrected/painting/Plate1-Well{1}/" ::: \
50+
A1 A2 B1 ::: 0 1 ::: DNA Phalloidin ZO1
51+
52+
parallel \
53+
aws s3 cp "${S3_PATH}/images_corrected/painting/Plate1-Well{1}/PaintingIllumApplication_{2}.csv" \
54+
"${OUTPUT_BASELINE_DIR}/Source1/Batch1/images_corrected/painting/Plate1-Well{1}/" ::: \
55+
A1 A2 B1 ::: Cells ConfluentRegions Experiment Image Nuclei
56+
57+
# SBS images: Illumination aligned
58+
59+
parallel \
60+
aws s3 cp "${S3_PATH}/images_aligned/barcoding/Plate1-Well{1}-{2}/Plate_Plate1_Well_{1}_Site_{2}_Cycle0{3}_{4}.tiff" \
61+
"${OUTPUT_BASELINE_DIR}/Source1/Batch1/images_aligned/barcoding/Plate1-Well{1}-{2}/" ::: \
62+
A1 A2 B1 ::: 0 1 ::: 1 2 3 ::: A T G C DAPI
63+
64+
65+
parallel \
66+
aws s3 cp "${S3_PATH}/images_aligned/barcoding/Plate1-Well{1}-{2}/BarcodingApplication_{3}.csv" \
67+
"${OUTPUT_BASELINE_DIR}/Source1/Batch1/images_aligned/barcoding/Plate1-Well{1}-{2}/" ::: \
68+
A1 A2 B1 ::: 0 1 ::: Experiment Image
69+
70+
## SBS images: Illumination corrected
71+
72+
parallel \
73+
aws s3 cp "${S3_PATH}/images_corrected/barcoding/Plate1-Well{1}-{2}/Plate_Plate1_Well_{1}_Site_{2}_Cycle0{3}_{4}.tiff" \
74+
"${OUTPUT_BASELINE_DIR}/Source1/Batch1/images_corrected/barcoding/Plate1-Well{1}-{2}/" ::: \
75+
A1 A2 B1 ::: 0 1 ::: 1 2 3 ::: A T G C
76+
77+
parallel \
78+
aws s3 cp "${S3_PATH}/images_corrected/barcoding/Plate1-Well{1}-{2}/Plate_Plate1_Well_{1}_Site_{2}_Cycle0{3}_{4}.tiff" \
79+
"${OUTPUT_BASELINE_DIR}/Source1/Batch1/images_corrected/barcoding/Plate1-Well{1}-{2}/" ::: \
80+
A1 A2 B1 ::: 0 1 ::: 1 ::: DAPI
81+
# DAPI is present only in the first cycle
82+
83+
84+
parallel \
85+
aws s3 cp "${S3_PATH}/images_corrected/barcoding/Plate1-Well{1}-{2}/BarcodePreprocessing_{3}.csv" \
86+
"${OUTPUT_BASELINE_DIR}/Source1/Batch1/images_corrected/barcoding/Plate1-Well{1}-{2}/" ::: \
87+
A1 A2 B1 ::: 0 1 ::: BarcodeFoci PreFoci Experiment Image Nuclei
88+
89+
## Segmentation images
90+
91+
parallel \
92+
aws s3 cp "${S3_PATH}/images_segmentation/Plate1/Plate_Plate1_Well_Well{1}_Site_{2}_Corr{3}_SegmentCheck.png" \
93+
"${OUTPUT_BASELINE_DIR}/Source1/Batch1/images_segmentation/Plate1/" ::: \
94+
A1 A2 B1 ::: 0 ::: DNA
95+
96+
parallel \
97+
aws s3 cp "${S3_PATH}/images_segmentation/Plate1/Plate_Plate1_Well_Well{1}_Site_{2}_Corr{3}_SegmentCheck.png" \
98+
"${OUTPUT_BASELINE_DIR}/Source1/Batch1/images_segmentation/Plate1/" ::: \
99+
A1 A2 B1 ::: 0 ::: DNA
100+
101+
parallel \
102+
aws s3 cp "${S3_PATH}/images_segmentation/Plate1/SegmentationCheck_{1}.csv" \
103+
"${OUTPUT_BASELINE_DIR}/Source1/Batch1/images_segmentation/Plate1/" ::: \
104+
Experiment Image Nuclei Cells PreCells ConfluentRegions
105+
106+
## Load Data CSVs
107+
108+
export S3_PATH_WORKSPACE="s3://${BUCKET}/projects/${PROJECT}/workspace"
109+
110+
aws s3 sync \
111+
"${S3_PATH_WORKSPACE}/load_data_csv/${BATCH}/Plate1/" \
112+
"${OUTPUT_BASELINE_DIR}/Source1/workspace_example/load_data_csv/Batch1/Plate1/"
113+
114+
## Analysis CSVs
115+
116+
parallel \
117+
aws s3 sync \
118+
"${S3_PATH_WORKSPACE}/analysis/${BATCH}/Plate1-Well{1}-{2}/" \
119+
"${OUTPUT_BASELINE_DIR}/Source1/workspace_example/analysis/${BATCH}/Plate1-Well{1}-{2}/" \
120+
--exclude \""*.csv\"" ::: \
121+
A1 A2 B1 ::: 0 1
122+
123+
124+
parallel \
125+
aws s3 sync \
126+
"${S3_PATH_WORKSPACE}/analysisfix/${BATCH}/Plate1-Well{1}-{2}/" \
127+
"${OUTPUT_BASELINE_DIR}/Source1/workspace_example/analysis/${BATCH}/Plate1-Well{1}-{2}/" ::: \
128+
A1 A2 B1 ::: 0 1
129+
# Note that the analysis files are synced from two different locations: analysis and analysisfix.
130+
# analysisfix was a rerun of analysis
131+
132+
# Compress files to reduce disk usage after downloading
133+
echo "Compressing files to reduce disk usage..."
134+
135+
## Compress all TIFF files
136+
find ${OUTPUT_BASELINE_DIR} -type f -name "*.tiff" | parallel 'magick {} -compress jpeg -quality 80 {}'
137+
find ${INPUT_DIR} -type f -name "*.tiff" | parallel 'magick {} -compress jpeg -quality 80 {}'
138+
139+
# Compress CSV files
140+
find ${OUTPUT_BASELINE_DIR} -type f -name "*.csv" | parallel 'gzip -9 {}'

0 commit comments

Comments
 (0)