Acquire Documentation

This repository contains the documentation for acquire-zarr (PyPI), a C++ library and Python package providing performant streaming to Zarr V3 and Zarr V2 on filesystem or S3. The built site may be viewed at acquire-project.github.io/acquire-docs.

If you'd like to make a suggestion for new documentation, please submit a Github issue.

Contribute

We welcome contributions to the Acquire code base and to documentation. Refer to our contribution guides for more information. The relevant Github repos are linked below.

• Acquire project
• acquire-zarr
• Acquire documentation

Discontinued projects

The following projects are no longer maintained but are still linked for reference:

• acquire-imaging (PyPI: acquire-imaging)
• acquire-common
• acquire-driver-zarr
• acquire-driver-spinnaker
• acquire-driver-hdcam
• acquire-driver-egrabber
• acquire-driver-pvcam

Build

To build the website locally and serve it, follow the steps below:

1. Install Doxygen using your package manager or from the official website.

2. after cloning and successfully installing acquire-imaging and acquire-zarr in developer mode, run the following commands:

   pip install -r requirements.txt
   mkdocs serve

Note

This setup assumes you have acquire-python and acquire-zarr cloned in the same parent directory as acquire-docs. If this is not the case, edit the mkdocs.yml file accordingly.