Skip to content

Use case using default config for alpha release - #93

Open
aplymill7 wants to merge 8 commits into
juami:mainfrom
aplymill7:add_config_UC
Open

Use case using default config for alpha release#93
aplymill7 wants to merge 8 commits into
juami:mainfrom
aplymill7:add_config_UC

Conversation

@aplymill7

Copy link
Copy Markdown
Member

This is a use case for a simple operation of the pytentiostat that should be satisfied by the program upon alpha release. This PR also sets up a directory for future use cases in examples/dev/.

@aplymill7 aplymill7 added the documentation Explains how the code works or how to use it label Oct 15, 2019
@aplymill7 aplymill7 added this to the v0.0.2 milestone Oct 15, 2019
@aplymill7

Copy link
Copy Markdown
Member Author

Not sure why this error started popping up:

"RemoveError: 'setuptools' is a dependency of conda and cannot be removed from
conda's operating environment."

Saw same error on @jlhitt1993 's latest PR.

@sbillinge

Copy link
Copy Markdown
Member

I have fixed the setuptools error with a workaround. It is some problem with conda that I couldn't find a complete fix for, but the builds should work now for the time being.

@codecov-io

codecov-io commented Oct 16, 2019

Copy link
Copy Markdown

Codecov Report

Merging #93 into master will increase coverage by 1.38%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #93      +/-   ##
==========================================
+ Coverage   70.95%   72.34%   +1.38%     
==========================================
  Files           8        8              
  Lines         210      282      +72     
==========================================
+ Hits          149      204      +55     
- Misses         61       78      +17
Impacted Files Coverage Δ
pytentiostat/reporter.py 70.58% <0%> (-4.42%) ⬇️
pytentiostat/routines.py 64.28% <0%> (-0.72%) ⬇️
tests/test_reporter.py 100% <0%> (ø) ⬆️
pytentiostat/config_reader.py 64.58% <0%> (+11.95%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6e39e85...0f97843. Read the comment docs.

@jlhitt1993 jlhitt1993 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you should break up lines 2 and 15 so they are less than 100 characters for readability.

Comment thread examples/dev/Alpha_Config_UC Outdated
Comment on lines +34 to +38
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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Latest version automatically saves without asking. First prompt is "Would you like to repeat the last experiment? [y/n]"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good.

Comment thread examples/dev/Alpha_Config_UC Outdated
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...".

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The part "Reading configuration file..." has been removed.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good. Less chatter is always better.


### 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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might change "console window" to "command line/terminal" to sound more familiar.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree

Comment thread examples/dev/Alpha_Config_UC Outdated

### Before Installation:
1. Member of dev team gives GS a JUAMI Potentiostat with a 1kOhm resistor.
1. GS installs python on their computer.

Copy link
Copy Markdown
Collaborator

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.

Copy link
Copy Markdown
Member

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.

@aplymill7

Copy link
Copy Markdown
Member Author

Thanks for the feedback, added the recommendations. Yeah, let's discuss instillation when we get started back up again.

@sbillinge

Copy link
Copy Markdown
Member

is this wanted? We can work to merge it or we can close it.

@sbillinge sbillinge removed this from the v0.0.2 milestone Jan 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Explains how the code works or how to use it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants