Skip to content

Improve icephys tutorial #2071

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

Draft
wants to merge 7 commits into
base: dev
Choose a base branch
from

Conversation

h-mayorquin
Copy link
Contributor

@h-mayorquin h-mayorquin commented May 2, 2025

Motivation

At the moment, the icephys tutorial begins with a very general overview, presented in the style of a reference manual: it includes a summary graph, a list and description of all data types, and a complete code example with all use cases.

I believe the tutorial would be more effective if it progressed from the simplest case to the most complex. This PR reorganizes the tutorial accordingly:

  • Start with adding a single Stimulus and Response Series.
  • Then, explain how to organize multiple experiments using intracellular recordings.
  • Finally, introduce the Simultaneous, Sequential, Repetition, and ExperimentalConditions tables as tools for organizing more complex experiments.

This PR establishes the general structure, but there are still some improvements we could consider:

  • Provide a clearer description of the metadata associated with Electrodes and PatchClampSeries, that is, the optional arguments.
  • Add diagrams illustrating experimental setups where the various tables (Simultaneous, Sequential, Repetition, and ExperimentalConditions) are used.

However, I think these enhancements can be added later.

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running ruff check . && codespell from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

Copy link

codecov bot commented May 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.83%. Comparing base (b331e9c) to head (239131b).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #2071   +/-   ##
=======================================
  Coverage   94.83%   94.83%           
=======================================
  Files          28       28           
  Lines        2749     2749           
  Branches      708      708           
=======================================
  Hits         2607     2607           
  Misses         82       82           
  Partials       60       60           
Flag Coverage Δ
integration 73.99% <ø> (ø)
unit 84.83% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@h-mayorquin h-mayorquin self-assigned this May 2, 2025
@h-mayorquin h-mayorquin added the topic: docs issues related to documentation label May 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: docs issues related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant