diff --git a/README.md b/README.md index 6ca1026430..4df538aa2d 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ The C++ library is header-only making it easy to include in [existing projects]( ### Features * Object oriented API of [cuFile](https://docs.nvidia.com/gpudirect-storage/api-reference-guide/index.html) with C++/Python exception handling. -* A Python Zarr backend for reading and writing GPU data to file seamlessly. +* A Python [Zarr](https://zarr.readthedocs.io/en/stable/) backend for reading and writing GPU data to file seamlessly. * Concurrent reads and writes using an internal thread pool. * Non-blocking API. * Handle both host and device IO seamlessly. diff --git a/cpp/doxygen/main_page.md b/cpp/doxygen/main_page.md index c8e0f941a0..0c7b013678 100644 --- a/cpp/doxygen/main_page.md +++ b/cpp/doxygen/main_page.md @@ -28,9 +28,9 @@ to include KvikIO in your CMake projects. ### Conda/Mamba -We strongly recommend to use `mamba `_ inplace of conda, which we will do throughout the documentation. +We strongly recommend using `mamba `_ inplace of conda, which we will do throughout the documentation. -Install the **stable release** from the ``rapidsai`` channel like: +Install the **stable release** from the ``rapidsai`` channel with the following: ```sh # Install in existing environment mamba install -c rapidsai -c conda-forge libkvikio @@ -40,7 +40,7 @@ mamba create -n libkvikio-env -c rapidsai -c conda-forge cuda-version=11.8 libkv mamba create -n libkvikio-env -c rapidsai -c conda-forge cuda-version=12.0 libkvikio ``` -Install the **nightly release** from the ``rapidsai-nightly`` channel like: +Install the **nightly release** from the ``rapidsai-nightly`` channel with the following: ```sh # Install in existing environment diff --git a/docs/source/install.rst b/docs/source/install.rst index 21074bc73e..c6f11a7a93 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -7,7 +7,7 @@ KvikIO can be installed using Conda/Mamba or from source. Conda/Mamba ----------- -We strongly recommend to use `mamba `_ inplace of conda, which we will do throughout the documentation. +We strongly recommend using `mamba `_ inplace of conda, which we will do throughout the documentation. Install the **stable release** from the ``rapidsai`` channel like: diff --git a/docs/source/zarr.rst b/docs/source/zarr.rst index 13cf2542ec..2bb3ce54a6 100644 --- a/docs/source/zarr.rst +++ b/docs/source/zarr.rst @@ -1,7 +1,7 @@ Zarr ==== -KvikIO implements a Zarr-Python backend for reading and writing GPU data to file seamlessly. +KvikIO implements a `Zarr-Python `_ backend for reading and writing GPU data to file seamlessly. The following is an example of how to use the convenience function :py:meth:`kvikio.zarr.open_cupy_array` to create a new Zarr array and how open an existing Zarr array.