Skip to content

created jupyter notebook for initial/quick start #633 #640

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

SHISKEBAB
Copy link

No description provided.

@SHISKEBAB
Copy link
Author

Added Jupyter Notebook for Thermocycler Documentation (#633 )

Summary

This PR adds a new Jupyter notebook (thermocycler_demo.ipynb) under docs/user_guide/ to serve as:

  • A quickstart guide for initializing and using the thermocycler
  • A demonstration of core functionalities, including:
    • Lid and block temperature control
    • PCR profile execution
    • Temperature/status queries

Location

  • docs/user_guide/thermocycler_demo.ipynb

Notes

  • Uses SimulatedThermocyclerBackend for demo purposes
  • Follows structure used by other machine documentation

Related Issue

Closes #633

@rickwierenga
Copy link
Member

Thanks for the PR.

SimulatedThermocyclerBackend is not something that exists in PLR. You might be looking for ThermocyclerChatterboxBackend. Please run your code before contributing to ensure it works.

In notebooks, you don't need asyncio.run to run async methods, you can just run await top level directly. I prefer having all code top level (not in functions) so it's easy to copy paste.

Lastly, I like to group cells by functionality so people can easily copy paste snippets. For example, querying different status commands and opening the lid could be separate cells to make the UX slightly better.

Could you please make these changes? Then I will merge the PR.

@SHISKEBAB
Copy link
Author

SHISKEBAB commented Aug 1, 2025 via email

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

Successfully merging this pull request may close these issues.

2 participants