diff --git a/docs/development/github_tutorial.md b/docs/development/github_tutorial.md index 4cd926884..6a96cb721 100644 --- a/docs/development/github_tutorial.md +++ b/docs/development/github_tutorial.md @@ -28,7 +28,7 @@ First and foremost, the participant must open a terminal session and change the ```sh cd -git clone https://github.com/Projeto-Jupiter/RocketPy-Hackathon-2022.git +git clone https://github.com/RocketPy-Team/RocketPy-Hackathon-2022.git ``` ### Basic Workflow @@ -59,7 +59,7 @@ A new Pull Request can be made by specifying which changes should be merged into ### Forks -A Fork is a copy of a GitHub repository that allows the user to make changes to a repository while keeping the original unchanged, the changes are updated to the original repository through pull requests. The participant will solve the Challenges and make contributions to a local Fork of the Hackathon GitHub repository, so that it is possible to keep the solutions organized and avoid conflicts that arise from multiple groups editing the same code. It is recommended to use GitHub environment to create a Fork, the participant has to click on the top right corner of the Hackathon GitHub page: +A Fork is a copy of a GitHub repository that allows the user to make changes to a repository while keeping the original unchanged, with changes being updated to the original repository through pull requests. The participant will solve the Challenges and make contributions to a local Fork of the Hackathon GitHub repository, so that it is possible to keep the solutions organized and avoid conflicts that arise from multiple groups editing the same code. It is recommended to use GitHub environment to create a Fork, the participant has to click on the top right corner of the Hackathon GitHub page: ![fork_button](https://docs.github.com/assets/cb-23088/images/help/repository/fork_button.png) diff --git a/docs/development/rocketpy_as_developer.rst b/docs/development/rocketpy_as_developer.rst index 0074433ae..adbe76a91 100644 --- a/docs/development/rocketpy_as_developer.rst +++ b/docs/development/rocketpy_as_developer.rst @@ -31,7 +31,7 @@ Preparing directory for code editing ==================================== You may create a testing file in any directory, but you must remember that they should not be included in the commits and pull requests unless they are part of the proposed solution. -With that in mind, it is suggested the creation of a folder with all the testing files, so they can be added in the .gitignore file, which contains the name of all the files and folders that will not be added to the commits. To create the folder, type on the terminal: +With that in mind, we suggest you to create a folder with all testing files, so they can be added in the .gitignore file, which contains the name of all the files and folders that will not be added to the commits. To create the folder, type on the terminal: .. code-block:: console @@ -124,7 +124,7 @@ The motor class contains information about the thrust curve and uses some geomet .. code-block:: python Pro75M1670 = SolidMotor( - thrustSource="../data/motors/Cesaroni_M1670.eng", + thrustSource="../data/motors/Cesaroni_M1670.eng", #copy here the path to the thrust source file burnOut=3.9, grainNumber=5, grainSeparation=5 / 1000, @@ -158,8 +158,8 @@ The first step is to initialize the class with the vital data: inertiaZ=0.0351, distanceRocketNozzle=-1.255, distanceRocketPropellant=-0.85704, - powerOffDrag="../../data/calisto/powerOffDragCurve.csv", - powerOnDrag="../../data/calisto/powerOnDragCurve.csv", + powerOffDrag="../../data/calisto/powerOffDragCurve.csv", #copy here the path to the drag curve file + powerOnDrag="../../data/calisto/powerOnDragCurve.csv", #copy here the path to the drag curve file ) Then the rail buttons must be set: @@ -252,5 +252,5 @@ For example, to access Flight class parameters, you can use: help(Flight) -More documentation materials can be found at [read the docs](https://docs.rocketpy.org/en/latest/?badge=latest). +More documentation materials can be found at `read the docs `_. It can also be found on RocketPy's GitHub page on the badge "docs". \ No newline at end of file diff --git a/docs/issue_#68_team09 b/docs/issue_#68_team09 new file mode 100644 index 000000000..85e3fd8ad --- /dev/null +++ b/docs/issue_#68_team09 @@ -0,0 +1,11 @@ +RocketPy Ideas + +- RocketPy could automatically support different types of inputs on the dispersion errors. For Example, inserting an error value directly or just a percentage. + +- RocketPy could be implemented on Julia. This language naturally supports Metaprogramming + +- The Fin optimization could consider the number of fins as a variable and find the best compromise between size, mass, drag, quantity and lift of the fins, considering that less fins will generate less Drag, but they also need to be bigger to generate the same lift as a higher fin quantity. + +- RocketPy could simulate different rocket profiles, eg. hexagonal, squared etc.. since these non circular profiles will generate lift. + +- RocketPy could have an optimization in which given data such as trajectory and apogee, it returns adjustable parameters of the rocket and launchpad ex.: mass, center of mass, rail angle etc. \ No newline at end of file