Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create tutorials for user onboarding #2

Closed
15 tasks done
dgmccart opened this issue Sep 12, 2023 · 1 comment
Closed
15 tasks done

Create tutorials for user onboarding #2

dgmccart opened this issue Sep 12, 2023 · 1 comment
Assignees
@dgmccart

Comments

@dgmccart
Copy link
Collaborator

dgmccart commented Sep 12, 2023 •
edited
Loading

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:
@dgmccart dgmccart self-assigned this Sep 12, 2023
melissawm referenced this issue in melissawm/acquire-docs Oct 5, 2023
@aliddell @nclack
Use artifact downloads instead of submodules (#2)
6909668 
* Update submodules. Fix DM bugs in test_basic.py

* Update acquire-driver-common and acquire-driver-hdcam. Restore recursive submodule checkout in CI.

* Restore capital-T Tiff.

* Try to enable long paths in CI.

* Try again to enable long paths in CI.

* Update typing and dcam tests

* Update acquire-driver-common and acquire-video-runtime submodules

* update acquire-driver-zarr submodule.

* update deps, tests

* testing (wip)

* fix trigger assignment

* update submodules

* wip

* update build and test yamls

* fix packaging

* packaging: remove old setuptools options

* get dcam test to pass

* fix packaging

* build and test passes

* remove driver submodules

* update dcam and egrabber test yamls

* add GH token to environment variables in typing test.

* Clean up build script

* Address PR comments.

* update zarr sha

* update shas

---------

Co-authored-by: Nathan Clack <[email protected]>
melissawm referenced this issue in melissawm/acquire-docs Oct 5, 2023
@aliddell
Nontrivial chunking (#8)
06fd9be 
* Update submodules. Fix DM bugs in test_basic.py

* Update submodules.

* Update submodules.

* Expand StorageProperties to support chunking and compression parameters.

* Update acquire-driver-zarr submodule. Add chunking test.

* Squashed commit of the following:

commit 750f6f66ef66649769356d3b057a61738edb457e
Author: Alan Liddell <[email protected]>
Date:   Wed May 10 10:37:05 2023 -0400

    Address PR comments.

commit 5a256f74d5299223f62ee0b4d99d42f5f265efc7
Author: Alan Liddell <[email protected]>
Date:   Tue May 9 13:29:49 2023 -0400

    Clean up build script

commit a88e12a1bdd953e3489116373068593af6377bc1
Author: Alan Liddell <[email protected]>
Date:   Tue May 9 13:12:43 2023 -0400

    add GH token to environment variables in typing test.

commit df8256684ce7f2840f0d24823065c53e2fac8a2d
Merge: 652c401 b07cbb3
Author: Alan Liddell <[email protected]>
Date:   Tue May 9 12:56:25 2023 -0400

    Merge remote-tracking branch 'nclack/testing' into submodule-updates

commit 652c401257aba0c738cbf5a273948b391514d568
Author: Alan Liddell <[email protected]>
Date:   Tue May 9 12:22:45 2023 -0400

    update dcam and egrabber test yamls

commit 3cc7cddb96b8188200ee9f8133da1d886204c0f1
Author: Alan Liddell <[email protected]>
Date:   Tue May 9 12:10:00 2023 -0400

    remove driver submodules

commit e4b9e01152c403fd9a6dc46005f784936eaa8bcd
Author: Alan Liddell <[email protected]>
Date:   Tue May 9 11:51:14 2023 -0400

    build and test passes

commit 0b27539148ece38e1f569795db30cb7cc6df7534
Author: Nathan Clack <[email protected]>
Date:   Mon May 8 16:41:49 2023 -0700

    fix packaging

commit b07cbb370a6db2b29cf1bdc8606498cd9555ff11
Author: Nathan Clack <[email protected]>
Date:   Mon May 8 17:09:18 2023 -0700

    get dcam test to pass

commit bc54ff2f4214b5ecc01eaa622703f53abd5725ba
Author: Nathan Clack <[email protected]>
Date:   Mon May 8 16:57:21 2023 -0700

    packaging: remove old setuptools options

commit afba01d3f7476142b6f0aaf671eca8b05df29ee9
Author: Nathan Clack <[email protected]>
Date:   Mon May 8 16:41:49 2023 -0700

    fix packaging

commit a887683cf348b89c4327fb33fc67a5cf72c36c60
Author: Alan Liddell <[email protected]>
Date:   Mon May 8 17:22:09 2023 -0400

    update build and test yamls

commit 8e08001f72408485acb5c341871bab1458cd7e96
Author: Alan Liddell <[email protected]>
Date:   Mon May 8 17:19:31 2023 -0400

    wip

commit 7b3180fd3c78422380983010051277ee72025366
Author: Alan Liddell <[email protected]>
Date:   Mon May 8 16:56:02 2023 -0400

    update submodules

commit 6e41aff47b5bdb189e5356e69a3f663b3239fd1f
Author: Nathan Clack <[email protected]>
Date:   Mon May 8 10:00:42 2023 -0700

    fix trigger assignment

commit 9cd29151070a8e6edfa9e51495ad0a26847f63e0
Author: Nathan Clack <[email protected]>
Date:   Fri May 5 15:38:23 2023 -0700

    testing (wip)

commit b5bf4f97e341932d8e350bed6647e2c272e3a76d
Author: Nathan Clack <[email protected]>
Date:   Fri May 5 15:29:32 2023 -0700

    update deps, tests

commit 20ea3a0737adea45d8354ed18f212d95be51e40e
Author: Alan Liddell <[email protected]>
Date:   Thu May 4 12:24:23 2023 -0400

    update acquire-driver-zarr submodule.

commit 941027c15d326ce79353bb3df94c0e7a773777c4
Author: Alan Liddell <[email protected]>
Date:   Thu May 4 11:38:06 2023 -0400

    Update acquire-driver-common and acquire-video-runtime submodules

commit 5fcd566ea7bdcafb7b8652b6d60862e5a37fe0f6
Author: Alan Liddell <[email protected]>
Date:   Thu May 4 10:55:14 2023 -0400

    Update typing and dcam tests

commit d68d40f0e7122e350270f823605ecff1c9b64358
Author: Alan Liddell <[email protected]>
Date:   Wed May 3 15:47:45 2023 -0400

    Try again to enable long paths in CI.

commit 34647a7803fe0b2bcd9ca3892327b2caab56faea
Author: Alan Liddell <[email protected]>
Date:   Wed May 3 15:41:40 2023 -0400

    Try to enable long paths in CI.

commit 1d79e247bb87b924bded9e918470b3a16c852172
Author: Alan Liddell <[email protected]>
Date:   Wed May 3 15:24:57 2023 -0400

    Restore capital-T Tiff.

commit 5b317b9386bbed4bbc54deae502b02548a65d3d8
Author: Alan Liddell <[email protected]>
Date:   Wed May 3 15:23:54 2023 -0400

    Update acquire-driver-common and acquire-driver-hdcam. Restore recursive submodule checkout in CI.

commit 5d170ddfb2f15cd76108345227dd0972252f8480
Merge: f989feb 51a7ea1
Author: Alan Liddell <[email protected]>
Date:   Wed May 3 13:40:46 2023 -0400

    Merge branch 'main' into submodule-updates

commit 51a7ea1
Author: Alan Liddell <[email protected]>
Date:   Wed May 3 13:38:25 2023 -0400

    remove uses of PAT from workflow files, set submodules from recursive to true

* Update driver hashes.

* Squashed commit of the following:

commit 6909668
Author: Alan Liddell <[email protected]>
Date:   Wed May 10 19:08:01 2023 -0400

    Use artifact downloads instead of submodules (#2)

    * Update submodules. Fix DM bugs in test_basic.py

    * Update acquire-driver-common and acquire-driver-hdcam. Restore recursive submodule checkout in CI.

    * Restore capital-T Tiff.

    * Try to enable long paths in CI.

    * Try again to enable long paths in CI.

    * Update typing and dcam tests

    * Update acquire-driver-common and acquire-video-runtime submodules

    * update acquire-driver-zarr submodule.

    * update deps, tests

    * testing (wip)

    * fix trigger assignment

    * update submodules

    * wip

    * update build and test yamls

    * fix packaging

    * packaging: remove old setuptools options

    * get dcam test to pass

    * fix packaging

    * build and test passes

    * remove driver submodules

    * update dcam and egrabber test yamls

    * add GH token to environment variables in typing test.

    * Clean up build script

    * Address PR comments.

    * update zarr sha

    * update shas

    ---------

    Co-authored-by: Nathan Clack <[email protected]>

* update acquire-video-runtime

* wip: update zarr driver (?)

* wip

* Update drivers, fix bindings, fix tests.

* Misc fixes

* Ran black and flake8

* fix readme
melissawm referenced this issue in melissawm/acquire-docs Oct 5, 2023
@aliddell
Multiscale (acquire-project#47)
8616428 
* Update submodules. Fix DM bugs in test_basic.py

* Update submodules.

* Update submodules.

* Expand StorageProperties to support chunking and compression parameters.

* Update acquire-driver-zarr submodule. Add chunking test.

* Squashed commit of the following:

commit 750f6f66ef66649769356d3b057a61738edb457e
Author: Alan Liddell <[email protected]>
Date:   Wed May 10 10:37:05 2023 -0400

    Address PR comments.

commit 5a256f74d5299223f62ee0b4d99d42f5f265efc7
Author: Alan Liddell <[email protected]>
Date:   Tue May 9 13:29:49 2023 -0400

    Clean up build script

commit a88e12a1bdd953e3489116373068593af6377bc1
Author: Alan Liddell <[email protected]>
Date:   Tue May 9 13:12:43 2023 -0400

    add GH token to environment variables in typing test.

commit df8256684ce7f2840f0d24823065c53e2fac8a2d
Merge: 652c401 b07cbb3
Author: Alan Liddell <[email protected]>
Date:   Tue May 9 12:56:25 2023 -0400

    Merge remote-tracking branch 'nclack/testing' into submodule-updates

commit 652c401257aba0c738cbf5a273948b391514d568
Author: Alan Liddell <[email protected]>
Date:   Tue May 9 12:22:45 2023 -0400

    update dcam and egrabber test yamls

commit 3cc7cddb96b8188200ee9f8133da1d886204c0f1
Author: Alan Liddell <[email protected]>
Date:   Tue May 9 12:10:00 2023 -0400

    remove driver submodules

commit e4b9e01152c403fd9a6dc46005f784936eaa8bcd
Author: Alan Liddell <[email protected]>
Date:   Tue May 9 11:51:14 2023 -0400

    build and test passes

commit 0b27539148ece38e1f569795db30cb7cc6df7534
Author: Nathan Clack <[email protected]>
Date:   Mon May 8 16:41:49 2023 -0700

    fix packaging

commit b07cbb370a6db2b29cf1bdc8606498cd9555ff11
Author: Nathan Clack <[email protected]>
Date:   Mon May 8 17:09:18 2023 -0700

    get dcam test to pass

commit bc54ff2f4214b5ecc01eaa622703f53abd5725ba
Author: Nathan Clack <[email protected]>
Date:   Mon May 8 16:57:21 2023 -0700

    packaging: remove old setuptools options

commit afba01d3f7476142b6f0aaf671eca8b05df29ee9
Author: Nathan Clack <[email protected]>
Date:   Mon May 8 16:41:49 2023 -0700

    fix packaging

commit a887683cf348b89c4327fb33fc67a5cf72c36c60
Author: Alan Liddell <[email protected]>
Date:   Mon May 8 17:22:09 2023 -0400

    update build and test yamls

commit 8e08001f72408485acb5c341871bab1458cd7e96
Author: Alan Liddell <[email protected]>
Date:   Mon May 8 17:19:31 2023 -0400

    wip

commit 7b3180fd3c78422380983010051277ee72025366
Author: Alan Liddell <[email protected]>
Date:   Mon May 8 16:56:02 2023 -0400

    update submodules

commit 6e41aff47b5bdb189e5356e69a3f663b3239fd1f
Author: Nathan Clack <[email protected]>
Date:   Mon May 8 10:00:42 2023 -0700

    fix trigger assignment

commit 9cd29151070a8e6edfa9e51495ad0a26847f63e0
Author: Nathan Clack <[email protected]>
Date:   Fri May 5 15:38:23 2023 -0700

    testing (wip)

commit b5bf4f97e341932d8e350bed6647e2c272e3a76d
Author: Nathan Clack <[email protected]>
Date:   Fri May 5 15:29:32 2023 -0700

    update deps, tests

commit 20ea3a0737adea45d8354ed18f212d95be51e40e
Author: Alan Liddell <[email protected]>
Date:   Thu May 4 12:24:23 2023 -0400

    update acquire-driver-zarr submodule.

commit 941027c15d326ce79353bb3df94c0e7a773777c4
Author: Alan Liddell <[email protected]>
Date:   Thu May 4 11:38:06 2023 -0400

    Update acquire-driver-common and acquire-video-runtime submodules

commit 5fcd566ea7bdcafb7b8652b6d60862e5a37fe0f6
Author: Alan Liddell <[email protected]>
Date:   Thu May 4 10:55:14 2023 -0400

    Update typing and dcam tests

commit d68d40f0e7122e350270f823605ecff1c9b64358
Author: Alan Liddell <[email protected]>
Date:   Wed May 3 15:47:45 2023 -0400

    Try again to enable long paths in CI.

commit 34647a7803fe0b2bcd9ca3892327b2caab56faea
Author: Alan Liddell <[email protected]>
Date:   Wed May 3 15:41:40 2023 -0400

    Try to enable long paths in CI.

commit 1d79e247bb87b924bded9e918470b3a16c852172
Author: Alan Liddell <[email protected]>
Date:   Wed May 3 15:24:57 2023 -0400

    Restore capital-T Tiff.

commit 5b317b9386bbed4bbc54deae502b02548a65d3d8
Author: Alan Liddell <[email protected]>
Date:   Wed May 3 15:23:54 2023 -0400

    Update acquire-driver-common and acquire-driver-hdcam. Restore recursive submodule checkout in CI.

commit 5d170ddfb2f15cd76108345227dd0972252f8480
Merge: f989feb 51a7ea1
Author: Alan Liddell <[email protected]>
Date:   Wed May 3 13:40:46 2023 -0400

    Merge branch 'main' into submodule-updates

commit 51a7ea1
Author: Alan Liddell <[email protected]>
Date:   Wed May 3 13:38:25 2023 -0400

    remove uses of PAT from workflow files, set submodules from recursive to true

* Update driver hashes.

* Squashed commit of the following:

commit 6909668
Author: Alan Liddell <[email protected]>
Date:   Wed May 10 19:08:01 2023 -0400

    Use artifact downloads instead of submodules (#2)

    * Update submodules. Fix DM bugs in test_basic.py

    * Update acquire-driver-common and acquire-driver-hdcam. Restore recursive submodule checkout in CI.

    * Restore capital-T Tiff.

    * Try to enable long paths in CI.

    * Try again to enable long paths in CI.

    * Update typing and dcam tests

    * Update acquire-driver-common and acquire-video-runtime submodules

    * update acquire-driver-zarr submodule.

    * update deps, tests

    * testing (wip)

    * fix trigger assignment

    * update submodules

    * wip

    * update build and test yamls

    * fix packaging

    * packaging: remove old setuptools options

    * get dcam test to pass

    * fix packaging

    * build and test passes

    * remove driver submodules

    * update dcam and egrabber test yamls

    * add GH token to environment variables in typing test.

    * Clean up build script

    * Address PR comments.

    * update zarr sha

    * update shas

    ---------

    Co-authored-by: Nathan Clack <[email protected]>

* update acquire-video-runtime

* wip: update zarr driver (?)

* wip

* Update drivers, fix bindings, fix tests.

* Misc fixes

* Ran black and flake8

* fix readme

* wip

* add multiscale test

* Update drivers list.

* Update storage properties.

* Update multiscale test.

* Fix chunking tests by specifying u8 sample type.
@dgmccart
Copy link
Collaborator Author

@melissawm This document should be moved to the tutorials section of the site.

@dgmccart dgmccart closed this as completed Dec 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dgmccart dgmccart

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dgmccart