Skip to content

Update installation documentation to include Cython instructions #3208

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

Merged
merged 2 commits into from
Mar 25, 2024

Conversation

mrmundt
Copy link
Contributor

@mrmundt mrmundt commented Mar 25, 2024

Fixes #3204

Summary/Motivation:

Bill pointed out that there is no documentation for how to install with Cythonization enabled. This adds a section to the installation page.

Changes proposed in this PR:

  • Update installation page to add Cython instructions
  • Fix some stuff on the installation page that annoyed me

Legal Acknowledgement

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

  1. I agree my contributions are submitted under the BSD license.
  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.

@mrmundt mrmundt requested review from whart222 and blnicho March 25, 2024 17:43
@mrmundt
Copy link
Contributor Author

mrmundt commented Mar 25, 2024

Copy link

codecov bot commented Mar 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.39%. Comparing base (c849905) to head (399cbf5).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3208      +/-   ##
==========================================
- Coverage   88.40%   88.39%   -0.01%     
==========================================
  Files         846      846              
  Lines       95156    95156              
==========================================
- Hits        84118    84109       -9     
- Misses      11038    11047       +9     
Flag Coverage Δ
linux 86.33% <ø> (ø)
osx 76.17% <ø> (ø)
other 86.52% <ø> (-0.02%) ⬇️
win 83.82% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@mrmundt mrmundt merged commit f697791 into Pyomo:main Mar 25, 2024
33 checks passed
@mrmundt mrmundt deleted the document-cython branch March 25, 2024 21:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing documentation for cython-based builds
2 participants