Skip to content
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

changed macosx tutorial to properly handle different mac arch possibi… #1544

Merged
merged 7 commits into from
Feb 13, 2025

Conversation

azaidi06
Copy link
Contributor

…lities with single command

Fixes

This fixes issue #1497 : #1497

Summary/Motivation:

New Mac devices now come with apple silicon which requires a different set of binaries relative to previous intel version -- in order to accommodate both types, a single command is used to determine and download what's appropriate.

Changes proposed in this PR:

Simply changing the tutorial for Macs to accommodate the potential differences in CPU arch -- the command will be able to determine which arch is being used on the device and download the appropriate binaries. This will help mitigate potential mistakes of downloading the incorrect type/version for apple silicon vs intel.

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@codecov-commenter
Copy link

codecov-commenter commented Nov 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.05%. Comparing base (d43c5dd) to head (fd2dbcb).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1544      +/-   ##
==========================================
- Coverage   77.06%   77.05%   -0.01%     
==========================================
  Files         389      389              
  Lines       62680    62680              
  Branches    10276    10276              
==========================================
- Hits        48303    48300       -3     
- Misses      11939    11943       +4     
+ Partials     2438     2437       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lbianchi-lbl lbianchi-lbl added documentation Documentations comments and requests Priority:Normal Normal Priority Issue or PR labels Dec 5, 2024
@ksbeattie
Copy link
Member

The rendering of this:

image

I think could be improved. Maybe something more like the following section:

image

using the .. include:: and a .. code-block:: console like the other sections.

@ksbeattie
Copy link
Member

@azaidi06 will look at this today.

azaidi06 and others added 2 commits February 6, 2025 11:42
@ksbeattie
Copy link
Member

It's getting better..

image

but still not quite there.

Added newline before the code-block directive to rectify rendering issue
removed extraneous backtick in the changed command to help with rendering
adding newline after code-block directive to render correctly
@azaidi06
Copy link
Contributor Author

azaidi06 commented Feb 12, 2025

corrected the newlines missing around the directive and now its rendering correctly

Screenshot 2025-02-12 at 5 05 41 PM

@lbianchi-lbl lbianchi-lbl self-requested a review February 13, 2025 18:22
Copy link
Contributor

@lbianchi-lbl lbianchi-lbl left a comment

Choose a reason for hiding this comment

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

Minor changes (should be enough to hit "Commit suggestion")

docs/tutorials/getting_started/mac_osx.rst Outdated Show resolved Hide resolved
remove numbering and re-add double quotes around second command

Co-authored-by: Ludovico Bianchi <[email protected]>
@lbianchi-lbl lbianchi-lbl self-requested a review February 13, 2025 19:31
@ksbeattie ksbeattie merged commit ce941ce into IDAES:main Feb 13, 2025
23 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentations comments and requests Priority:Normal Normal Priority Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants