ssolson
commented
4 years ago Mina,
It looks like you are working on an outdated version of the documentation. Please review the latest documentation here: https://mhkit-software.github.io/MHKiT/installation.html Sorry I was confused by where you wrote it only works with 3.6 and 3.7 which is what the old documentation said. So it seems like you are trying to update the new documentation with information you got from the old documentation?
MHKiT DOES work with 3.8 we CI test this on every push. See https://travis-ci.org/github/MHKiT-Software/MHKiT-Python.
MATLAB R2020b and higher work with Python 3.8. we do need to add a note about this.
On this point: "Second, The following section is NOT titled "Install the MHKiT-MATLAB Toolbox" section, Instead, it is titled "Install the MHKiT-MATLAB Toolbox (mhkit.mltbx)". Installing the MHKiT-MATLAB toolbox is critical to the operation of the MHKiT package and users often miss that step. While documentation is correct, clarifying the name better might alert users to the importance of the following step."
The fact that we add the specific name of the toolbox to the end of the title is certainly okay and I am fully conscious of what was done here. In my opinion, adding "(mhkit.mltbx)" to the end did not add confusion but if you think it should be added to either the end of the "Skip to ..." statement or remove it from the title then just suggest that, please. What do you mean "users often miss this step"? Do you mean that you missed it? Please let time know what you think "clarifying the name better" would look like.
The toolbox screenshot idea is a good one to add I think.
kmruehl
1. The link to the Anaconda distribution refers to the anaconda distribution with python 3.8. Meanwhile, MHKiT only works with python 3.6 and 3.7. A link to an anaconda distribution with python 3.6 or 3.7 is needed to replace the current link.
2. The "Check the MATLAB Environment for Python" section recommends skipping to the "Install the MHKiT-MATLAB Toolbox" section if the python version is 3.6+. This statement is highlighted in the red box below
There are two issue with that statement:
First, MHKiT only works with Python 3.6 and 3.7; It does NOT work with 3.8. Instead of "3.6+", the doc should only say that 3.6 and 3.7 are good and all other versions of python are bad - as far as MHKiT is concerned.
Second, The following section is NOT titled "Install the MHKiT-MATLAB Toolbox" section, Instead, it is titled "Install the MHKiT-MATLAB Toolbox (mhkit.mltbx)". Installing the MHKiT-MATLAB toolbox is critical to the operation of the MHKiT package and users often miss that step. While documentation is correct, clarifying the name better might alert users to the importance of the following step.
3. To avoid users skipping the "Install the MHKiT-MATLAB Toolbox (mhkit.mltbx)" step, a screen shot of what the user should see can be added to the documentation. An example of such screen shot is added below: