-
-
Notifications
You must be signed in to change notification settings - Fork 191
ENH: Environment object from EnvironmentAnalysis #813
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
base: develop
Are you sure you want to change the base?
ENH: Environment object from EnvironmentAnalysis #813
Conversation
This method allows the user to create a ```Environment``` object from the ```EnvironmentAnalysis``` object
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #813 +/- ##
===========================================
+ Coverage 79.11% 79.82% +0.70%
===========================================
Files 96 98 +2
Lines 11575 11962 +387
===========================================
+ Hits 9158 9549 +391
+ Misses 2417 2413 -4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
def env( | ||
self, gravity=None, date=None, datum="SIRGAS2000", max_expected_height=80000.0 | ||
): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two points:
- The method would benefit a lot from a docstring!
- The name could be a lot more clearer. A few options should be:
to_rocketpy_environment
,to_environment_object
,get_environment_object
,instantiate_environment_object
. I'm giving some very different options because I'd like you to propose what you think would be clearer to the final user. Anything apart from "env" should already be fine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please mention [in docs] you're using the average profiles.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. I'm just waiting for a response on how to deal with the inversion function before proceeding, because currently there is a problem with the pressure profile. But after the code works, I'll be making the code cleaner (tests, documentation, the name...)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is there anything you need from me?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is really nice. So simple and effective.
Great work @ArthurJWH ! I think you're getting the hang of it...
Some extra points I'd like to add before :
- could you please update the CHANGELOG?
- How familiar are you with unit tests?
- There's an open issue in this repo that may be connected with your PR. Could you please link the PR using the "development" section on the "conversation" section here on GitHub?
I will update the CHANGELOG soon. |
This method allows the user to create a
Environment
object from theEnvironmentAnalysis
objectPull request type
Checklist
black rocketpy/ tests/
) has passed locallypytest tests -m slow --runslow
) have passed locallyCHANGELOG.md
has been updated (if relevant)Current behavior
Issue #657
New behavior
The
env
method have been added, which creates aEnvironment
object from the data retrieved from theEnvironmentAnalysis
classBreaking change