DOC: Replacing git clone command with curl in notebooks. #544
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
requested review from
giovaniceotto,
Gui-FernandesBR,
MateusStano and
phmbressan
phmbressan
approved these changes
Feb 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request type
Checklist
black rocketpy/ tests/) has passed locallyCurrent behavior
As described in issue #526, the repository is cloned on four notebooks to obtain the data files required for computations. However, the total size of the data files is, in general, very small (less than 1 MB), and we are cloning more than 1 GB, hence getting a lot of unnecessary information.
New behavior
Instead of using the !git clone, we use the curl command to download only the required data files from raw GitHub user content from RocketPy's repository. The path name for data files also changed accordingly, e.g. "../../data/calisto/powerOffDragCurve.csv" was changed to "powerOffDragCurve.csv" .
Markdown comments were changed to match the commands. Instead of stating we are going to clone the repository, we state that we are downloading the data files.
Breaking change
Additional information
The dispersion notebooks create two folders "dispersion_analysis_inputs" and "dispersion_analysis_outputs" to save related data files. For those notebooks, we also create the directories when running the data download cells.