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.

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

Unify example workflows #84

Closed
ChucklesOnGitHub opened this issue Oct 3, 2024 · 6 comments
Closed

Unify example workflows #84

ChucklesOnGitHub opened this issue Oct 3, 2024 · 6 comments
Assignees
Labels

Comments

@ChucklesOnGitHub
Copy link
Contributor

  • Add Breakout Board node
  • Add MemoryData node
  • Write hub ConfigDevice Node properties to file

The hs64 tutorial includes all of these, we have to revise np1e and np2e. bb example probably doesn't need these.

@jonnew
Copy link
Member

jonnew commented Oct 15, 2024

This is a good idea. All the workflows with headstage should probably include the breakout. However, I don't think writing all the properties to file is practice. And, in fact its already done -- the .bonsai file contains all the values.

@ChucklesOnGitHub ChucklesOnGitHub removed this from the Style Guide milestone Oct 28, 2024
@cjsha
Copy link
Member

cjsha commented Oct 30, 2024

The .bonsai file does save properties. However, for reproducibility, imo it would be even more robust if the user could save a file with those properties at the time that the workflow was started that is decoupled from the .bonsai file. Each data acquisition session reproduces the properties that were used during that session. Of course, this wouldn't work once we start taking into account acquisition properties which can be changed while the workflow is running. The first two bullet points in the original post: yes. That third bullet point feels like an item that would belong on a wish list.

@cjsha
Copy link
Member

cjsha commented Oct 30, 2024

Part of resolving this issues is implementing the discussion in #97

@jonnew
Copy link
Member

jonnew commented Oct 31, 2024

Ah, i think i somehow misunderstood @ChucklesOnGitHub's original point. I think all she was saying is that all the workflows should have three common elements:

image

If that's what she was indicating, then I agree

@ChucklesOnGitHub
Copy link
Contributor Author

Yes Jon, that's what I meant. The picture makes it super clear.
Once we finish the Style Guide, we can revise the example workflows to make sure they are uniform as per those guidelines (workflow sections to include as stated here, standard name of saved data files as stated in #97 , etc).

Cris, I agree that it would be nice "if the user could save a file with those properties at the time that the workflow was started that is decoupled from the .bonsai file.", and that it can be part of the wishlist. In this issue I was only referring to the Timestamp node after the ConfigureHeadstage.

@cjsha
Copy link
Member

cjsha commented Dec 6, 2024

In that case, I unified example workflows in #155, and I made a wishlist issue #160 for "if the user could save a file with those properties at the time that the workflow was started that is decoupled from the .bonsai file" so I can close this one.

@cjsha cjsha closed this as completed Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants