docs(api): Python requirements and simulation behavior in Tutorial #15208
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jwwojak
approved these changes
May 17, 2024
api/docs/v2/tutorial.rst
Outdated
| To run your code, make sure that you've installed `Python 3 <https://wiki.python.org/moin/BeginnersGuide/Download>`_ and the `pip package installer <https://pip.pypa.io/en/stable/getting-started/>`_. You should write your code in your favorite plaintext editor or development environment and save it in a file with a ``.py`` extension, like ``dilution-tutorial.py``. | ||
| You should write your code in your favorite plaintext editor or development environment and save it in a file with a ``.py`` extension, like ``dilution-tutorial.py``. | ||
|
|
||
| To run your code, make sure that you've installed `Python 3.10 <https://www.python.org/downloads/>`_ and the `pip package installer <https://pip.pypa.io/en/stable/getting-started/>`_. If you don't use Python 3.10 as your system Python, we recommend using `pyenv <https://github.com/pyenv/pyenv>`_ to manage multiple Python versions. |
There was a problem hiding this comment.
Should this be stronger, the requirement about Python 3.10?
Instead of, "make sure you've installed it" to something like, "The Opentrons simulation feature only works with Python 3.10" or "To simulate your code, you must use Python 3.10." Something that indicates opentrons_simulate requires this version.
jwwojak
reviewed
May 17, 2024
Carlos-fernandez
pushed a commit
that referenced
this pull request
May 20, 2024
…15208) # Overview Some changes to the Tutorial page to reflect the current requirements and capabilities of `opentrons_simulate`. Notably, the duration estimator never made it out of beta and is fully broken now, so mentions of it have been removed. # Test Plan [Tutorial in sandbox](http://sandbox.docs.opentrons.com/docs-simulation-python-updates/v2/tutorial.html) # Changelog - Mention Python 3.10 and `pyenv` - Remove instruction to use `opentrons_simulate -e` # Risk assessment none
Carlos-fernandez
pushed a commit
that referenced
this pull request
Jun 3, 2024
…15208) # Overview Some changes to the Tutorial page to reflect the current requirements and capabilities of `opentrons_simulate`. Notably, the duration estimator never made it out of beta and is fully broken now, so mentions of it have been removed. # Test Plan [Tutorial in sandbox](http://sandbox.docs.opentrons.com/docs-simulation-python-updates/v2/tutorial.html) # Changelog - Mention Python 3.10 and `pyenv` - Remove instruction to use `opentrons_simulate -e` # Risk assessment none
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Some changes to the Tutorial page to reflect the current requirements and capabilities of
opentrons_simulate.Notably, the duration estimator never made it out of beta and is fully broken now, so mentions of it have been removed.
Test Plan
Tutorial in sandbox
Changelog
pyenvopentrons_simulate -eRisk assessment
none