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

REL: v1.1.4 #503

Merged
merged 13 commits into from
Dec 9, 2023
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 25 additions & 12 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- `Security` in case of vulnerabilities.

Should not be here:
- tests
- github maintenance
- merge commits
- Tests and test updates.
- GitHub maintenance tasks (repository reorganization or CI changes, etc.)
- Merge commits, as they usually don't contain information valuable to the end-user.
- Small refactors that don't impact the functionality or improve performance.
- Minor changes such as "updated a notebook", "updated readme", or other
documentation tweaks unless they significantly enhance understanding or usability.
- In summary: if your change doesn't impact other codes or doesn't offer a
significant improvement for the final user, it probably shouldn't be here.

Types of messages:
- Usually the message is the PR title and number
- If the PR is too long to accomplish all the changes (it shouldn't be...),
you can use a second line to describe it

- The primary message is usually the title of the PR and its number.
- If the PR encompasses a wide range of changes (which ideally it shouldn't),
you can use a second line or a brief list to describe these changes succinctly.
- Ensure the description is clear and understandable even for those who
might not have deep technical knowledge of the project.
-->

## [Unreleased] - yyyy-mm-dd
Expand All @@ -42,24 +48,31 @@ straightforward as possible.

-

## [v1.1.4] - 2023-12-07

You can install this version by running `pip install rocketpy==1.1.4`

### Fixed

- FIX: changes Generic Motor exhaust velocity to cached property [#497](https://github.com/RocketPy-Team/RocketPy/pull/497)

## [v1.1.3] - 2023-11-29

Here we write upgrading notes for brands. It's a team effort to make them as
straightforward as possible.
You can install this version by running `pip install rocketpy==1.1.3`

### Fixed

- FIX: Broken Function.get_value_opt for N-Dimensional Functions [#492](https://github.com/RocketPy-Team/RocketPy/pull/492/files)
- FIX: Broken Function.get_value_opt for N-Dimensional Functions [#492](https://github.com/RocketPy-Team/RocketPy/pull/492)

## [v1.1.2] - 2023-11-25
## [v1.1.2] - 2023-11-27

You can install this version by running `pip install rocketpy==1.1.2`

### Fixed

- BUG: Function breaks if a header is present in the csv file [#485](https://github.com/RocketPy-Team/RocketPy/pull/485)

## [v1.1.1] - 2023-11-23
## [v1.1.1] - 2023-11-24

You can install this version by running `pip install rocketpy==1.1.1`

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
author = "RocketPy Team"

# The full version, including alpha/beta/rc tags
release = "1.1.3"
release = "1.1.4"


# -- General configuration ---------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/notebooks/deployable_payload_example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@
"metadata": {},
"outputs": [],
"source": [
"%pip install rocketpy netCDF4\n",
"%git clone https://github.com/RocketPy-Team/RocketPy.git"
"!pip install rocketpy netCDF4\n",
"!git clone https://github.com/RocketPy-Team/RocketPy.git"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
"metadata": {},
"outputs": [],
"source": [
"%git clone https://github.com/RocketPy-Team/RocketPy.git\n",
"!git clone https://github.com/RocketPy-Team/RocketPy.git\n",
"import os\n",
"\n",
"os.chdir(\"RocketPy/docs/notebooks/dispersion_analysis\")"
Expand Down Expand Up @@ -66,8 +66,7 @@
},
"outputs": [],
"source": [
"%pip install netCDF4\n",
"%pip install rocketpy"
"!pip install rocketpy"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"metadata": {},
"outputs": [],
"source": [
"%git clone https://github.com/giovaniceotto/RocketPy.git\n",
"!git clone https://github.com/giovaniceotto/RocketPy.git\n",
"import os\n",
"\n",
"os.chdir(\"RocketPy/docs/notebooks/dispersion_analysis\")"
Expand Down Expand Up @@ -60,8 +60,7 @@
},
"outputs": [],
"source": [
"%pip install netCDF4\n",
"%pip install rocketpy"
"!pip install rocketpy"
]
},
{
Expand Down
19 changes: 4 additions & 15 deletions docs/notebooks/getting_started_colab.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,9 @@
"We start by setting up our environment. To run this notebook, we will need:\n",
"\n",
"- RocketPy\n",
"- netCDF4 (to get weather forecasts)\n",
"- Data files (we will clone RocketPy's repository for these)\n",
"\n",
"Therefore, let's run the following lines of code:\n"
"Therefore, let's run the following lines of code:"
]
},
{
Expand All @@ -38,8 +37,8 @@
},
"outputs": [],
"source": [
"%pip install rocketpy netCDF4\n",
"%git clone https://github.com/giovaniceotto/RocketPy.git"
"!pip install rocketpy\n",
"!git clone https://github.com/giovaniceotto/RocketPy.git"
]
},
{
Expand Down Expand Up @@ -70,16 +69,6 @@
"Here we go through a simplified rocket trajectory simulation to get you started. Let's start by importing the rocketpy module.\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"%load_ext autoreload\n",
"%autoreload 2"
]
},
{
"cell_type": "code",
"execution_count": 1,
Expand All @@ -101,7 +90,7 @@
"id": "ImgkhEkZNVE8"
},
"source": [
"If you are using Jupyter Notebooks, it is recommended to run the following line to make matplotlib plots which will be shown later interactive and higher quality.\n"
"It is recommended to run the following line to make matplotlib plots which will be shown later interactive and higher quality.\n"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/user/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ If you want to choose a specific version to guarantee compatibility, you may ins

.. code-block:: shell

pip install rocketpy==1.1.3
pip install rocketpy==1.1.4


Optional Installation Method: ``conda``
Expand Down
6 changes: 4 additions & 2 deletions rocketpy/motors/hybrid_motor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from ..mathutils.function import funcify_method, reset_funcified_methods
from ..mathutils.function import Function, funcify_method, reset_funcified_methods
from ..plots.hybrid_motor_plots import _HybridMotorPlots
from ..prints.hybrid_motor_prints import _HybridMotorPrints
from .liquid_motor import LiquidMotor
Expand Down Expand Up @@ -372,7 +372,9 @@ def exhaust_velocity(self):
self.exhaust_velocity : Function
Gas exhaust velocity of the motor.
"""
return self.total_impulse / self.propellant_initial_mass
return Function(
self.total_impulse / self.propellant_initial_mass
).set_discrete_based_on_model(self.thrust)

@funcify_method("Time (s)", "Mass (kg)")
def propellant_mass(self):
Expand Down
4 changes: 3 additions & 1 deletion rocketpy/motors/motor.py
Original file line number Diff line number Diff line change
Expand Up @@ -1224,7 +1224,9 @@ def exhaust_velocity(self):
self.exhaust_velocity : Function
Gas exhaust velocity of the motor.
"""
return self.total_impulse / self.propellant_initial_mass
return Function(
self.total_impulse / self.propellant_initial_mass
).set_discrete_based_on_model(self.thrust)

@funcify_method("Time (s)", "Mass Flow Rate (kg/s)")
def mass_flow_rate(self):
Expand Down
4 changes: 3 additions & 1 deletion rocketpy/motors/solid_motor.py
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,9 @@ def exhaust_velocity(self):
self.exhaust_velocity : Function
Gas exhaust velocity of the motor.
"""
return self.total_impulse / self.propellant_initial_mass
return Function(
self.total_impulse / self.propellant_initial_mass
).set_discrete_based_on_model(self.thrust)

@property
def propellant_initial_mass(self):
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

setuptools.setup(
name="rocketpy",
version="1.1.3",
version="1.1.4",
install_requires=necessary_require,
extras_require={
"env_analysis": env_analysis_require,
Expand Down
Loading