Use case using default config for alpha release #93
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| ## Use Case (UC): Running default config on the JUAMI Potentiostat for Alpha release. | ||
| Intended User: Graduate student (GS) familiar with dev team and basic electrochemistry concepts. The instructions in this UC assume that the student has a resistor they can attach clips to. | ||
| Assumes little to no knowledge of python. Assumes access to a Windows computer. | ||
|
|
||
| ### Before Installation: | ||
| 1. Member of dev team gives GS a JUAMI Potentiostat with a 1kOhm resistor. | ||
| 1. GS installs python on their computer. | ||
|
|
||
| ### Installation: | ||
| 1. GS recieves email from member of dev team with link to release page. | ||
| 1. GS follow instructions on release page to install pytentiostat program. | ||
|
|
||
| ### Experimental Setup: | ||
| 1. GS plugs the USB cable into the computer and the potentiostat. | ||
| 1. GS attaches alligator clips to the resistor; one side with the working electrode and the other side with counter and reference electrodes. | ||
|
|
||
| ### Program Setup: | ||
| 1. GS copies the default example config file to an easy to navigate to directory (WD). | ||
| 1. GS opens up a console window. | ||
|
Collaborator
There was a problem hiding this comment. I might change "console window" to "command line/terminal" to sound more familiar. |
||
| 1. GS navigates to the WD. | ||
| 1. GS types command pytentiostat. | ||
|
|
||
| ### Pytentiostat Operation: | ||
| 1. Pytentiostat prints to console "Welcome to the JUAMI pytentiostat interface!". | ||
| 1. Pyentiostat prompts "Press enter to connect to a JUAMI potentiostat.". | ||
| 1. GS presses enter. | ||
| 1. Pytentiostat prints to console "Searching for potentiostat...". | ||
| 1. Pyentiostat prints to console "Pytentiostat connected COM. Reading configuration file...". | ||
|
Collaborator
There was a problem hiding this comment. The part "Reading configuration file..." has been removed.
Member
There was a problem hiding this comment. good. Less chatter is always better. |
||
| 1. Pytentiostat prints to console "Press enter to load the config file". | ||
| 1. GS presses enter. | ||
| 1. Pytentiostat prints to console "Press enter to start the experiment". | ||
| 1. Pytentiostat runs experiment in config. | ||
| 1. Pyentiostat displays plot of real-time data to user. | ||
| 1. After running experiment, pytentiostat promopts "Would you like to save the data? [y/n]". | ||
| 1. GS types y. | ||
| 1. Pytentiostat saves the data to their desktop. | ||
| 1. Pytentiostat prompts if user wants to run another experiment. | ||
| 1. GS types n. | ||
|
Collaborator
There was a problem hiding this comment. Latest version automatically saves without asking. First prompt is "Would you like to repeat the last experiment? [y/n]" |
||
| 1. Pytentiostat program closes. | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you should change python to miniconda to be more specific.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree. python and miniconda are different. Let's make instructions that can be followed step by step. There should probably be a pre-step that asks the user to check their system to see if miniconda or Anaconda is installed. They could just open a terminal and type "conda" for example.
We have to decide whether we want to make them use the miniconda command prompt. It changes how they do the installation. There are arguments for doing it either way so I am not sure....we could discuss more on a call.