Merge remote-tracking branch 'origin/beta/v1.0.0' into enh/new-utility-funcs

Author: MateusStano

README.md

@@ -185,7 +185,6 @@ A sample code is:
 
 ```python
 Env = Environment(
-    railLength=5.2,
     latitude=32.990254,
     longitude=-106.974998,
     elevation=1400,
@@ -300,7 +299,7 @@ help(Flight)
 To actually create a Flight object, use:
 
 ```python
-TestFlight = Flight(rocket=Calisto, environment=Env, inclination=85, heading=0)
+TestFlight = Flight(rocket=Calisto, environment=Env, railLength=5.2, inclination=85, heading=0)
 ```
 
 Once the Flight object is created, your simulation is done! Use the following code to get a summary of the results:

docs/development/rocketpy_as_developer.rst

@@ -92,7 +92,7 @@ It contains information about the local pressure profile, temperature, speed of
 
 .. code-block:: python
 
-    Env = Environment(railLength=5.2, latitude=32.990254, longitude=-106.974998, elevation=1400)
+    Env = Environment(latitude=32.990254, longitude=-106.974998, elevation=1400)
 
 RocketPy can use local files via the Ensemble method or meteorological forecasts through OpenDAP protocol. 
 To work with environment files, it will be very important ensuring tha that you have the netCDF4 library installed.
@@ -243,11 +243,11 @@ Simulating the flight
 ---------------------
 
 Finally, the flight can be simulated with the provided data.
-The rocket and environment classes are supplied as inputs, as well as the rail inclination and heading angle.
+The rocket and environment classes are supplied as inputs, as well as the rail length, inclination and heading angle.
 
 .. code-block:: python
 
-    TestFlight = Flight(rocket=Calisto, environment=Env, inclination=85, heading=0)
+    TestFlight = Flight(rocket=Calisto, environment=Env, railLength=5.2, inclination=85, heading=0)
 
 Flight data can be retrieved through:
 

docs/matlab/Getting_Started.m

@@ -37,9 +37,8 @@
 %% Setting Up a Simulation
 % Creating an Environment for Spaceport America
 
-% rocketpy.Environment(railLength, latitude, longitude, elevation);
+% rocketpy.Environment(latitude, longitude, elevation);
 Env = rocketpy.Environment(pyargs(...
-    'railLength', 5.2, ...
     'latitude', 32.990254, ...
     'longitude',-106.974998, ...
     'elevation', 1400 ...
@@ -217,6 +216,7 @@
 TestFlight = rocketpy.Flight(pyargs(...
     'rocket', Calisto, ...
     'environment',Env, ...
+    'railLength', 5.2, ...
     'inclination', 85, ...
     'heading', 0 ...
 ));

docs/notebooks/compare_flights_usage.ipynb

@@ -69,7 +69,7 @@
    "outputs": [],
    "source": [
     "after_tomorrow = datetime.now() + timedelta(days=2)\n",
-    "env = Environment(railLength=5, latitude=-23, longitude=-49, date=after_tomorrow)\n",
+    "env = Environment(latitude=-23, longitude=-49, date=after_tomorrow)\n",
     "env.setAtmosphericModel(type=\"Forecast\", file=\"GFS\")\n",
     "\n",
     "Pro75M1670 = SolidMotor(\n",
@@ -182,6 +182,7 @@
     "        flight = Flight(\n",
     "            environment=env,\n",
     "            rocket=Calisto,\n",
+    "            railLength=5\n",
     "            inclination=inclination,\n",
     "            heading=heading,\n",
     "            name=f\"Incl {inclination} Head {heading}\",\n",

docs/notebooks/deployable_payload_example.ipynb

@@ -112,7 +112,7 @@
             "outputs": [],
             "source": [
                 "Env = Environment(\n",
-                "    railLength=5.2, latitude=32.990254, longitude=-106.974998, elevation=1400\n",
+                "    latitude=32.990254, longitude=-106.974998, elevation=1400\n",
                 ")"
             ]
         },
@@ -4719,7 +4719,7 @@
             "outputs": [],
             "source": [
                 "RocketFlight1 = Flight(\n",
-                "    rocket=Rocket1, environment=Env, inclination=85, heading=25, terminateOnApogee=True, name=\"RocketFlight1\"\n",
+                "    rocket=Rocket1, environment=Env, railLength=5.2, inclination=85, heading=25, terminateOnApogee=True, name=\"RocketFlight1\"\n",
                 ")"
             ]
         },
@@ -4873,6 +4873,7 @@
                 "RocketFlight2 = Flight(\n",
                 "    rocket=Rocket2,\n",
                 "    environment=Env,\n",
+                "    railLength=5.2,\n",
                 "    inclination=0,\n",
                 "    heading=0,\n",
                 "    maxTime=600,\n",
@@ -4977,6 +4978,7 @@
                 "PayloadFlight = Flight(\n",
                 "    rocket=PayloadRocket,\n",
                 "    environment=Env,\n",
+                "    railLength=5.2,\n",
                 "    inclination=0,\n",
                 "    heading=0,\n",
                 "    maxTime=600,\n",

docs/notebooks/dispersion_analysis/dispersion_analysis.ipynb

@@ -414,7 +414,7 @@
     "\n",
     "# Define basic Environment object\n",
     "Env = Environment(\n",
-    "    railLength=5.7, date=(2019, 8, 10, 21), latitude=-23.363611, longitude=-48.011389\n",
+    "    date=(2019, 8, 10, 21), latitude=-23.363611, longitude=-48.011389\n",
     ")\n",
     "Env.setElevation(668)\n",
     "Env.maxExpectedHeight = 1500\n",
@@ -440,7 +440,6 @@
     "\n",
     "    # Update environment object\n",
     "    Env.selectEnsembleMember(setting[\"ensembleMember\"])\n",
-    "    Env.railLength = setting[\"railLength\"]\n",
     "\n",
     "    # Create motor\n",
     "    Keron = SolidMotor(\n",
@@ -508,6 +507,7 @@
     "        TestFlight = Flight(\n",
     "            rocket=Valetudo,\n",
     "            environment=Env,\n",
+    "            railLength=setting[\"railLength\"],\n",
     "            inclination=setting[\"inclination\"],\n",
     "            heading=setting[\"heading\"],\n",
     "            maxTime=600,\n",

docs/notebooks/dispersion_analysis/parachute_drop_from_helicopter.ipynb

@@ -406,7 +406,7 @@
     "\n",
     "# Define basic Environment object\n",
     "Env = Environment(\n",
-    "    railLength=5.7, date=(2019, 8, 10, 21), latitude=-23.363611, longitude=-48.011389\n",
+    "    date=(2019, 8, 10, 21), latitude=-23.363611, longitude=-48.011389\n",
     ")\n",
     "Env.setElevation(668)\n",
     "Env.maxExpectedHeight = 1500\n",
@@ -432,7 +432,6 @@
     "\n",
     "    # Update environment object\n",
     "    Env.selectEnsembleMember(setting[\"ensembleMember\"])\n",
-    "    Env.railLength = setting[\"railLength\"]\n",
     "\n",
     "    # Create motor\n",
     "    Keron = SolidMotor(\n",
@@ -501,6 +500,7 @@
     "        TestFlight = Flight(\n",
     "            rocket=Valetudo,\n",
     "            environment=Env,\n",
+    "            railLength=setting[\"railLength\"],\n",
     "            inclination=setting[\"inclination\"],\n",
     "            heading=setting[\"heading\"],\n",
     "            maxTime=600,\n",

docs/notebooks/environment_analysis_EuroC_example.ipynb

@@ -64512,7 +64512,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.10.9"
+      "version": "3.10.5"
     },
     "vscode": {
       "interpreter": {

docs/notebooks/environment_analysis_class_usage.ipynb

@@ -28296,7 +28296,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.10.5"
   },
   "vscode": {
    "interpreter": {