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

Remove simpleOCart and update imports #54

Merged
merged 11 commits into from
May 12, 2022
Merged

Remove simpleOCart and update imports #54

merged 11 commits into from
May 12, 2022

Conversation

sseraj
Copy link
Collaborator

@sseraj sseraj commented May 11, 2022

Purpose

I removed simpleOCart (which was moved to pyHyp in mdolab/pyhyp#61), cleaned up some of the imports, and updated the dependencies in setup.py.

Expected time until merged

One week (and after mdolab/MACH-Aero#80 is merged)

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Checklist

  • I have run flake8 and black to make sure the code adheres to PEP-8 and is consistently formatted
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@sseraj sseraj requested a review from a team as a code owner May 11, 2022 14:07
@sseraj sseraj requested review from joanibal and akleb May 11, 2022 14:07
@codecov
Copy link

codecov bot commented May 11, 2022

Codecov Report

Merging #54 (fe7e321) into main (89b97fe) will increase coverage by 0.54%.
The diff coverage is 9.62%.

@@            Coverage Diff             @@
##             main      #54      +/-   ##
==========================================
+ Coverage   21.25%   21.79%   +0.54%     
==========================================
  Files           3        3              
  Lines        2329     2271      -58     
==========================================
  Hits          495      495              
+ Misses       1834     1776      -58     
Impacted Files Coverage Δ
cgnsutilities/cgns_utils.py 0.00% <0.00%> (ø)
cgnsutilities/cgnsutilities.py 27.67% <9.60%> (+0.71%) ⬆️
cgnsutilities/__init__.py 100.00% <100.00%> (ø)

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

Copy link
Contributor

@akleb akleb left a comment

Choose a reason for hiding this comment

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

So I see that we are leaving scipy and pyspline as requirements for "advanced features" so the imports are left in. The advanced tag seems a little weird to me (I would just think everything is required always). If we are okay with the advanced tag then this looks good to me.

@@ -924,8 +841,6 @@ def tanDist(Sp1, Sp2, N):
# Sp2: final spacing (within the [0,1] interval)
# N: number of nodes

# IMPORTS
from numpy import tan, arange, pi
from scipy.optimize import minimize
Copy link
Contributor

Choose a reason for hiding this comment

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

Why did we move import re outside, but not import scipy

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Keeping the SciPy import inside the function means that the user does not need to have SciPy if they are not using the function. This is directly related to keeping it as an 'advanced' dependency.

I added the 'advanced' features because I didn't want to add pySpline as a hard dependency for a single function (rebunch) that I'm pretty sure no one uses. I think adding SciPy as a hard dependency is justifiable though if we want to do that because it doesn't require compiling another MDO Lab code.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I was thinking something along these lines. SciPy is a pretty common package.

Copy link
Collaborator

@ewu63 ewu63 left a comment

Choose a reason for hiding this comment

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

I would be okay with adding scipy as a dependency, but it probably makes sense to keep pyspline out. Also, we may want to bump the version here.

akleb
akleb previously approved these changes May 11, 2022
@sseraj sseraj requested review from ewu63 and akleb and removed request for joanibal May 12, 2022 19:02
Copy link
Contributor

@akleb akleb left a comment

Choose a reason for hiding this comment

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

Any reason why we took the install instructions out of the readme?

@sseraj
Copy link
Collaborator Author

sseraj commented May 12, 2022

Any reason why we took the install instructions out of the readme?

The instructions got moved to the Sphinx docs in #55. That's consistent with where the rest of the MACH-Aero repos have the installation guide.

@akleb akleb self-requested a review May 12, 2022 19:50
@akleb akleb merged commit 2bde4dd into main May 12, 2022
@akleb akleb deleted the update-imports branch May 12, 2022 19:51
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.

3 participants