Merge pull request #483 from RocketPy-Team/hotfix/v1.1.1

HOTFIX: v1.1.1

Author: MateusStano

.github/pull_request_template.md

@@ -3,18 +3,21 @@
 <!-- You may use this template to describe your Pull Request. But if you believe there is a better way to express yourself, don't hesitate! -->
 
 ## Pull request type
+<!-- Remove unchecked box items. -->
 
 - [ ] Code changes (bugfix, features)
 - [ ] Code maintenance (refactoring, formatting, tests)
 - [ ] ReadMe, Docs and GitHub updates
 - [ ] Other (please describe):
 
 ## Checklist
+<!-- Remove irrelevant items to this PR. -->
 
 - [ ] Tests for the changes have been added (if needed)
 - [ ] Docs have been reviewed and added / updated
 - [ ] Lint (`black rocketpy/ tests/`) has passed locally 
 - [ ] All tests (`pytest --runslow`) have passed locally
+- [ ] `CHANGELOG.md` has been updated (if relevant)
 
 ## Current behavior
 <!-- Describe current behavior or link to an issue. -->
@@ -27,12 +30,12 @@ Enter text here...
 Enter text here...
 
 ## Breaking change
-<!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. -->
+<!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. Remove the unchecked box item. -->
 
 - [ ] Yes
 - [ ] No
 
 ## Additional information
-<!-- Include any relevant details or screenshots. -->
+<!-- Include any relevant details or screenshots. If none, remove this section. -->
 
 Enter text here...

CHANGELOG.md

@@ -0,0 +1,97 @@
+# RocketPy Change Log
+
+All notable changes to `RocketPy` project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+<!-- Types of changes:
+    - `Added` for new features.
+    - `Changed` for changes in existing functionality.
+    - `Deprecated` for soon-to-be removed features.
+    - `Removed` for now removed features.
+    - `Fixed` for any bug fixes.
+    - `Security` in case of vulnerabilities.
+
+    Should not be here:
+    - tests
+    - github maintenance
+    - merge commits
+
+    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
+
+-->
+
+## [Unreleased] - yyyy-mm-dd
+
+Here we write upgrading notes for brands. It's a team effort to make them as
+straightforward as possible.
+
+### Added
+
+-
+
+### Changed
+
+-
+
+### Fixed
+
+-
+
+
+## [v1.1.1] - 2023-11-23
+
+You can install this version by running `pip install rocketpy==1.1.1`
+
+
+### Added
+
+- DOC: Added this changelog file [#472](https://github.com/RocketPy-Team/RocketPy/pull/472)
+- ENH: Prevent out of bounds Tanks from Instantiation #484 [#484](https://github.com/RocketPy-Team/RocketPy/pull/484)
+
+### Fixed
+
+- HOTFIX: Negative Static Margin [#476](https://github.com/RocketPy-Team/RocketPy/pull/476)
+- HOTFIX: 2D .CSV Function and missing set_get_value_opt call [#478](https://github.com/RocketPy-Team/RocketPy/pull/478)
+- HOTFIX: Tanks Overfill not Being Detected [#479](https://github.com/RocketPy-Team/RocketPy/pull/479)
+
+## [v1.1.0] - 2023-11-19
+
+You can install this version by running `pip install rocketpy==1.1.0`
+
+### Added
+
+- DOC: Documentation for Function Class Usage [#465](https://github.com/RocketPy-Team/RocketPy/pull/465)
+- DOC: first simulation all_info [#466](https://github.com/RocketPy-Team/RocketPy/pull/466)
+- ENH: draw motors [#436](https://github.com/RocketPy-Team/RocketPy/pull/436)
+- DOC: add documentation for flight data export. [#464](https://github.com/RocketPy-Team/RocketPy/pull/464)
+- ENH: Add mass_flow_rate() to GenericMotor class [#459](https://github.com/RocketPy-Team/RocketPy/pull/459)
+- DOC: Add documentation on how to build the docs [#452](https://github.com/RocketPy-Team/RocketPy/pull/452)
+- ENH: new Flight.get_solution_at_time() method [#441](https://github.com/RocketPy-Team/RocketPy/pull/441)
+- ENH: rocket drawing [419](https://github.com/RocketPy-Team/RocketPy/pull/419)
+- ENH: Adding Stability Margin with Mach dependency [#377](https://github.com/RocketPy-Team/RocketPy/pull/377)
+
+### Changed
+
+- ENH: Spherical Caps Included in Total Length [#455](https://github.com/RocketPy-Team/RocketPy/pull/455)
+  - Important: This changes behavior of `TankGeometry.add_spherical_caps()`
+- ENH: Clean Plots and Prints sub packages init files [#457](https://github.com/RocketPy-Team/RocketPy/pull/457)
+- ENH: Add \_MotorPlots Inheritance to Motor Plots Classes [#456](https://github.com/RocketPy-Team/RocketPy/pull/456)
+- DOC: organize flight examples folder [#429](https://github.com/RocketPy-Team/RocketPy/pull/429)
+- DOC: improve mass and inertia docs [#445](https://github.com/RocketPy-Team/RocketPy/pull/445)
+
+### Fixed
+
+- MNT: Refactor exhaust velocity calculation to avoid ZeroDivisionError [#470](https://github.com/RocketPy-Team/RocketPy/pull/470)
+- BUG: Fix find_input() Function to Return a Single Value [#471](https://github.com/RocketPy-Team/RocketPy/pull/471)
+- DOC: refactor dispersion analysis notebook [#463](https://github.com/RocketPy-Team/RocketPy/pull/463)
+- BUG: User input checks added for Function class [#451](https://github.com/RocketPy-Team/RocketPy/pull/451)
+- DOC: fix positions and coordinate system documentation page [#454](https://github.com/RocketPy-Team/RocketPy/pull/)
+- MNT: fix env plots legends [#440](https://github.com/RocketPy-Team/RocketPy/pull/440)
+- BUG: flight.prints.max_values() fails when launching an EmptyMotor [#438](https://github.com/RocketPy-Team/RocketPy/pull/438)
+- BUG: Maintaining Extrapolation when Adding Discrete Functions with Constants [#432](https://github.com/RocketPy-Team/RocketPy/pull/432)
+- MNT: Fix env plots max heights [#433](https://github.com/RocketPy-Team/RocketPy/pull/433)

docs/conf.py

@@ -24,7 +24,7 @@
 author = "RocketPy Team"
 
 # The full version, including alpha/beta/rc tags
-release = "1.1.0"
+release = "1.1.1"
 
 
 # -- General configuration ---------------------------------------------------

docs/examples/SEB_liquid_motor.ipynb

@@ -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.0
+    pip install rocketpy==1.1.1
 
 
 Optional Installation Method: ``conda``

docs/user/installation.rst

@@ -229,15 +229,6 @@ def source_function(_):
 
                 # Finally set data source as source
                 self.source = source
-                # Update extrapolation method
-                if self.__extrapolation__ is None:
-                    self.set_extrapolation()
-                # Set default interpolation for point source if it hasn't
-                if self.__interpolation__ is None:
-                    self.set_interpolation()
-                else:
-                    # Updates interpolation coefficients
-                    self.set_interpolation(self.__interpolation__)
             # Do things if function is multivariate
             else:
                 self.x_array = source[:, 0]
@@ -251,6 +242,15 @@ def source_function(_):
 
                 # Finally set data source as source
                 self.source = source
+            # Update extrapolation method
+            if self.__extrapolation__ is None:
+                self.set_extrapolation()
+            # Set default interpolation for point source if it hasn't
+            if self.__interpolation__ is None:
+                self.set_interpolation()
+            else:
+                # Updates interpolation coefficients
+                self.set_interpolation(self.__interpolation__)
         return self
 
     @cached_property
@@ -329,7 +329,7 @@ def set_extrapolation(self, method="constant"):
     def set_get_value_opt(self):
         """Crates a method that evaluates interpolations rather quickly
         when compared to other options available, such as just calling
-        the object instance or calling ``Function.get_value directly``. See
+        the object instance or calling ``Function.get_value`` directly. See
         ``Function.get_value_opt`` for documentation.
 
         Returns
@@ -2715,7 +2715,7 @@ def compose(self, func, extrapolate=False):
         if isinstance(self.source, np.ndarray) and isinstance(func.source, np.ndarray):
             # Perform bounds check for composition
             if not extrapolate:
-                if func.min < self.x_initial and func.max > self.x_final:
+                if func.min < self.x_initial or func.max > self.x_final:
                     raise ValueError(
                         f"Input Function image {func.min, func.max} must be within "
                         f"the domain of the Function {self.x_initial, self.x_final}."
@@ -2785,7 +2785,8 @@ def _check_user_input(
             dimensions of inputs and outputs. If the outputs list has more than
             one element.
         TypeError
-            If the source is not a list, np.ndarray, or Function object.
+            If the source is not a list, np.ndarray, Function object, str or
+            Path.
         Warning
             If inputs or outputs do not match for a Function source, or if
             defaults are used for inputs, interpolation,and extrapolation for a
@@ -2825,10 +2826,16 @@ def _check_user_input(
 
         # check source for data type
         # if list or ndarray, check for dimensions, interpolation and extrapolation
-        if isinstance(source, (list, np.ndarray)):
-            # this will also trigger an error if the source is not a list of
-            # numbers or if the array is not homogeneous
-            source = np.array(source, dtype=np.float64)
+        if isinstance(source, (list, np.ndarray, str, Path)):
+            # Deal with csv or txt
+            if isinstance(source, (str, Path)):
+                # Convert to numpy array
+                source = np.loadtxt(source, delimiter=",", dtype=float)
+
+            else:
+                # this will also trigger an error if the source is not a list of
+                # numbers or if the array is not homogeneous
+                source = np.array(source, dtype=np.float64)
 
             # check dimensions
             source_dim = source.shape[1]