Skip to content

Rename of files to remove references to API levels #984

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.

Sign up for GitHub

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

Open
jkirk5 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Rename of files to remove references to API levels #984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c2b5a5b
AviaryProblem
jkirk5 Feb 6, 2026
c7f8e5a
numpy<2.4
jkirk5 Feb 6, 2026
233b503
renamed examples
jkirk5 Feb 6, 2026
588ce6c
Merge branch 'main' into cleanup
jkirk5 Feb 6, 2026
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
6 changes: 3 additions & 3 deletions aviary/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@
from aviary.models.missions.height_energy_default import (
phase_info as default_height_energy_phase_info,
)
from aviary.interface.methods_for_level1 import run_level_1
from aviary.interface.methods_for_level1 import run_aviary
from aviary.interface.methods_for_level2 import AviaryProblem, reload_aviary_problem
from aviary.interface.run_aviary import run_level_1
from aviary.interface.run_aviary import run_aviary
from aviary.core.aviary_problem import AviaryProblem, reload_aviary_problem
from aviary.utils.engine_deck_conversion import convert_engine_deck
from aviary.utils.fortran_to_aviary import fortran_to_aviary
from aviary.utils.functions import (
Expand Down
0 aviary/interface/methods_for_level2.py → aviary/core/aviary_problem.py
View file
Open in desktop
File renamed without changes.
1 change: 1 addition & 0 deletions aviary/docs/examples/coupled_aircraft_mission_optimization.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,7 @@
"source": [
"# Testing Cell\n",
"from aviary.interface.methods_for_level1 import run_aviary\n",
"\n",
"from aviary.utils.doctape import glue_variable\n",
"\n",
"glue_variable(run_aviary.__name__, md_code=True)"
Expand Down
6 changes: 1 addition & 5 deletions aviary/docs/examples/multi_mission.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,7 @@
"# Testing Cell\n",
"from aviary.api import Aircraft, AviaryProblem, Mission\n",
"from aviary.examples.multi_mission import run_multimission_example\n",
"from aviary.utils.doctape import (\n",
" get_variable_name,\n",
" glue_variable,\n",
" glue_class_functions,\n",
")\n",
"from aviary.utils.doctape import get_variable_name, glue_class_functions, glue_variable\n",
"\n",
"current_glued_vars = []\n",
"\n",
Expand Down
6 changes: 3 additions & 3 deletions aviary/docs/getting_started/input_csv_phase_info.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,17 +134,17 @@
"\n",
"import openmdao.api as om\n",
"\n",
"from aviary.models.missions.height_energy_default import phase_info as HE_phase_info\n",
"from aviary.models.missions.two_dof_default import phase_info as TwoDOF_phase_info\n",
"from aviary.mission.flight_phase_builder import FlightPhaseOptions\n",
"from aviary.mission.height_energy.phases.groundroll_phase import GroundrollPhaseOptions as FGopt\n",
"from aviary.mission.solved_two_dof.phases.solved_twodof_phase import SolvedTwoDOFPhaseOptions\n",
"from aviary.mission.two_dof.phases.accel_phase import AccelPhaseOptions\n",
"from aviary.mission.two_dof.phases.ascent_phase import AscentPhaseOptions\n",
"from aviary.mission.two_dof.phases.cruise_phase import CruisePhaseOptions\n",
"from aviary.mission.two_dof.phases.flight_phase import FlightPhaseOptions\n",
"from aviary.mission.two_dof.phases.groundroll_phase import GroundrollPhaseOptions as GGopt\n",
"from aviary.mission.two_dof.phases.rotation_phase import RotationPhaseOptions\n",
"from aviary.mission.solved_two_dof.phases.solved_twodof_phase import SolvedTwoDOFPhaseOptions\n",
"from aviary.models.missions.height_energy_default import phase_info as HE_phase_info\n",
"from aviary.models.missions.two_dof_default import phase_info as TwoDOF_phase_info\n",
"from aviary.utils.doctape import glue_keys\n",
"\n",
"solved_alpha = deepcopy(HE_phase_info['cruise'])\n",
Expand Down
7 changes: 4 additions & 3 deletions aviary/docs/getting_started/onboarding_ext_subsystem.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"source": [
"# Testing Cell\n",
"from aviary.interface.methods_for_level2 import AviaryGroup\n",
"\n",
"from aviary.utils.doctape import glue_class_options\n",
"\n",
"current_glued_vars = []\n",
Expand Down Expand Up @@ -231,6 +232,7 @@
"import inspect\n",
"\n",
"from aviary.interface.methods_for_level2 import AviaryProblem\n",
"\n",
"from aviary.utils.doctape import check_contains, glue_function_arguments\n",
"\n",
"imported_functions = {k for k, v in inspect.getmembers(AviaryProblem, inspect.isfunction)}\n",
Expand Down Expand Up @@ -266,6 +268,7 @@
"source": [
"# Testing Cell\n",
"from aviary.interface.methods_for_level2 import AviaryProblem\n",
"\n",
"from aviary.models.missions.height_energy_default import phase_info\n",
"from aviary.utils.doctape import glue_class_functions, glue_variable\n",
"\n",
Expand Down Expand Up @@ -687,9 +690,7 @@
"outputs": [],
"source": [
"# Testing Cell\n",
"from aviary.examples.external_subsystems.OAS_mass.OAS_wing_mass_builder import (\n",
" OASWingMassBuilder,\n",
")\n",
"from aviary.examples.external_subsystems.OAS_mass.OAS_wing_mass_builder import OASWingMassBuilder\n",
"from aviary.utils.doctape import glue_variable\n",
"\n",
"glue_variable(OASWingMassBuilder.__name__, md_code=True)"
Expand Down
10 changes: 6 additions & 4 deletions aviary/docs/getting_started/onboarding_level1.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"source": [
"# Testing Cell\n",
"from aviary.interface.methods_for_level2 import AviaryGroup\n",
"\n",
"from aviary.utils.doctape import glue_class_options\n",
"\n",
"current_glued_vars = []\n",
Expand Down Expand Up @@ -60,8 +61,9 @@
"# Testing Cell\n",
"import inspect\n",
"\n",
"import aviary.api as av\n",
"from aviary.interface.methods_for_level1 import run_level_1\n",
"\n",
"import aviary.api as av\n",
"from aviary.utils.doctape import check_value, glue_variable\n",
"from aviary.utils.functions import get_model, get_path\n",
"\n",
Expand Down Expand Up @@ -772,10 +774,8 @@
"source": [
"# Testing Cell\n",
"import aviary.api as av\n",
"\n",
"from aviary.variable_info.enums import EquationsOfMotion\n",
"from aviary.utils.doctape import check_value, get_all_keys, get_variable_name\n",
"\n",
"from aviary.variable_info.enums import EquationsOfMotion\n",
"\n",
"TWO_DEGREES_OF_FREEDOM = EquationsOfMotion.TWO_DEGREES_OF_FREEDOM\n",
"HEIGHT_ENERGY = EquationsOfMotion.HEIGHT_ENERGY\n",
Expand Down Expand Up @@ -880,6 +880,7 @@
"source": [
"# Testing cell\n",
"from aviary.interface.methods_for_level2 import AviaryProblem\n",
"\n",
"from aviary.utils.doctape import glue_class_functions\n",
"\n",
"# Get all functions of class AviaryProblem\n",
Expand Down Expand Up @@ -1003,6 +1004,7 @@
"source": [
"# Testing Cell\n",
"from aviary.interface.methods_for_level2 import AviaryProblem\n",
"\n",
"from aviary.utils.doctape import glue_function_arguments\n",
"\n",
"# retrieve all argument of build_pre_mission(self, aviary_inputs, **kwargs)\n",
Expand Down
14 changes: 8 additions & 6 deletions aviary/docs/getting_started/onboarding_level2.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,18 @@
"outputs": [],
"source": [
"# Testing Cell\n",
"import aviary.api as av\n",
"from aviary.api import Dynamic, Mission\n",
"from aviary.interface.methods_for_level1 import run_aviary\n",
"from aviary.interface.methods_for_level2 import AviaryProblem\n",
"\n",
"import aviary.api as av\n",
"from aviary.api import Dynamic, Mission\n",
"from aviary.core.aviary_group import AviaryGroup\n",
"from aviary.utils.doctape import (\n",
" get_variable_name,\n",
" glue_class_functions,\n",
" glue_function_arguments,\n",
" glue_keys,\n",
" glue_variable,\n",
" glue_class_functions,\n",
")\n",
"\n",
"current_glued_vars = []\n",
Expand Down Expand Up @@ -146,9 +147,9 @@
"source": [
"# Testing Cell\n",
"import openmdao.api as om\n",
"from aviary.interface.methods_for_level2 import AviaryProblem\n",
"\n",
"from aviary.api import Mission\n",
"from aviary.interface.methods_for_level2 import AviaryProblem\n",
"from aviary.mission.two_dof_problem_configurator import TwoDOFProblemConfigurator\n",
"from aviary.utils.doctape import check_contains, glue_class_functions, glue_variable\n",
"from aviary.variable_info.enums import EquationsOfMotion as EOM\n",
Expand Down Expand Up @@ -330,8 +331,9 @@
"# Testing Cell\n",
"import inspect\n",
"\n",
"import aviary.api as av\n",
"from aviary.interface.methods_for_level2 import AviaryProblem\n",
"\n",
"import aviary.api as av\n",
"from aviary.utils.doctape import get_attribute_name, glue_variable\n",
"\n",
"# read source code of __init__() starting from line 'self.model = AviaryGroup()'\n",
Expand Down Expand Up @@ -380,7 +382,6 @@
"source": [
"# Testing Cell\n",
"from aviary.utils.doctape import check_value, glue_variable\n",
"\n",
"from aviary.utils.functions import get_model\n",
"\n",
"filename = 'aircraft_for_bench_GwGm.csv'\n",
Expand Down Expand Up @@ -682,6 +683,7 @@
"source": [
"# Testing Cell\n",
"from aviary.interface.methods_for_level2 import AviaryProblem\n",
"\n",
"from aviary.models.missions.two_dof_default import phase_info\n",
"\n",
"prob = AviaryProblem()\n",
Expand Down
3 changes: 2 additions & 1 deletion aviary/docs/getting_started/onboarding_level3.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@
"outputs": [],
"source": [
"# Testing Cell\n",
"import aviary.api as av\n",
"from aviary.interface.methods_for_level2 import AviaryProblem\n",
"\n",
"import aviary.api as av\n",
"from aviary.utils.doctape import glue_class_functions, glue_variable\n",
"\n",
"current_glued_vars = []\n",
Expand Down
3 changes: 2 additions & 1 deletion aviary/docs/misc_resources/modeling_exercise.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,8 @@
"source": [
"# Testing Cell\n",
"from aviary.interface.methods_for_level2 import AviaryGroup\n",
"from aviary.utils.doctape import glue_variable, glue_class_options\n",
"\n",
"from aviary.utils.doctape import glue_class_options, glue_variable\n",
"\n",
"current_glued_vars = []\n",
"glue_class_options(AviaryGroup, current_glued_vars, md_code=True)"
Expand Down
68 changes: 34 additions & 34 deletions aviary/docs/theory_guide/gasp_based_bwb.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,19 @@
"# Testing Cell\n",
"\n",
"from aviary.api import Aircraft\n",
"from aviary.utils.doctape import get_variable_name, glue_variable\n",
"from aviary.subsystems.geometry.gasp_based.engine import (\n",
" BWBEngineSizeGroup,\n",
" EngineSize,\n",
" PercentNotInFuselage,\n",
")\n",
"from aviary.subsystems.geometry.gasp_based.fuselage import (\n",
" BWBFuselageParameters1,\n",
" BWBCabinLayout,\n",
" BWBFuselageParameters2,\n",
" BWBFuselageSize,\n",
" BWBFuselageGroup,\n",
" BWBFuselageParameters1,\n",
" BWBFuselageParameters2,\n",
" BWBFuselageSize,\n",
")\n",
"from aviary.subsystems.geometry.gasp_based.engine import (\n",
" EngineSize,\n",
" BWBEngineSizeGroup,\n",
" PercentNotInFuselage,\n",
")\n",
"from aviary.utils.doctape import get_variable_name, glue_variable\n",
"\n",
"glue_variable(get_variable_name(BWBFuselageParameters1), md_code=True)\n",
"glue_variable(get_variable_name(BWBCabinLayout), md_code=True)\n",
Expand Down Expand Up @@ -77,15 +76,15 @@
"# Testing Cell\n",
"\n",
"from aviary.api import Aircraft, Mission\n",
"from aviary.utils.doctape import get_variable_name, glue_variable\n",
"from aviary.subsystems.geometry.gasp_based.wing import ExposedWing\n",
"from aviary.subsystems.mass.gasp_based.design_load import (\n",
" BWBLoadSpeeds,\n",
" BWBDesignLoadGroup,\n",
" BWBLoadFactors,\n",
" LoadSpeeds,\n",
" BWBLoadSpeeds,\n",
" LoadFactors,\n",
" BWBDesignLoadGroup,\n",
" LoadSpeeds,\n",
")\n",
"from aviary.subsystems.geometry.gasp_based.wing import ExposedWing\n",
"from aviary.utils.doctape import get_variable_name, glue_variable\n",
"\n",
"glue_variable(get_variable_name(Aircraft.Design.WING_LOADING), md_code=True)\n",
"glue_variable(get_variable_name(Mission.Design.GROSS_MASS), md_code=True)\n",
Expand Down Expand Up @@ -124,14 +123,14 @@
"# Testing Cell\n",
"\n",
"from aviary.api import Aircraft\n",
"from aviary.utils.doctape import get_variable_name, glue_variable\n",
"from aviary.subsystems.mass.gasp_based.equipment_and_useful_load import (\n",
" BWBACMass,\n",
" BWBFurnishingMass,\n",
" EquipAndUsefulLoadMassGroup,\n",
" EquipMassPartialSum,\n",
" UsefulLoadMass,\n",
" BWBACMass,\n",
" BWBFurnishingMass,\n",
")\n",
"from aviary.utils.doctape import get_variable_name, glue_variable\n",
"\n",
"glue_variable(get_variable_name(EquipAndUsefulLoadMassGroup), md_code=True)\n",
"glue_variable(get_variable_name(EquipMassPartialSum), md_code=True)\n",
Expand Down Expand Up @@ -176,22 +175,22 @@
"# Testing Cell\n",
"\n",
"from aviary.api import Aircraft\n",
"from aviary.utils.doctape import get_variable_name, glue_variable\n",
"from aviary.subsystems.mass.gasp_based.wing import (\n",
" WingMassSolve,\n",
" BWBWingMassSolve,\n",
" BWBWingMassGroup,\n",
" WingMassTotal,\n",
")\n",
"from aviary.subsystems.geometry.gasp_based.wing import (\n",
" WingFoldArea,\n",
" WingFoldVolume,\n",
" BWBWingFoldVolume,\n",
" BWBWingGroup,\n",
" BWBWingVolume,\n",
" WingFoldArea,\n",
" WingFoldVolume,\n",
" WingParameters,\n",
" WingVolume,\n",
")\n",
"from aviary.subsystems.mass.gasp_based.wing import (\n",
" BWBWingMassGroup,\n",
" BWBWingMassSolve,\n",
" WingMassSolve,\n",
" WingMassTotal,\n",
")\n",
"from aviary.utils.doctape import get_variable_name, glue_variable\n",
"\n",
"glue_variable(get_variable_name(WingMassSolve), md_code=True)\n",
"glue_variable(get_variable_name(BWBWingMassSolve), md_code=True)\n",
Expand Down Expand Up @@ -239,14 +238,14 @@
"# Testing Cell\n",
"\n",
"from aviary.api import Aircraft, Mission\n",
"from aviary.utils.doctape import get_variable_name, glue_variable\n",
"from aviary.subsystems.mass.gasp_based.fuel import (\n",
" BodyTankCalculations,\n",
" BWBFuselageMass,\n",
" FuelMassGroup,\n",
" FuselageMass,\n",
" StructMass,\n",
" BodyTankCalculations,\n",
" FuelMassGroup,\n",
")\n",
"from aviary.utils.doctape import get_variable_name, glue_variable\n",
"\n",
"glue_variable(get_variable_name(BWBFuselageMass), md_code=True)\n",
"glue_variable(get_variable_name(FuselageMass), md_code=True)\n",
Expand Down Expand Up @@ -319,19 +318,20 @@
"source": [
"# Testing Cell\n",
"\n",
"from aviary.utils.doctape import get_all_non_aviary_names, get_variable_name, glue_variable\n",
"from aviary.subsystems.aerodynamics.gasp_based.common import AeroForces\n",
"from aviary.subsystems.aerodynamics.gasp_based.gaspaero import (\n",
" AeroGeom,\n",
" BWBAeroSetup,\n",
" BWBBodyLiftCurveSlope,\n",
" BWBFormFactorAndSIWB,\n",
" BWBAeroSetup,\n",
" BWBLiftCoeff,\n",
" BWBLiftCoeffClean,\n",
" AeroGeom,\n",
" CruiseAero,\n",
" LowSpeedAero,\n",
" Xlifts,\n",
")\n",
"from aviary.subsystems.aerodynamics.gasp_based.common import AeroForces\n",
"from aviary.subsystems.aerodynamics.gasp_based.gaspaero import CruiseAero, LowSpeedAero\n",
"from aviary.subsystems.aerodynamics.gasp_based.table_based import TabularCruiseAero\n",
"from aviary.utils.doctape import get_all_non_aviary_names, get_variable_name, glue_variable\n",
"\n",
"glue_variable(get_variable_name(BWBBodyLiftCurveSlope), md_code=True)\n",
"glue_variable(get_variable_name(BWBFormFactorAndSIWB), md_code=True)\n",
Expand Down
1 change: 1 addition & 0 deletions aviary/docs/user_guide/aerodynamics.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
"source": [
"# Testing Cell\n",
"from aviary.interface.methods_for_level1 import run_aviary\n",
"\n",
"from aviary.utils.doctape import glue_class_functions\n",
"\n",
"# Get all functions of class CoreAerodynamicsBuilder\n",
Expand Down
6 changes: 3 additions & 3 deletions aviary/docs/user_guide/atmosphere.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@
"outputs": [],
"source": [
"# Testing Cell\n",
"import openmdao.api as om\n",
"\n",
"from aviary.subsystems.atmosphere.atmosphere import AtmosphereComp\n",
"from aviary.subsystems.atmosphere.data.StandardAtm1976 import atm_data\n",
"from aviary.subsystems.atmosphere.data.MIL_SPEC_210A_Cold import atm_data\n",
"from aviary.subsystems.atmosphere.data.MIL_SPEC_210A_Hot import atm_data\n",
"from aviary.subsystems.atmosphere.data.MIL_SPEC_210A_Polar import atm_data\n",
"from aviary.subsystems.atmosphere.data.MIL_SPEC_210A_Tropical import atm_data\n",
"import openmdao.api as om\n",
"\n",
"from aviary.subsystems.atmosphere.data.StandardAtm1976 import atm_data\n",
"from aviary.subsystems.atmosphere.utils import build_akima_coefs"
]
},
Expand Down
3 changes: 2 additions & 1 deletion aviary/docs/user_guide/aviary_commands.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,9 @@
"# Testing Cell\n",
"import inspect\n",
"\n",
"import aviary.api as av\n",
"from aviary.interface.methods_for_level1 import run_level_1\n",
"\n",
"import aviary.api as av\n",
"from aviary.utils.doctape import glue_actions, glue_variable\n",
"from aviary.variable_info.variables import Settings\n",
"\n",
Expand Down
Loading
Loading