Skip to content

Commit 46a1c2f

Browse files
committed
v5.8.1
Two small upgrades to A&S. Clean ext.tar.gz
1 parent 078306f commit 46a1c2f

12 files changed

Lines changed: 371 additions & 245 deletions

File tree

docs/MUMmer.html

Lines changed: 60 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
<a href="#mfiles">MUMmer files</a>
1717
<a href="#log">Finding the problem</a>
1818
<a href="#mem">Out of Memory</a>
19+
<a href="#toobig">Input file too big</a>
20+
<a href="#fail2">One or more fails</a>
1921
<a href="#cmd">MUMmer from the command line</a>
2022
<a href="#help">Getting Help</a>
2123
<p>&nbsp;
@@ -70,11 +72,12 @@
7072
<tr><td><a href="#mem">Out of Memory</a>
7173
<tr><td>&nbsp;&nbsp;&nbsp;<a href="#cat">Limit CPUs and uncheck Concat</a>
7274
<tr><td>&nbsp;&nbsp;&nbsp;<a href="#mask">Not-masked or Soft-masked</a>
73-
<tr><td>&nbsp;&nbsp;&nbsp;<a href="#fail2">One or more alignments fail</a>
75+
<tr><td><a href="#toobig">Input file too big</a>
7476
</table>
7577
<td>&nbsp;&nbsp;&nbsp;
7678
<td style="vertical-align: text-top;">
7779
<table>
80+
<tr><td><a href="#fail2">One or more alignments fail</a>
7881
<tr><td><a href="#cmd">MUMmer from the command line</a>
7982
<tr><td>&nbsp;&nbsp;&nbsp;<a href="#example">Example</a>
8083
<tr><td><a href="#mum">MUMmer parameters</a>
@@ -93,9 +96,9 @@ <h2>MUMmer files</h2>
9396
For example,
9497
<pre>
9598
data/seq_results/demo_seq_to_demo_seq2/align> ls
96-
all.done demo_seq_cc.demo_seq2_f2.mum
97-
demo_seq_cc.demo_seq2_f1.mum demo_seq_cc.demo_seq2_f2.mum.done
98-
demo_seq_cc.demo_seq2_f1.mum.done
99+
all.done demo_seq_c1.demo_seq2_f2.mum
100+
demo_seq_c1.demo_seq2_f1.mum demo_seq_c1.demo_seq2_f2.mum.done
101+
demo_seq_c1.demo_seq2_f1.mum.done
99102
</pre>
100103

101104
<p>All MUMmer files but those with the <tt>.mum</tt> suffix are removed by <ttp>symap</ttp>. If you prefer them not to be removed,
@@ -117,8 +120,14 @@ <h2>Finding the problem</h2>
117120
<p>If the MUMmer alignment fails:
118121
<ul>
119122
<li>Check that the sequences loaded correctly using the <ttb>View</ttb> option on the <ttp>Manager</ttp>.
120-
<li>If the files loaded correctly, check the <a href="#ext">Executables</a>.
123+
<li>If the files loaded correctly, check the <a href="#ext">Executables</a>. On Mac, the executables may need to be verified.
121124
<li>If the executables are okay, inspect the log files.
125+
<ul>
126+
<li>There may not be enough memory, see <a href="#mem">Memory</a>.
127+
<li>The input files may be too large, see <a href="#toobig">Too big</a>.
128+
<li>On my 2018 MacOS x86_64 it sometimes fails, I have to reboot and then it works.
129+
<li>If you encounter a different problem, I would appreciate if you let me know so I can add it to this webpage.
130+
</ul>
122131
</ul>
123132
<h3>Log files</h3>
124133
<p>Using <tt>p1</tt> = <tt>project-name1</tt> and <tt>p2</tt> = <tt>project-name2</tt>
@@ -129,21 +138,21 @@ <h3>Log files</h3>
129138

130139
logs/
131140
&lt;p1&gt;-to-&lt;p2&gt;/ # one directory per project-to-project alignment
132-
&lt;p1_cc.p2_f1&gt;.log # MUMmer terminal output - one file per MUMmer process
133-
&lt;p1_cc.p2_f2&gt;.log # fn is n=1,2... for number of processes, e.g f2 is 2nd process
141+
&lt;p1_c1.p2_f1&gt;.log # MUMmer terminal output - one file per MUMmer alignment
142+
&lt;p1_c1.p2_f2&gt;.log # 2nd alignment....
134143
symap.log # keeps most of the SyMAP output shown on the terminal for this A&S
135144
</pre>
136145

137146
e.g. <tt>p1</tt> = <tt>demo_seq</tt> and <tt>p2</tt> = <tt>demo_seq2</tt>
138147
<pre>
139148
demo_seq_to_demo_seq2/
140-
demo_seq_cc.demo_seq2_f1.log # MUMmer output directed to this file for process 1
141-
demo_seq_cc.demo_seq2_f2.log # MUMmer output directed to this file for process 2
149+
demo_seq_c1.demo_seq2_f1.log # MUMmer output directed to this file for process 1
150+
demo_seq_c1.demo_seq2_f2.log # MUMmer output directed to this file for process 2
142151
symap.log # SyMAP terminal output
143152
</pre>
144153

145154
&rarr; If an alignment is listed as failed in the <tt>error.log</tt> file,
146-
the corresponding <tt>&lt;p1_cc.p2_fn&gt;.log</tt> file will contain the MUMmer error
155+
the corresponding <tt>&lt;p1_c1.p2_fn&gt;.log</tt> file will contain the MUMmer error
147156
(see <a href="img/mummerLog.png">example mummer log</a>).
148157
<p>&rarr;
149158
If the error is not found in the log files or the error is not clear, try the following:
@@ -152,9 +161,9 @@ <h3>Log files</h3>
152161
<p>
153162
<pre>
154163
> ext/mummer/mac/promer
155-
-p data/seq_results/demo_seq_to_demo_seq2/align/demo_seq_cc.demo_seq2_f2.promer
164+
-p data/seq_results/demo_seq_to_demo_seq2/align/demo_seq_c1.demo_seq2_f2.promer
156165
data/seq_results/demo_seq_to_demo_seq2/tmp/demo_seq2/demo_seq2_f2.fa
157-
data/seq_results/demo_seq_to_demo_seq2/tmp/demo_seq/demo_seq_cc.fa
166+
data/seq_results/demo_seq_to_demo_seq2/tmp/demo_seq/demo_seq_c1.fa
158167
</pre>
159168
This shows <tt>promer</tt> output directly on the terminal and provides a better description of the problem.
160169

@@ -194,22 +203,21 @@ <h3>Executables</h3>
194203
</pre>
195204
The above shows that the promer code will execute on my MacOS.
196205

197-
<p><font color="red"><u>Executable on MacOS</u></font>:
206+
<p><font color="green"><u>Executable on MacOS</u></font>:
198207
Any executable that has not been okayed by Apple results in the error message
199208
<pre>
200209
Apple could not verify "prepro" is free of malware that may harm your mac...
201210
</pre>
202-
203211
See <a href="TroubleShoot.html#macos" class="ext" target="_blank">MacOS External</a> for the fix.
204212

205213
<!-------------------------------------------------->
206214
<a id="mem"></a>
207215
<h2>Out of memory</h2>
208216

209217
<table class="tz"><tr>
210-
<td><a href="#cat">Limit CPUs and<br>uncheck Concat</a>
211-
<td><a href="#mask">Not-masked or<br>Soft-masked</a>
212-
<td><a href="#fail2">One or more<br>alignments fail</a>
218+
<td><a href="#cat">Limit CPUs and uncheck Concat</a>
219+
<td><a href="#mask">Not-masked or Soft-masked</a>
220+
213221
<td class="colrt"><a href="#top">Go to top</a>
214222
</table>
215223
<p>A MUMmer failure is typically from insufficient memory.
@@ -233,7 +241,6 @@ <h2>Out of memory</h2>
233241
</pre>
234242
The error code will appear on the terminal and the MUMmer log file,
235243
but not in <tt>symap/logs/&lt;..&gt;/symap.log</tt>.
236-
237244
<!----------------------------------------------------->
238245
<a id="cat"></a>
239246
<h3>Limit CPUs and uncheck Concat</h3>
@@ -244,7 +251,7 @@ <h3>Limit CPUs and uncheck Concat</h3>
244251
first try running again with reduced <ttl>CPUs</ttl> and unchecked <ttl>Concat</ttl>:
245252
<ol>
246253
<li>On the <ttb>Project Manager</ttb> panel, limit the number of CPUs, as each
247-
CPU uses a considerable amount of memory (e.g. 4 CPUs could collectively use 20GB of memory at once).
254+
CPU uses a considerable amount of memory (e.g. 4 CPUs could collectively use 24G of memory at once).
248255
See <a href="SystemHelp.html#cpu" class="ext" target="_blank">CPU</a> for further information.
249256
<p><li>
250257
In the <ttb>Project Parameters</ttb> panel, uncheck <ttl>Concat</ttl> to reduce the
@@ -262,16 +269,36 @@ <h3>Not-masked or Soft-masked</h3>
262269
all sequence but the genes.
263270
</ul>
264271

272+
<!----------------------------------------------------->
273+
<a id="toobig"></a>
274+
<h2>Input file too big</h2>
275+
Another error that can occur is the following:
276+
<p><pre>
277+
./ext/mummer/macM4/mummer:
278+
cannot open file "data/seq_results/Mus_to_Rab/align/Mus_cc.Rab_f1.promer.aaqry"
279+
or file "data/seq_results/Mus_to_Rab/align/Mus_cc.Rab_f1.promer.aaqry" is empty
280+
</pre>
281+
The MUMmer temporary files will have been created, but the <tt>.aaqry</tt> file is all zeros, hence,
282+
MUMmer could not produce the final results.
283+
The appears to happen when the input it very big, e.g. &gt;1G (one gigabyte).
284+
If this happens, deselect <ttl>Concat</ttl>.
285+
<p>
286+
Using pre-v5.8.1 release with <ttl>Concat</ttl> selected, SyMAP would concatenate all sequences for one species into one file.
287+
This could create an input file &gt;1G (one gigabyte) resulting in the above error on my Mac M4 (48G).
288+
<br>In Release v5.8.1, SyMAP was altered to only concatenate sequences into a file of maximum length 1G.
289+
This fixed the problem on my Mac M4 (48G).
290+
<br>Note: because the 1st species can be concatenated into more than one file, the <tt>_cc</tt> is replaced with <tt>_c1</tt>, etc.
291+
265292
<!----------------------------------------------------->
266293
<a id="fail2"></a>
267-
<h3>One or more fails</h3>
294+
<h2>One or more fails</h2>
268295

269296
Sometimes just one or a few of the alignment processes will fail. You will see a line such as:
270297
<pre>
271298
Error: Running command: /Users/cari/Workspace/symap_5/ext/mummer/mac/promer
272-
-p data/seq_results/demo_seq_to_demo_seq2/align/demo_seq_cc.demo_seq2_f2.promer
273-
data/seq_results/demo_seq_to_demo_seq2/tmp/demo_seq2/demo_seq2_f2.fa
274-
data/seq_results/demo_seq_to_demo_seq2/tmp/demo_seq/demo_seq_cc.fa
299+
-p data/seq_results/ncbi_HS_to_ncbi_XT/align/ncbi_HS_cc.ncbi_XT_f1.promer
300+
data/seq_results/ncbi_HS_to_ncbi_XT/tmp/ncbi_HS/ncbi_XT_f1.fa
301+
data/seq_results/ncbi_HS_to_ncbi_XT/tmp/ncbi_XT/ncbi_HS_cc.fa
275302
</pre>
276303

277304
<table>
@@ -291,10 +318,10 @@ <h3>One or more fails</h3>
291318
If SyMAP completed the alignment, e.g. the demo <tt>/align</tt> directory will have the following files:
292319
<p><pre>
293320
-rw-r--r--@ 1 cari staff 0B Apr 10 10:28 all.done
294-
-rw-r--r--@ 1 cari staff 1.2M Apr 10 10:28 demo_seq_cc.demo_seq2_f1.mum
295-
-rw-r--r--@ 1 cari staff 0B Apr 10 10:28 demo_seq_cc.demo_seq2_f1.mum.done
296-
-rw-r--r--@ 1 cari staff 541K Apr 10 10:27 demo_seq_cc.demo_seq2_f2.mum
297-
-rw-r--r--@ 1 cari staff 0B Apr 10 10:27 demo_seq_cc.demo_seq2_f2.mum.done
321+
-rw-r--r--@ 1 cari staff 1.2M Apr 10 10:28 ncbi_HS_cc.ncbi_XT_f1.mum
322+
-rw-r--r--@ 1 cari staff 0B Apr 10 10:28 ncbi_HS_cc.ncbi_XT_f1.mum.done
323+
-rw-r--r--@ 1 cari staff 541K Apr 10 10:27 ncbi_HS_cc.ncbi_XT_f2.mum
324+
-rw-r--r--@ 1 cari staff 0B Apr 10 10:27 ncbi_HS_cc.ncbi_XT_f2.mum.done
298325
</pre>
299326
<ol>
300327
<li>The <tt>all.done</tt> indicates that the all alignments completed.
@@ -306,17 +333,14 @@ <h3>One or more fails</h3>
306333
<!------------------------------------------------------------------>
307334
<a id="cmd"></a>
308335
<h2>Running MUMmer from the command line</h2>
309-
<table class="tz" style="width:40%"><tr>
310-
<td><a href="#cmd">Command line</a>
311-
<td><a href="#example">Example</a>
336+
<table class="tz" style="width:60%"><tr>
337+
<td><a href="#cmd">Command line</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
338+
<td><a href="#example">Example</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
312339
<td class="colrt"><a href="#top">Go to top</a>
313340
</table>
314341

315342
<h3>Command line</h3>
316-
317343
If you need to run MUMmer using the terminal command line from some other machine, do the following:
318-
319-
320344
<ol>
321345
<li><u>The naming of your files and their order into MUMmer is VERY important.</u> Everything will mess up
322346
if this is done wrong!
@@ -445,20 +469,20 @@ <h2>Getting Help</h2>
445469
<ol>
446470
<li><tt>error.log</tt>
447471
<li><tt>logs/&lt;p1&gt;-to-&lt;p2&gt;/symap.log</tt>
448-
<li><tt>logs/&lt;p1&gt;-to-&lt;p2&gt;/&lt;p1_cc.p2.fn&gt;.log</tt> where n is the process number
472+
<li><tt>logs/&lt;p1&gt;-to-&lt;p2&gt;/&lt;p1_cn.p2.fm&gt;.log</tt> where n and m are the input file number.
449473
<li>Any output to the terminal (either copy and paste into the email, or send a screen capture)
450474
</ol>
451475
For example, email the terminal output and:
452476
<pre>
453477
symap/error.log
454478
symap/logs/demo_seq_to_demo_seq2/symap.log
455-
symap/logs/demo_seq_to_demo_seq2/demo_seq_cc.demo_seq2_f2.log
479+
symap/logs/demo_seq_to_demo_seq2/demo_seq_c1.demo_seq2_f2.log
456480
</pre>
457481
<!---- END BODY -->
458482
<table style="width: 95%"><tr><td style="text-align: left">
459483
<td style="text-align: right"><a href="#top">Go to top</a></td></tr></table>
460484

461-
<p class="trailer"> Email Comments To: <a href="mailto:cas1@arizona.edu">cas1@arizona.edu</a></p>
485+
<p class="trailer"> Email: <a href="mailto:cas1@arizona.edu">cas1@arizona.edu</a></p>
462486
</div>
463487
</div>
464488
</body>

docs/Release.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,16 @@ <h3>Summary of recent major releases</h3>
6868
<tr><td><a href="#v540">v5.4.0</a><td>(06-Apr-23)<td>Improved <ttx>Cluster Hit</ttx> algorithm <ttx>Algo1</ttx> for the detection of gene homology.
6969
</table>
7070

71+
<h3>Release: v5.8.1 (11-Mar-2026)</h3>
72+
Two small improvements to the <ttl>Alignment&amp;Synteny</ttl>.
73+
<p><ul>
74+
<li>When large genomes, e.g. &gt;3G, were concatenated into one large file, MUMmer
75+
would fail on a Mac M4 with 48G. This has been changed so that no file for input into MUMmer is &gt;1G.
76+
<p><li>If there was an incorrect character in the MUMmer result file, the Clustering algorithm (both <ttl>Algo1</ttl> and <ttl>Algo2</ttl>)
77+
would fail without an indication of where the problem was; now they both will print and skip the bad line.
78+
This incorrect character occurred when I transferred MUMmer alignments via a USB flash drive.
79+
</ul>
80+
7181
<h3>Release: v5.8.0 (14-Feb-2026)</h3>
7282
Improved the Linux interface and a few other small improvements.
7383
<p>

0 commit comments

Comments
 (0)