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

Deprecation of Library Steps #108

Open
jmdelahanty opened this issue Jun 22, 2022 · 3 comments
Open

Deprecation of Library Steps #108

jmdelahanty opened this issue Jun 22, 2022 · 3 comments

Comments

@jmdelahanty
Copy link
Contributor

Given that the plan is to deprecate this library and implement things in MATLAB, we need to make a roadmap for how to do it. This isn't a top priority right now/urgent, but it will probably take some time to migrate things away from this library and refactor many of the functions using MATLAB implementations.

Here's a list of things that we'll have to migrate (not inclusive of everything, there might be things I'm forgetting). Note that this list is meant to bring up what things currently do through the Python implementation and does not include the many issues/enhancements in the repo:

  • Trial checking/trial rules
  • Trial set generation without catch trials
  • Trial set generation with catch trials
  • Trial set generation with LED stimulation trials
  • Doing "Yoked" trial sets
  • Use of configuration files (tentative, maybe don't want to use them for configurations in the future?)
  • Specifying/calculating how long/how many frames should be taken to end the experiment simultaneously
  • Wrapping functions around PrairieLink API (pretty chill to do)
  • Configure GenTL compliant camera(s)
  • Naming conventions for files generated by the scope/experiment
  • Transmission of information to the Arduino itself (trial sets, metadata/info about parameters to use)
  • Potentially use subject metadata that can configure the scope according to specific parameters used during "exploration" phase
  • Build out documentation of MATLAB code/functions we write

It probably wouldn't take a ton of time to refactor things, but since that's what the plan is for this stuff it would be good to have things like this in mind.

@jmdelahanty
Copy link
Contributor Author

Given last Team2P meeting, it appears that we will not be deprecating the library, at least for now while Austin is still using it/while his project continues.

Until told otherwise/pending clearer directions from lab leadership, closing this issue for now.

@jmdelahanty
Copy link
Contributor Author

Given the failures of the repository for some recent use cases, it is likely best that it does indeed get deprecated. Many of the enhancements or ideas planned for the repository will no longer be worked on much, if at all.

The only reason things will still be worked on software wise is probably just if I have spare time/want to mess around with it. This will effectively be the last issue that is updated unless it's a critical update for something that is broken.

It has been a good learning experience and, although it is bad/brittle/ineffective in many ways, it at least got something out of some neurons once.

@jmdelahanty jmdelahanty pinned this issue Sep 12, 2022
@jmdelahanty
Copy link
Contributor Author

I'm feeling somewhat confused overall about what to do for this library. It's not going to survive long term most likely, but Austin would like continued updates for it and, if I'm honest with myself, I do want to keep improving it as a learning experience and incorporate all the cool things that Bryan and Deryn are showing me. Saying goodbye is hard...

@jmdelahanty jmdelahanty unpinned this issue Jan 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant