search

acquire-project / acquire-docs

https://acquire-project.github.io/acquire-docs/
0 stars 3 forks source link

Copy for the website #21

Closed dgmccart closed 3 months ago

dgmccart commented 1 year ago

Copy for the Homepage

Screenshot 2023-11-13 at 1 07 21 PM

Header tagline: A python package providing a multi-camera video streaming library focused on performant microscopy

About Acquire

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.

Installation

To install Acquire on Windows, macOS, or Ubuntu, simply run the following command:

python -m pip install acquire-imaging

Supported Cameras and File Formats

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.

Citing Acquire

Provide the CITATION.cff file

Acquire License

Acquire is provided under an Apache 2.0 license. You can learn more about the Apache license in the documentation here.

Copy for Homepage Tiles

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

Copy for the Tutorials Homepage

Screenshot 2023-11-13 at 1 07 39 PM

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):

  1. Finite Triggered Acquisition
  2. Access Data from the Camera
  3. Livestream to napari or Matplotlib
  4. Select a Streaming or Storage Device
  5. Test Camera Drivers
  6. Setup Triggers
  7. Setup Acquisition Properties
  8. Storage Devices In-Detail
  9. Save Compressed Data
  10. Save Multiscale Data
  11. Save Chunked Data

No description below tiles.

dgmccart commented 1 year ago

@melissawm

melissawm commented 1 year ago

@dgmccart Where should the "Get Started" button point to? The get started page or some other specific content?

dgmccart commented 1 year ago

@melissawm Yes, it should point to the get started page.

melissawm commented 3 months ago

Hi folks, are there any items left in this issue to follow up on?

dgmccart commented 3 months ago

No, I'll go ahead and close. I'll make a separate issue to add tiles for tutorial categorization, but the copy for the tutorials page itself is already implemented.