-
Notifications
You must be signed in to change notification settings - Fork 13
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
Update MHKiT-Python installation instructions #75
base: master
Are you sure you want to change the base?
Conversation
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.
Thanks @simmsa. My main comment is on how we fit git into the installation workflow, primarily because of how incredibly useful the examples are to new users.
|
||
Using this option to install MHKiT-Python will automatically install Pecos. | ||
1. `Install Conda <https://docs.conda.io/projects/conda/en/stable/user-guide/install/index.html>`_ with Anaconda Distribution or Miniconda: |
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.
reference the distribution comparison here https://docs.anaconda.com/distro-or-miniconda/
Install MHKiT-Python | ||
^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
Option 1: PIP Install from Python | ||
"""""""""""""""""""""""""""""""""""" | ||
Option 1: Using Conda |
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 prefer using conda and agree with that as option 1. I think we should further update these steps and discuss git first. This was an issue we ran into at the last training course. When new users come to MHKiT, they very likely want/need the example notebooks. To get those, one needs to use git. An adjustment to these steps could proceed like this:
- Decide whether to use git.
- Pros: examples will be installed, enables the developer workflow, users are later one step closer to opening issues and PRs
- Cons: requires installing / using another software that is not required to run MHKiT
- If yes git:
- install git for windows
- clone repo using the single command line
- use environment.yml file included in the repo (user workflow) OR pip install the local clone (developer workflow)
- If no git
- curl to get environment.yml file and conda install OR pip install
|
||
Using Miniconda: | ||
|
||
- Launch your preferred terminal and execute the following command: |
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 don't think conda is guaranteed to be active in any terminal (e.g. command prompt). I think we direct users to search for and open the anaconda terminal directly
Summary of changes:
environment.yml
from MHKiT-Python mastercurl -o mhkit_environment.yml https://raw.githubusercontent.com/MHKiT-Software/MHKiT Python/master/environment.yml
curl
doesn't workpytest
, fixing Remove reference to nose tests #72