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

ENH new utility functions #376

Merged
merged 13 commits into from
Jun 29, 2023
Merged

ENH new utility functions #376

merged 13 commits into from
Jun 29, 2023

Conversation

Gui-FernandesBR
Copy link
Member

Pull request type

Please check the type of change your PR introduces:

  • Code base additions (bugfix, features)

Pull request checklist

Please check if your PR fulfills the following requirements, depending on the type of PR:

  • Code base additions (for bug fixes / features):

    • Tests for the changes have been added
    • Docs have been reviewed and added / updated if needed
    • Lint (black rocketpy) has passed locally and any fixes were made
    • All tests (pytest --runslow) have passed locally

What is the current behavior?

The getting_started example is too verbose, making it hard to read when one is first trying rocketpy;

What is the new behavior?

The classical apogee_by_mass function was moved from the getting started notebook to the utilities file. This was inspired by: https://github.com/RocketPy-Team/Hackathon_2020/pull/85

Does this introduce a breaking change?

  • No

Other information

  • First you approve the changes, and then we can update the getting_started Notebooks.
  • git diff is broken in my computer. Is that just me?
  • A quick example on how to use the added code:
from rocketpy import Environment, Rocket, Flight
from rocketpy.utilities import apogee_by_mass

TestFlight = Flight(...)

f = apogee_by_mass(TestFlight)
f.plot() # alternatively: f()

@Gui-FernandesBR Gui-FernandesBR added Enhancement New feature or request, including adjustments in current codes Refactor labels Jun 11, 2023
@Gui-FernandesBR Gui-FernandesBR linked an issue Jun 11, 2023 that may be closed by this pull request
@Gui-FernandesBR Gui-FernandesBR added this to the Release v1.1.0 milestone Jun 11, 2023
@Gui-FernandesBR
Copy link
Member Author

Tests passing locally (windows 11, python 3.11.0), but failing on the github workflows (ubuntu);

do we have another fin_flutter case here?

LOL

@MateusStano
Copy link
Member

MateusStano commented Jun 14, 2023

  • git diff is broken in my computer. Is that just me?

Nope, it is broken here too

do we have another fin_flutter case here?

We definitely do. I tried tightening the tolerances and it did not solve the issue too. The only way we know for now to fix this is to either lower the tolerances (to probably only check one or none decimal places) or just remove the test altogether

@Gui-FernandesBR
Copy link
Member Author

  • git diff is broken in my computer. Is that just me?

Nope, it is broken here too

do we have another fin_flutter case here?

We definitely do. I tried tightening the tolerances and it did not solve the issue too. The only way we know for now to fix this is to either lower the tolerances (to probably only check one or none decimal places) or just remove the test altogether

Isn't it just weird how all these bugs happened within the utilities functions only? Is it something related with this file specifically? Maybe some of the imports

@MateusStano MateusStano merged commit 928d63a into beta/v1.0.0 Jun 29, 2023
@Gui-FernandesBR Gui-FernandesBR deleted the enh/new-utility-funcs branch July 1, 2023 03:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request, including adjustments in current codes Refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

A new place for utility functions
2 participants