search

schnitzer-lab / extract-wip

Do not use this repository for scientific work! It is changing constantly. Use our public version, which is both stable and currently maintained. Link: Check Readme.
MIT License
0 stars 5 forks source link

Create live script version of EXTRACT tutorials #4

Open vijayiyer05 opened 3 years ago

vijayiyer05 commented 3 years ago

Convert existing tutorials. into live script versions with added scientific narrative and figure outputs would help show the command-line workflow in a more engaging fashion (both visual-wise and content-wise).

The Brain Observatory Toolbox OphysDemo is one reference example.

vijayiyer05 commented 2 years ago

Work is underway on the live-scripts branch.

@manisha-sinha-appasamy: can you comment on how the new single tutorial live script relates to the various prior tutorial scripts (M-files)? Is it incorporating some of them or all of them? Or is it focusing more on a broader tutorial narrative that the live script format affords?

manisha-sinha-appasamy commented 2 years ago

Currently, tutorials.mlx contains slightly modified versions of tutorials 1-3, along with a lot of added narrative and summary plots.

The table of contents looks like this at present: TableOfContents_Extract

As you will notice, I have also added the external CIATAH cell checker code - currently works to an extent but throws some errors like these: Screenshot from 2021-12-17 16-50-24 Screenshot from 2021-12-17 16-48-56

I will work on debugging that after integrating the 4th tutorial into this live script. This way, one can navigate easily across different aspects of using EXTRACT in the same live script and all the necessary documentation will be in this live script instead of scattered across tutorials.

If this is not the preferred way, then I can definitely split tutorials.mlx into smaller live scripts for each tutorial with links to each other.