Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #127

Merged
merged 1 commit into from
Feb 25, 2024
Merged

Update docs #127

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Update docs
  • Loading branch information
@robomics
robomics committed Feb 25, 2024
commit 39abe6a82e29157abca2cd9f3930546fccc36918
8 changes: 6 additions & 2 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Introduction

hictk is a blazing fast toolkit to work with .hic and .cool files.

hictk is capable of reading files in .cool, .mcool, .scool and .hic format (including hic v9) as well as writing .cool, .mcool and .scool files.
hictk is capable of reading and writing files in .cool, .mcool, .scool and .hic format (including hic v9).

.. only:: not latex

Expand All @@ -29,7 +29,10 @@ hictk is developed on Linux and tested on Linux, MacOS and Windows. CLI tools ca

hictk can be compiled on most UNIX-like systems (including many Linux distributions and MacOS) as well as Windows. See the :doc:`build instructions <./installation_src>` for more details.

Python bindings for hictk can be installed using pip or conda. Refer to hictkpy `documentation <https://hictkpy.readthedocs.io/en/latest/installation.html>`_ for more details.
hictk can be used from languages other than C++ through the following bindings:

* Python bindings through `hictkpy <https://github.com/paulsengroup/hictkpy>`_
* R bindings through `hictkR <https://github.com/paulsengroup/hictkR>`_

.. only:: not latex

Expand Down Expand Up @@ -94,3 +97,4 @@ If you use ``hictk convert`` to convert .[m]cool files to .hic format you should
cli_reference
cpp_api/index
Python API <https://hictkpy.readthedocs.io/en/latest/hictkpy.html>
R API <https://paulsengroup.github.io/hictkR/reference/index.html>