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

Removing MPError class in favor of baseclasses Error. #12

Merged
merged 9 commits into from
Jan 7, 2021

Conversation

eirikurj
Copy link
Contributor

@eirikurj eirikurj commented Jan 6, 2021

Purpose

This PR,

  • Replaces locally defined MPError class for baseclasses Error
  • Improves documentation
  • Adds a simple example

Type of change

What types of change is it?
Select the appropriate type(s) that describe this PR

  • 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)

Checklist

Put an x in the boxes that apply.

  • 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

@eirikurj eirikurj requested a review from a team as a code owner January 6, 2021 16:05
@eirikurj eirikurj requested review from ewu63 and marcomangano January 6, 2021 16:05
ewu63
ewu63 previously approved these changes Jan 6, 2021
setup.py Outdated
@@ -24,6 +24,6 @@
packages=[
"multipoint",
],
install_requires=["numpy>=1.16", "mpi4py>=3.0"],
install_requires=["numpy>=1.16", "mpi4py>=3.0", "mdolab-baseclasses>=1.3"],
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is the plan to release v1.3 today?

Copy link
Contributor Author

@eirikurj eirikurj Jan 6, 2021

Choose a reason for hiding this comment

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

I was contemplating that since we have several new features and functions there. Perhaps we want to wait a bit more for a few other changes to settle in and then bump the minor release. I will change this to v1.2.4 since this is the first version that has the Error class. Should be there now.

Copy link
Contributor

@marcomangano marcomangano left a comment

Choose a reason for hiding this comment

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

Thanks for adding more examples and checking the code! See my comments below

@@ -4,6 +4,7 @@
import copy
from mpi4py import MPI
import numpy as np
from baseclasses.utils import Error
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need this additional import here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The createGroups function in there uses it.

Copy link
Contributor

Choose a reason for hiding this comment

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

I see, I got confused by the single commit

@@ -22,4 +22,5 @@ For stability we recommend cloning or checking out a tagged release.
:maxdepth: 2

tutorial
examples
Copy link
Contributor

@marcomangano marcomangano Jan 6, 2021

Choose a reason for hiding this comment

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

I believe you are missing the examples.rst file that calls the ex1.py script via literalinclude. The examples are not showing up in the docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Forgot to commit that one. Should be there now.

@ewu63 ewu63 merged commit 52c7703 into mdolab:master Jan 7, 2021
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.

4 participants