Skip to content

Commit

Permalink
Add faq section to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nickmachnik committed Nov 18, 2020
1 parent fe72182 commit 8db8c9e
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/faq.rst
@@ -0,0 +1,15 @@
##########################
Frequently Asked Questions
##########################

***************************
Why is `chess sim` so slow?
***************************
A common cause for long runtimes of `chess sim` is when the input files are
in `Cooler <https://github.com/mirnylab/cooler>`_ format. `chess sim` compares
observed/expected transformed matrices, and these are often not precomputed
and stored in this format. If your runs spend a long time in the
"INFO Loading query contact data" step, consider converting your data to
`Juicer <https://github.com/aidenlab/juicer>`_, or `FANC <https://github.com/vaquerizaslab/fanc>`_
format, as these usually store observed/expected values
(see `here <https://fan-c.readthedocs.io/en/latest/fanc-executable/compatibility.html#cooler-cool-and-mcool>`_).
1 change: 1 addition & 0 deletions docs/index.rst
Expand Up @@ -11,6 +11,7 @@ Welcome to chess-hic's documentation!

Getting started with chess-hic <getting_started>
The chess-hic command line tool <cli>
FAQ <faq>



Expand Down

0 comments on commit 8db8c9e

Please sign in to comment.