Merge pull request #189 from paulsengroup/release/1.0.0

Prepare for release
paulsengroup · Jun 18, 2024 · e1e7bcc · e1e7bcc
2 parents 60cbdbf + 21b54d3
commit e1e7bcc
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/cmake/Versioning.cmake b/cmake/Versioning.cmake
@@ -2,9 +2,9 @@
 #
 # SPDX-License-Identifier: MIT
 
-set(HICTK_PROJECT_VERSION_MAJOR 0)
+set(HICTK_PROJECT_VERSION_MAJOR 1)
 set(HICTK_PROJECT_VERSION_MINOR 0)
-set(HICTK_PROJECT_VERSION_PATCH 12)
+set(HICTK_PROJECT_VERSION_PATCH 0)
 set(HICTK_PROJECT_VERSION_SUFFIX "")
 
 option(HICTK_ENABLE_GIT_VERSION_TRACKING "Retrieve project version and metadata from git" ON)

diff --git a/docs/conf.py b/docs/conf.py
@@ -49,7 +49,7 @@
 # built documents.
 
 # Read the listed version
-version = "0.0.12"
+version = "1.0.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -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.12-bioconda
+  hictk-v1.0.0-bioconda
 
 If you are trying to install hictk on a Mac with an M chip, the above command may fail due to conda not being able to find a package for hictk.
 You can workaround the above issue by prefixing conda commands with :code:`CONDA_SUBDIR=osx-64`.
@@ -70,10 +70,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.12 --help
+  user@dev:/tmp$ docker run ghcr.io/paulsengroup/hictk:1.0.0 --help
 
   # Using Singularity/Apptainer
-  user@dev:/tmp$ singularity run ghcr.io/paulsengroup/hictk:0.0.12 --help
+  user@dev:/tmp$ singularity run ghcr.io/paulsengroup/hictk:1.0.0 --help
 
   Blazing fast tools to work with .hic and .cool files.
   Usage: /usr/local/bin/hictk [OPTIONS] SUBCOMMAND

diff --git a/docs/installation_src.rst b/docs/installation_src.rst
@@ -71,7 +71,7 @@ Using git.
   git clone https://github.com/paulsengroup/hictk.git /tmp/hictk
 
   cd /tmp/hictk
-  git checkout v0.0.12  # Skip this step if you want to build the latest commit from main
+  git checkout v1.0.0  # Skip this step if you want to build the latest commit from main
 
 Compiling hictk
 ---------------

diff --git a/docs/quickstart_api.rst b/docs/quickstart_api.rst
@@ -18,7 +18,7 @@ To install libhictk using Conan, first create a conanfile.txt like the following
 .. code-block::
 
   [requires]
-  hictk/0.0.12
+  hictk/1.0.0
 
   [generators]
   CMakeDeps
@@ -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.12
+    GIT_TAG         v1.0.0
     SYSTEM)
 
   # Customize hictk build flags

diff --git a/docs/quickstart_cli.rst b/docs/quickstart_cli.rst
@@ -12,7 +12,7 @@ Next, verify that hictk was installed correctly with:
 .. code-block:: console
 
   user@dev:/tmp$ hictk --version
-  hictk-v0.0.12
+  hictk-v1.0.0
 
 Command line interface
 ======================