Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
Co-authored-by: Benjamin Zaitlen <[email protected]>
  • Loading branch information
madsbk and quasiben authored Aug 31, 2023
1 parent 90303be commit 7f87ff6
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions cpp/doxygen/main_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ to include KvikIO in your CMake projects.

### Conda/Mamba

We strongly recommend to use `mamba <https://github.com/mamba-org/mamba>`_ inplace of conda, which we will do throughout the documentation.
We strongly recommend using `mamba <https://github.com/mamba-org/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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ KvikIO can be installed using Conda/Mamba or from source.
Conda/Mamba
-----------

We strongly recommend to use `mamba <https://github.com/mamba-org/mamba>`_ inplace of conda, which we will do throughout the documentation.
We strongly recommend using `mamba <https://github.com/mamba-org/mamba>`_ inplace of conda, which we will do throughout the documentation.

Install the **stable release** from the ``rapidsai`` channel like:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/zarr.rst
Original file line number Diff line number Diff line change
@@ -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 <https://zarr.readthedocs.io/en/stable/>`_ 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.
Expand Down

0 comments on commit 7f87ff6

Please sign in to comment.