acquire-project / acquire-docs Goto Github PK
View Code? Open in Web Editor NEWHome Page: https://acquire-project.github.io/acquire-docs/
Home Page: https://acquire-project.github.io/acquire-docs/
I can't check out recent commits because Windows refuses to create a file with a .
at the end. Also, our "for contributors" page looks like this:
Material for MkDocs uses a sponsorware model, and cards and card grids are currently sponsor-only: https://squidfunk.github.io/mkdocs-material/insiders/
We can re-create the cards manually if needed, but it will be bit of extra effort.
At the moment, the header with 1st level navigation is only visible when you are at the top of the page, and as you scroll through the page, the site header scrolls over the navigation bar. This prevents the user from easily accessing other pages on the site while navigating through the pages. This created some friction for me when trying to navigate between the API documentation and other site pages. I suggest we keep the top-level headers visible regardless of where the user is on the page.
Running list of new content needs/requests for the Acquire Docs Site:
matplotlib
We'd like to autogenerate our API docs by reading doc strings in the pyi file.
A few design items still need to be implemented:
Feel free to edit this issue with more items as they show up.
We'd like to introduce versioned docs since new releases may introduce breaking changes. Read the docs may be an option for hosting versioned docs for free using a tag on the docs to assign the version. @melissawm will explore if mkdocs is compatible with read the docs.
We have several tutorials already on the site. To help users find what their looking for, we should organize these tutorials into larger categories.
As part of the Acquire user-facing documentation, we'll include several tutorials and supporting materials on how to utilize Acquire and integrate Acquire API into existing workflows. This issue is a running list of ideas and a tracker of work.
Tutorials:
Tutorials from Tests:
The API for configuring chunking has changed in the latest release. Now you don't have to specify the chunk size in bytes. Instead, you set all the chunk dimensions.
So for example, where before you had
# assuming 1920 x 1080 images with mono8 pixels
config.video[0].storage.settings.chunking.max_bytes_per_chunk = 32 * 2**20 # 32 MB chunks
config.video[0].storage.settings.chunking.tile.width = 1920 // 2
config.video[0].storage.settings.chunking.tile.height = 1080 // 2
which would give you 64 frames in a chunk, you can configure it like so:
config.video[0].storage.settings.chunk_dims_px.width = 1920 // 2
config.video[0].storage.settings.chunk_dims_px.height = 1080 // 2
config.video[0].storage.settings.chunk_dims_px.planes = 64
The markdown file for this page has content, but the content does not render on the site.
For each tutorial on the website, provide a python file for the user to download. We'd like to automate this process to avoid needing to keep track of updates as content on the website changes. Mkdocs gallery may be a suitable solution. @melissawm
The livestream tutorial includes a python script from the examples directory. It seems that the jupytext script (which loops over all tutorials) does not follow this include directive when generating python.
Header tagline: A python package providing a multi-camera video streaming library focused on performant microscopy
Acquire (acquire-imaging
on PyPI) provides high-speed, multi-camera, video streaming and image acquisition with a programming interface#ADD LINK TO API REFERENCE for streaming video data directly to napari, Python and cloud-friendly file formats.
To install Acquire on Windows, macOS, or Ubuntu, simply run the following command:
python -m pip install acquire-imaging
Acquire supports the following cameras (currently only on Windows):
Acquire also supports the following output file formats:
For testing and demonstration purposes, Acquire provides a few simulated cameras, as well as raw and trash output devices.
Provide the CITATION.cff file
Acquire
is provided under an Apache 2.0 license. You can learn more about the Apache license in the documentation here.
Getting Started: Install Acquire and use simulated cameras
API Reference: Information on classes and methods
Tutorials: Guides on using Acquire for specific tasks
For contributors: Learn how to contribute code or documentation to Acquire
Description for the region above the tiles: These tutorials will help you explore the main use cases of Acquire and show examples of using the API. Please submit an issue on Github if you'd like to request a tutorial, or if you are also interested in contributing to a tutorial to this documentation please visit our contribution guide#ADD LINK!
Tiles titles (no descriptions provided):
No description below tiles.
The drivers.md tutorial doesn't render properly on the website. The tutorial title shows up as None.
The tutorial itself doesn't render properly.
When the PR was merged, there was a conflict in mkdocs.yaml, so perhaps the conflict wasn't resolved correctly?
Multiple variable names for the same type of object were used in tutorials. To make it easier for the user to utilize examples from multiple tutorials, these variable names should be standardized. Ditto for configuration settings where applicable. There are also some formatting errors and/or areas of improvement.
To prepare for an internal review of content:
In the getting started tutorial, the note admonition adds the code block to the TOC and has bad formatting.
@melissawm
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.