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

Prepare for release #91

Merged
merged 2 commits into from
Dec 22, 2023
Merged

Prepare for release #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e74982d
Prepare for release
robomics Dec 16, 2023
598bfc2
Merge branch 'main' into release/0.0.4
robomics Dec 22, 2023
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
2 changes: 1 addition & 1 deletion cmake/Versioning.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

set(HICTK_PROJECT_VERSION_MAJOR 0)
set(HICTK_PROJECT_VERSION_MINOR 0)
set(HICTK_PROJECT_VERSION_PATCH 3)
set(HICTK_PROJECT_VERSION_PATCH 4)
set(HICTK_PROJECT_VERSION_SUFFIX "")

option(HICTK_ENABLE_GIT_VERSION_TRACKING "Retrieve project version and metadata from git" ON)
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
# built documents.

# Read the listed version
version = "0.0.3"
version = "0.0.4"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
6 changes: 3 additions & 3 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ hictk package for Linux and MacOS is available on bioconda and can be installed
hictk: /home/user/.miniconda3/envs/hictk/bin/hictk

(hictk) user@dev:/tmp$ hictk --version
hictk-v0.0.3-bioconda
hictk-v0.0.4-bioconda


Containers (Docker or Singularity/Apptainer)
Expand Down Expand Up @@ -66,10 +66,10 @@ Downloading and running the latest stable release can be done as follows:
.. code-block:: console

# Using Docker, may require sudo
user@dev:/tmp$ docker run ghcr.io/paulsengroup/hictk:0.0.3 --help
user@dev:/tmp$ docker run ghcr.io/paulsengroup/hictk:0.0.4 --help

# Using Singularity/Apptainer
user@dev:/tmp$ singularity run ghcr.io/paulsengroup/hictk:0.0.3 --help
user@dev:/tmp$ singularity run ghcr.io/paulsengroup/hictk:0.0.4 --help

Blazing fast tools to work with .hic and .cool files.
Usage: /usr/local/bin/hictk [OPTIONS] SUBCOMMAND
Expand Down
4 changes: 2 additions & 2 deletions docs/installation_src.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Download from the `Release <https://github.com/paulsengroup/hictk/releases>`_ pa
.. code-block:: bash

mkdir /tmp/hictk
curl -L 'https://github.com/paulsengroup/hictk/archive/refs/tags/v0.0.3.tar.gz' | tar --strip-components=1 -C /tmp/hictk -xzf -
curl -L 'https://github.com/paulsengroup/hictk/archive/refs/tags/v0.0.4.tar.gz' | tar --strip-components=1 -C /tmp/hictk -xzf -


Using git.
Expand All @@ -71,7 +71,7 @@ Using git.
git clone https://github.com/paulsengroup/hictk.git /tmp/hictk

cd /tmp/hictk
git checkout v0.0.3 # Skip this step if you want to build the latest commit from main
git checkout v0.0.4 # Skip this step if you want to build the latest commit from main

Compiling hictk
---------------
Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To install libhictk using Conan, first create a conanfile.txt like the following
.. code-block::

[requires]
hictk/0.0.3
hictk/0.0.4

[generators]
CMakeDeps
Expand Down Expand Up @@ -62,7 +62,7 @@ To install and configure hictk using `FetchContent <https://cmake.org/cmake/help
FetchContent_Declare(
hictk
GIT_REPOSITORY "https://github.com/paulsengroup/hictk.git"
GIT_TAG v0.0.3
GIT_TAG v0.0.4
SYSTEM)

# Customize hictk build flags
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart_cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Next, verify that hictk was installed correctly with:
.. code-block:: console

user@dev:/tmp$ hictk --version
hictk-v0.0.3
hictk-v0.0.4

Command line interface
======================
Expand Down