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

Added explicit om namespace import to docs. #2165

Merged
merged 6 commits into from
Jul 8, 2021

Conversation

robfalck
Copy link
Contributor

@robfalck robfalck commented Jul 7, 2021

Summary

The getting_started and basic_user_guide docs will now explicitly show the import of the om namespace, which was previously hidden as part of the logic to install it on colab if necessary.

This also changes the header which installs OpenMDAO on colab so that it doesn't import the OM namespace. Doc examples will fail if om isn't imported in a subsequent code block.

Related Issues

Backwards incompatibilities

None

New Dependencies

None

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@Kenneth-T-Moore
Copy link
Member

@robfalck : You'll need to go to openmdao/docs/openmdao_book/tests/test_jupyter_output_linting.py:LintJupyterOutputsTestCase.test_header and change the test so that it checks notebooks for the new header text.

@Kenneth-T-Moore
Copy link
Member

Looks like you missed some om imports in the distributed tests. They use a separate python env from the single-proc cells. You can find these locally by running the tests that live below openmdao/docs .

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.4%) to 88.905% when pulling 9c178dd on robfalck:import_om2 into 77353f8 on OpenMDAO:master.

@swryan swryan merged commit ab76fef into OpenMDAO:master Jul 8, 2021
@robfalck robfalck deleted the import_om2 branch April 7, 2023 13:49
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.

Explicitly show importing of om namespace in docs.
4 participants