search

MHKiT-Software / MHKiT

MHKiT Documentation
https://MHKiT-Software.github.io/MHKiT/
4 stars 14 forks source link

Add Separate MHKiT-MATLAB installation instructions #58

Closed simmsa closed 6 months ago

simmsa commented 7 months ago

This separates out installation instructions for MHKiT-MATLAB and rewrites the installation to include:

Additional changes include:

simmsa commented 6 months ago

@rpauly18 and @akeeste,

This PR is good to go:

At a high level this adds:

This includes more changes that the title of this PR suggests, let me know if it makes sense to break this PR out into smaller changes.

simmsa commented 6 months ago

@rpauly18, thank you for the review! The latest commits incorporate changes that fix all of your recommended changes.

  1. please add a step for actually downloading or cloning MHKIT-Matlab. In step 4 you refer to navigating to the MHKIT-Matlab folder, but there is never instruction to actually downloading that

I added step 4 detailing instructions for downloading the MHKiT-MATLAB repository

  1. Small nitpicky comment - in step 2.4 Python 3.9 is recommended, but the image shows creating the environment in 3.10. I recommend making the image match the recommendation

Changed to 3.10. I was thinking that 3.9 was a good option, but 3.10 is what I chose initially and that should work for most users

  1. the way the instruction in step 5.2 is worded is a bit confusing. Maybe change to "In the MATLAB command window type the command below, replacing the with the python executable location from above:"

Updated 6.2 (previously 5.2) instructions to clarify executable location

  1. in step 7, why is it stating that the output from circular is a Python tuple? At this point it should be returning a Matlab data type

Updated step 8 (previously 7) MATLAB circular output figure to use the MHKiT-MATLAB command.