From 62ba0060c1a083525f54cb2f730d9f544036d76b Mon Sep 17 00:00:00 2001 From: "arjxn.py" Date: Wed, 24 Apr 2024 05:24:49 +0530 Subject: [PATCH 1/4] Add recursive `__all__` dict with every submodule currently --- pybamm/__init__.py | 331 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 331 insertions(+) diff --git a/pybamm/__init__.py b/pybamm/__init__.py index 10088e5800..24af0671cf 100644 --- a/pybamm/__init__.py +++ b/pybamm/__init__.py @@ -195,3 +195,334 @@ # Remove any imported modules, so we don't expose them as part of pybamm del sys + +__all__ = ['AbsoluteValue', 'Addition', 'Ai2020', 'AlgebraicSolver', + 'AlternativeEffectiveResistance2D', 'Arcsinh', 'Arctan', 'Array', + 'AsymmetricButlerVolmer', 'BackwardIndefiniteIntegral', + 'BaseBatteryModel', 'BaseEffectiveResistance', 'BaseElectrode', + 'BaseElectrolyteConductivity', 'BaseElectrolyteDiffusion', + 'BaseIndefiniteIntegral', 'BaseInterface', 'BaseKinetics', + 'BaseLeadingOrderSurfaceForm', 'BaseMechanics', 'BaseModel', + 'BaseOpenCircuitPotential', 'BaseParameters', 'BaseParticle', + 'BasePlating', 'BasePotentialPair', 'BaseSolver', 'BaseStep', + 'BaseStepExplicit', 'BaseStepImplicit', 'BaseSubModel', + 'BaseTermination', 'BaseThermal', 'BaseThroughCellModel', + 'BaseTransverseModel', 'BasicDFN', 'BasicDFNComposite', + 'BasicDFNHalfCell', 'BasicFull', 'BasicSPM', 'BatchStudy', + 'BatteryModelDomainOptions', 'BatteryModelOptions', + 'BatteryModelPhaseOptions', 'BinaryOperator', + 'BoundaryConditionsDict', 'BoundaryGradient', 'BoundaryIntegral', + 'BoundaryMass', 'BoundaryOperator', 'BoundaryValue', 'Broadcast', + 'Bruggeman', 'CCCVFunctionControl', 'CRate', 'Callback', + 'CallbackList', 'CasadiAlgebraicSolver', 'CasadiConverter', + 'CasadiSolver', 'Ceiling', 'Chebyshev1DSubMesh', 'Chen2020', + 'Chen2020_composite', 'Citations', 'Composite', + 'CompositeAlgebraic', 'CompositeDifferential', 'Concatenation', + 'ConcatenationVariable', 'Constant', 'ConstantConcentration', + 'ConstantSEI', 'Cos', 'Cosh', 'CrackPropagation', + 'CrateTermination', 'Current', 'CurrentCollector1D', + 'CurrentCollector2D', 'CurrentDriven', + 'CurrentForInverseButlerVolmer', + 'CurrentForInverseButlerVolmerLithiumMetal', + 'CurrentSigmoidOpenCircuitPotential', 'CurrentTermination', + 'CustomPrint', 'CustomStepExplicit', 'CustomStepImplicit', + 'CustomTermination', 'DFN', 'DOMAIN_LEVELS', + 'DefiniteIntegralVector', 'DeltaFunction', 'DiffusionLimited', + 'Discretisation', 'DiscretisationError', 'Divergence', 'Division', + 'Domain', 'DomainConcatenation', 'DomainError', + 'DomainGeometricParameters', 'DomainLeadAcidParameters', + 'DomainLithiumIonParameters', 'DomainThermalParameters', 'Downwind', + 'DummySolver', 'E', 'Ecker2015', 'Ecker2015_graphite_halfcell', + 'EcmParameters', 'EffectiveResistance', 'ElectricalParameters', + 'ElectrodeSOHHalfCell', 'ElectrodeSOHSolver', 'EmptySolution', + 'EqualHeaviside', 'Equality', 'EquationDict', 'Erf', 'EvaluateAt', + 'EvaluatorJax', 'EvaluatorJaxJacobian', 'EvaluatorJaxSensitivities', + 'EvaluatorPython', 'Event', 'EventType', 'Exp', 'Experiment', + 'Explicit', 'ExplicitCurrentControl', 'ExplicitPowerControl', + 'ExplicitResistanceControl', 'ExplicitTimeIntegral', + 'Exponential1DSubMesh', 'F', 'FORMAT', 'FickianDiffusion', + 'FiniteVolume', 'Floor', 'ForwardTafel', 'Full', 'FullAlgebraic', + 'FullBroadcast', 'FullBroadcastToEdges', 'FullDifferential', + 'Function', 'FunctionControl', 'FunctionParameter', 'FuzzyDict', + 'GREEK_LETTERS', 'GeometricParameters', 'Geometry', 'GeometryError', + 'Gradient', 'GradientSquared', 'IDAKLUJax', 'IDAKLUSolver', + 'IndefiniteIntegral', 'IndependentVariable', 'Index', 'Inner', + 'InputParameter', 'Integral', 'Integrated', 'Interpolant', + 'InverseButlerVolmer', 'Isothermal', 'JAXLIB_VERSION', + 'JAX_VERSION', 'Jacobian', 'JaxCooMatrix', 'JaxSolver', + 'KNOWN_COORD_SYS', + 'LFP_electrolyte_exchange_current_density_kashkooli2017', + 'LFP_ocp_Afshar2017', 'LOG_FORMATTER', 'LOQS', 'LRUDict', + 'Laplacian', 'Latexify', 'LeadAcidParameters', 'LeadingOrder', + 'LeadingOrderAlgebraic', 'LeadingOrderDifferential', 'Linear', + 'LithiumIonParameters', 'LithiumMetalBaseModel', + 'LithiumMetalExplicit', 'LithiumMetalSurfaceForm', 'Log', + 'LoggingCallback', 'LoopList', 'LossActiveMaterial', 'Lumped', + 'MPM', 'MSMR', 'MSMRButlerVolmer', 'MSMRDiffusion', + 'MSMROpenCircuitPotential', 'MSMR_example_set', 'Marcus', + 'MarcusHushChidsey', 'Marquis2019', 'Mass', 'Matrix', + 'MatrixMultiplication', 'Max', 'Maximum', 'Mesh', 'MeshGenerator', + 'Min', 'Minimum', 'ModelError', 'ModelWarning', 'Modulo', + 'Mohtat2020', 'Multiplication', 'NCA_Kim2011', + 'NMC_diffusivity_PeymanMPM', + 'NMC_electrolyte_exchange_current_density_PeymanMPM', + 'NMC_entropic_change_PeymanMPM', 'NMC_ocp_PeymanMPM', + 'NaturalNumberOption', 'Negate', 'NewmanTobias', 'NoConvection', + 'NoMechanics', 'NoOxygen', 'NoPlating', 'NoReaction', 'NoSEI', + 'NotConstant', 'NotEqualHeaviside', 'NullParameters', + 'NumpyConcatenation', 'NumpyEncoder', 'OCVElement', 'OKane2022', + 'OKane2022_graphite_SiOx_halfcell', 'ORegan2022', 'OneDimensionalX', + 'OperatingModes', 'OptionError', 'OptionWarning', 'PHASE_NAMES', + 'PRINT_NAME_OVERRIDES', 'Parameter', 'ParameterSets', + 'ParameterValues', 'ParticleGeometricParameters', + 'ParticleLithiumIonParameters', 'PhaseLeadAcidParameters', + 'Plating', 'PolynomialProfile', 'PotentialPair1plus1D', + 'PotentialPair2plus1D', 'Power', 'PowerFunctionControl', + 'Prada2013', 'PrimaryBroadcast', 'PrimaryBroadcastToEdges', + 'ProcessedVariable', 'ProcessedVariableComputed', 'QuickPlot', + 'QuickPlotAxes', 'R', 'RAverage', 'RCElement', 'R_n', 'R_n_edge', + 'R_p', 'R_p_edge', 'Ramadass2004', 'ReactionDriven', + 'ReactionDrivenODE', 'Resistance', 'ResistanceFunctionControl', + 'ResistorElement', 'SEIGrowth', + 'SEI_limited_dead_lithium_OKane2022', 'SF', 'SPM', 'SPMe', 'Scalar', + 'ScikitChebyshev2DSubMesh', 'ScikitExponential2DSubMesh', + 'ScikitFiniteElement', 'ScikitSubMesh2D', 'ScikitUniform2DSubMesh', + 'ScipySolver', 'SecondaryBroadcast', 'SecondaryBroadcastToEdges', + 'Serialise', 'Settings', 'ShapeError', 'Sign', 'Simulation', 'Sin', + 'SingleOpenCircuitPotential', 'Sinh', 'SizeAverage', 'Solution', + 'SolverError', 'SolverWarning', 'SparseStack', 'SpatialMethod', + 'SpatialOperator', 'SpatialVariable', 'SpatialVariableEdge', + 'SpecificFunction', 'SpectralVolume', 'SpectralVolume1DSubMesh', + 'Sqrt', 'StateVector', 'StateVectorBase', 'StateVectorDot', + 'SubMesh', 'SubMesh0D', 'SubMesh1D', 'Subtraction', 'Sulzer2019', + 'SurfaceForm', 'SwellingOnly', 'Symbol', 'SymbolUnpacker', + 'SymmetricButlerVolmer', 'Tanh', 'TertiaryBroadcast', + 'TertiaryBroadcastToEdges', 'ThermalParameters', 'ThermalSubModel', + 'Thevenin', 'Time', 'Timer', 'TimerTime', 'Total', + 'TotalConcentration', 'TotalInterfacialCurrent', + 'TotalMainKinetics', 'TotalSEI', 'UnaryOperator', 'Uniform', + 'Uniform1DSubMesh', 'Upwind', 'UpwindDownwind', + 'UserSupplied1DSubMesh', 'UserSupplied2DSubMesh', 'Variable', + 'VariableBase', 'VariableDot', 'Vector', 'Voltage', + 'VoltageFunctionControl', 'VoltageModel', 'VoltageTermination', + 'XAverage', 'XAveragedPolynomialProfile', 'Xu2019', 'YZAverage', + 'Yang2017', 'ZAverage', 'ZeroDimensionalSpatialMethod', + 'active_material', 'add', 'algebraic_solver', + 'aluminium_heat_capacity_CRC', 'arcsinh', 'arctan', 'array', + 'averages', 'ax_max', 'ax_min', 'base_active_material', + 'base_battery_model', 'base_convection', 'base_current_collector', + 'base_electrode', 'base_electrolyte_conductivity', + 'base_electrolyte_diffusion', 'base_external_circuit', + 'base_interface', 'base_kinetics', 'base_lead_acid_model', + 'base_lithium_ion_model', 'base_mechanics', 'base_model', + 'base_ocp', 'base_ohm', 'base_oxygen_diffusion', 'base_parameters', + 'base_particle', 'base_plating', 'base_porosity', 'base_sei', + 'base_solver', 'base_step', 'base_submodel', 'base_thermal', + 'base_through_cell_convection', 'base_transport_efficiency', + 'base_transverse_convection', 'base_utilisation', 'basic_dfn', + 'basic_dfn_composite', 'basic_dfn_half_cell', 'basic_full', + 'basic_spm', 'batch_study', 'battery_geometry', 'binary_operators', + 'boundary_gradient', 'boundary_value', 'bpx', 'broadcasts', + 'bruggeman_transport_efficiency', 'butler_volmer', 'c1', 'c1_data', + 'c_rate', 'c_solvers', 'calculate_theoretical_energy', + 'callback_loop_decorator', 'callbacks', 'casadi_algebraic_solver', + 'casadi_solver', 'cell', 'citations', 'close_plots', + 'composite_conductivity', 'composite_ohm', + 'composite_surface_form_conductivity', 'concatenation', + 'concatenations', 'conductivity_Gu1997', 'constant_active_material', + 'constant_concentration', 'constant_porosity', 'constant_sei', + 'constant_utilisation', 'constants', 'convection', + 'convert_to_casadi', 'copper_heat_capacity_CRC', + 'copper_thermal_conductivity_CRC', 'copy_parameter_doc_from_parent', + 'cos', 'cosh', 'crack_propagation', 'cracking_rate_Ai2020', + 'create_jax_coo_matrix', 'create_object_of_size', 'current', + 'current_collector', 'current_driven_utilisation', + 'current_sigmoid_ocp', 'custom_print_func', 'dUdT', 'dUdT_data', + 'darken_thermodynamic_factor_Chapman1968', 'dfn', + 'diffusion_limited', 'diffusivity_Gu1997', 'discretisation', + 'discretisations', 'div', 'divide', 'dlnf_dlnc_Ai2020', + 'doc_extend_parent', 'doc_utils', 'domain_concatenation', + 'domain_size', 'downwind', 'dummy_solver', 'dynamic_plot', 'ecm', + 'ecm_model_options', 'ecm_parameters', + 'effective_resistance_current_collector', 'electrical_parameters', + 'electrode', 'electrode_soh', 'electrode_soh_half_cell', + 'electrolyte', 'electrolyte_TDF_EC_EMC_3_7_Landesfeind2019', + 'electrolyte_TDF_base_Landesfeind2019', 'electrolyte_conductivity', + 'electrolyte_conductivity_Ai2020', + 'electrolyte_conductivity_Capiglia1999', + 'electrolyte_conductivity_EC_EMC_3_7_Landesfeind2019', + 'electrolyte_conductivity_Ecker2015', + 'electrolyte_conductivity_Kim2011', + 'electrolyte_conductivity_Nyman2008', + 'electrolyte_conductivity_Nyman2008_arrhenius', + 'electrolyte_conductivity_PeymanMPM', + 'electrolyte_conductivity_Prada2013', + 'electrolyte_conductivity_Ramadass2004', + 'electrolyte_conductivity_Valoen2005', + 'electrolyte_conductivity_base_Landesfeind2019', + 'electrolyte_diffusion', 'electrolyte_diffusivity_Ai2020', + 'electrolyte_diffusivity_Capiglia1999', + 'electrolyte_diffusivity_EC_EMC_3_7_Landesfeind2019', + 'electrolyte_diffusivity_Ecker2015', + 'electrolyte_diffusivity_Kim2011', + 'electrolyte_diffusivity_Nyman2008', + 'electrolyte_diffusivity_Nyman2008_arrhenius', + 'electrolyte_diffusivity_PeymanMPM', + 'electrolyte_diffusivity_Ramadass2004', + 'electrolyte_diffusivity_Valoen2005', + 'electrolyte_diffusivity_base_Landesfeind2019', + 'electrolyte_transference_number_EC_EMC_3_7_Landesfeind2019', + 'electrolyte_transference_number_base_Landesfeind2019', + 'equivalent_circuit', 'equivalent_circuit_elements', 'erf', 'erfc', + 'evaluate_for_shape_using_domain', 'evaluate_python', 'event', + 'example_set', 'exceptions', 'exp', 'experiment', + 'explicit_control_external_circuit', 'explicit_convection', + 'explicit_surface_form_conductivity', 'expression_tree', + 'external_circuit', 'fickian_diffusion', 'find_symbol_in_dict', + 'find_symbol_in_model', 'find_symbol_in_tree', 'find_symbols', + 'finite_volume', 'full', 'full_battery_models', 'full_conductivity', + 'full_convection', 'full_diffusion', 'full_like', 'full_ohm', + 'full_oxygen_diffusion', 'full_surface_form_conductivity', + 'full_utilisation', 'function_control_external_circuit', + 'functions', 'geometric_parameters', 'geometry', + 'get_git_commit_info', 'get_initial_ocps', + 'get_initial_stoichiometries', + 'get_initial_stoichiometry_half_cell', 'get_log_level_func', + 'get_min_max_ocps', 'get_min_max_stoichiometries', 'get_new_logger', + 'get_parameter_values', 'get_parameters_filepath', + 'get_rng_min_max_name', 'get_size_distribution_parameters', 'grad', + 'grad_squared', 'graphite_LGM50_diffusivity_Chen2020', + 'graphite_LGM50_diffusivity_ORegan2022', + 'graphite_LGM50_electrolyte_exchange_current_density_Chen2020', + 'graphite_LGM50_electrolyte_exchange_current_density_ORegan2022', + 'graphite_LGM50_entropic_change_ORegan2022', + 'graphite_LGM50_heat_capacity_ORegan2022', + 'graphite_LGM50_ocp_Chen2020', 'graphite_LGM50_ocp_Chen2020_data', + 'graphite_LGM50_thermal_conductivity_ORegan2022', + 'graphite_cracking_rate_Ai2020', + 'graphite_diffusivity_Dualfoil1998', + 'graphite_diffusivity_Ecker2015', 'graphite_diffusivity_Kim2011', + 'graphite_diffusivity_PeymanMPM', + 'graphite_electrolyte_exchange_current_density_Dualfoil1998', + 'graphite_electrolyte_exchange_current_density_Ecker2015', + 'graphite_electrolyte_exchange_current_density_Kim2011', + 'graphite_electrolyte_exchange_current_density_PeymanMPM', + 'graphite_electrolyte_exchange_current_density_Ramadass2004', + 'graphite_entropic_change_Moura2016', + 'graphite_entropic_change_PeymanMPM', + 'graphite_entropy_Enertech_Ai2020_function', + 'graphite_mcmb2528_diffusivity_Dualfoil1998', + 'graphite_mcmb2528_ocp_Dualfoil1998', 'graphite_ocp_Ecker2015', + 'graphite_ocp_Enertech_Ai2020', 'graphite_ocp_Enertech_Ai2020_data', + 'graphite_ocp_Kim2011', 'graphite_ocp_PeymanMPM', + 'graphite_ocp_Ramadass2004', 'graphite_volume_change_Ai2020', + 'has_bc_of_form', 'have_idaklu', 'have_jax', + 'homogeneous_current_collector', 'id_to_python_variable', + 'idaklu_jax', 'idaklu_solver', 'idaklu_spec', + 'import_optional_dependency', 'independent_variable', 'inner', + 'input', 'input_parameter', 'install_jax', + 'integrated_conductivity', 'interface', 'interface_utilisation', + 'interpolant', 'intersect', 'inverse_butler_volmer', + 'inverse_kinetics', 'is_constant', 'is_constant_and_can_evaluate', + 'is_jax_compatible', 'is_matrix_minus_one', 'is_matrix_one', + 'is_matrix_x', 'is_matrix_zero', 'is_notebook', 'is_scalar', + 'is_scalar_minus_one', 'is_scalar_one', 'is_scalar_x', + 'is_scalar_zero', 'isothermal', 'jacobian', 'jax_bdf_integrate', + 'jax_bdf_solver', 'jax_solver', 'k_b', 'kinetics', 'laplacian', + 'latexify', 'lead_acid', 'lead_acid_parameters', + 'lead_dioxide_exchange_current_density_Sulzer2019', + 'lead_dioxide_ocp_Bode1977', + 'lead_exchange_current_density_Sulzer2019', 'lead_ocp_Bode1977', + 'leading_ohm', 'leading_order_conductivity', + 'leading_order_diffusion', 'leading_oxygen_diffusion', + 'leading_surface_form_conductivity', 'li_metal', + 'li_metal_electrolyte_exchange_current_density_Xu2019', + 'lico2_cracking_rate_Ai2020', 'lico2_diffusivity_Dualfoil1998', + 'lico2_diffusivity_Ramadass2004', + 'lico2_electrolyte_exchange_current_density_Dualfoil1998', + 'lico2_electrolyte_exchange_current_density_Ramadass2004', + 'lico2_entropic_change_Ai2020_function', + 'lico2_entropic_change_Moura2016', 'lico2_ocp_Ai2020', + 'lico2_ocp_Ai2020_data', 'lico2_ocp_Dualfoil1998', + 'lico2_ocp_Ramadass2004', 'lico2_volume_change_Ai2020', 'linear', + 'linspace', 'lithium_ion', 'lithium_ion_parameters', + 'lithium_plating', 'load', 'load_model', 'load_sim', 'log', 'log10', + 'logger', 'lognormal', 'loqs', 'loss_active_material', 'lrudict', + 'lumped', 'make_cycle_solution', 'marcus', 'matmul', 'matrix', + 'maximum', 'meshes', 'meshgrid', 'minimum', 'models', 'mpm', 'msmr', + 'msmr_butler_volmer', 'msmr_diffusion', 'msmr_ocp', 'multiply', + 'nca_diffusivity_Kim2011', + 'nca_electrolyte_exchange_current_density_Kim2011', + 'nca_ocp_Kim2011', 'nco_diffusivity_Ecker2015', + 'nco_electrolyte_exchange_current_density_Ecker2015', + 'nco_ocp_Ecker2015', 'negative_current_collector', + 'negative_electrode', 'negative_particle', 'new_levels', + 'newman_tobias', 'nmc_LGM50_diffusivity_Chen2020', + 'nmc_LGM50_diffusivity_ORegan2022', + 'nmc_LGM50_electrolyte_exchange_current_density_Chen2020', + 'nmc_LGM50_electrolyte_exchange_current_density_ORegan2022', + 'nmc_LGM50_electronic_conductivity_ORegan2022', + 'nmc_LGM50_entropic_change_ORegan2022', + 'nmc_LGM50_heat_capacity_ORegan2022', 'nmc_LGM50_ocp_Chen2020', + 'nmc_LGM50_thermal_conductivity_ORegan2022', + 'nmc_electrolyte_exchange_current_density_Xu2019', 'nmc_ocp_Xu2019', + 'no_convection', 'no_mechanics', 'no_oxygen', 'no_plating', + 'no_reaction', 'no_sei', 'normal_cdf', 'normal_pdf', + 'numpy_concatenation', 'ocv', 'ocv_data', 'ocv_element', 'ohm', + 'one_dimensional_submeshes', 'ones_like', 'open_circuit_potential', + 'operations', 'oxygen_diffusion', + 'oxygen_exchange_current_density_Sulzer2019', 'parameter', + 'parameter_sets', 'parameter_values', 'parameters', 'particle', + 'particle_mechanics', 'plating', + 'plating_exchange_current_density_OKane2020', 'plot', 'plot2D', + 'plot_summary_variables', 'plot_thermal_components', + 'plot_voltage_components', 'plotting', 'polynomial_profile', + 'porosity', 'positive_current_collector', 'positive_electrode', + 'positive_particle', 'potential_pair', 'pouch_cell', + 'pouch_cell_1D_current_collectors', + 'pouch_cell_2D_current_collectors', 'power', 'preamble', + 'prettify_print_name', 'print_citations', 'print_name', 'printing', + 'process', 'process_1D_data', 'process_2D_data', + 'process_2D_data_csv', 'process_3D_data_csv', + 'process_float_function_table', 'process_parameter_data', + 'processed_variable', 'processed_variable_computed', 'q_e', + 'quick_plot', 'r0', 'r0_data', 'r1', 'r1_data', 'r_average', + 'r_macro', 'r_macro_edge', 'r_n', 'r_n_edge', 'r_n_prim', 'r_n_sec', + 'r_p', 'r_p_edge', 'r_p_prim', 'r_p_sec', 'rc_element', + 'reaction_driven_porosity', 'reaction_driven_porosity_ode', + 'represents_positive_integer', 'resistance', 'resistor_element', + 'rest', 'root_dir', 'scalar', 'scikit_fem_submeshes', + 'scikit_finite_element', 'scipy_solver', 'sech', 'sei', + 'sei_growth', 'separator', + 'separator_LGM50_heat_capacity_ORegan2022', 'serialise', + 'set_logging_level', 'settings', 'setup_callbacks', 'sigmoid', + 'sign', + 'silicon_LGM50_electrolyte_exchange_current_density_Chen2020', + 'silicon_ocp_delithiation_Mark2016', + 'silicon_ocp_lithiation_Mark2016', 'simplified_concatenation', + 'simplified_domain_concatenation', 'simplified_function', + 'simplified_numpy_concatenation', 'simplified_power', + 'simplify_if_constant', 'simulation', 'sin', 'single_ocp', 'sinh', + 'size_average', 'size_distribution_parameters', + 'smooth_absolute_value', 'smooth_max', 'smooth_min', 'softminus', + 'softplus', 'solution', 'solvers', 'source', 'spatial_method', + 'spatial_methods', 'spectral_volume', 'split_long_string', 'spm', + 'spme', 'sqrt', 'standard_spatial_vars', 'state_vector', 'step', + 'step_termination', 'steps', 'string', + 'stripping_exchange_current_density_OKane2020', 'submodels', + 'substrings', 'subtract', 'surf', 'surface_form_ohm', + 'surface_potential_form', 'swelling_only', 'symbol', + 'sympy_overrides', 't', 'tafel', 'tanh', + 'theoretical_energy_integral', 'thermal', 'thermal_parameters', + 'thevenin', 'through_cell', 'to_python', 'total_active_material', + 'total_interfacial_current', 'total_main_kinetics', + 'total_particle_concentration', 'total_sei', 'transport_efficiency', + 'transverse', 'type_definitions', 'unary_operators', + 'uniform_convection', 'unpack_symbols', 'upwind', 'util', + 'value_based_charge_or_discharge', 'variable', 'vector', 'version', + 'voltage', 'voltage_model', 'volume_change_Ai2020', 'whole_cell', + 'x', 'x_average', 'x_averaged_polynomial_profile', 'x_edge', + 'x_full', 'x_n', 'x_n_edge', 'x_p', 'x_p_edge', 'x_s', 'x_s_edge', + 'xyz_average', 'y', 'y_edge', 'yz_average', 'z', 'z_average', + 'z_edge', 'zero_dimensional_method', 'zero_dimensional_submesh', + 'zeros_like'] From 4300430660a348fb5d851b118aaf7c878626a7be Mon Sep 17 00:00:00 2001 From: "arjxn.py" Date: Mon, 29 Apr 2024 14:16:11 +0530 Subject: [PATCH 2/4] Adds `__all__` to submodules recursively --- pybamm/__init__.py | 335 +----------------- pybamm/discretisations/__init__.py | 1 + pybamm/experiment/__init__.py | 1 + pybamm/experiment/step/__init__.py | 2 + pybamm/expression_tree/__init__.py | 5 + pybamm/expression_tree/operations/__init__.py | 2 + pybamm/expression_tree/printing/__init__.py | 1 + pybamm/geometry/__init__.py | 1 + pybamm/input/__init__.py | 1 + pybamm/input/parameters/__init__.py | 1 + pybamm/input/parameters/ecm/__init__.py | 1 + pybamm/input/parameters/lead_acid/__init__.py | 1 + .../input/parameters/lithium_ion/__init__.py | 5 + pybamm/meshes/__init__.py | 2 + pybamm/models/__init__.py | 1 + pybamm/models/full_battery_models/__init__.py | 2 + .../equivalent_circuit/__init__.py | 2 + .../full_battery_models/lead_acid/__init__.py | 2 + .../lithium_ion/__init__.py | 5 + pybamm/models/submodels/__init__.py | 5 + .../submodels/active_material/__init__.py | 3 + .../models/submodels/convection/__init__.py | 2 + .../convection/through_cell/__init__.py | 3 + .../convection/transverse/__init__.py | 3 + .../submodels/current_collector/__init__.py | 3 + pybamm/models/submodels/electrode/__init__.py | 2 + .../submodels/electrode/ohm/__init__.py | 3 + .../electrolyte_conductivity/__init__.py | 4 + .../surface_potential_form/__init__.py | 5 + .../electrolyte_diffusion/__init__.py | 3 + .../equivalent_circuit_elements/__init__.py | 3 + .../submodels/external_circuit/__init__.py | 3 + pybamm/models/submodels/interface/__init__.py | 4 + .../interface_utilisation/__init__.py | 3 + .../submodels/interface/kinetics/__init__.py | 4 + .../kinetics/inverse_kinetics/__init__.py | 1 + .../interface/lithium_plating/__init__.py | 2 + .../open_circuit_potential/__init__.py | 2 + .../submodels/interface/sei/__init__.py | 2 + .../submodels/oxygen_diffusion/__init__.py | 3 + pybamm/models/submodels/particle/__init__.py | 4 + .../submodels/particle_mechanics/__init__.py | 3 + pybamm/models/submodels/porosity/__init__.py | 3 + pybamm/models/submodels/thermal/__init__.py | 2 + .../submodels/thermal/pouch_cell/__init__.py | 3 + .../transport_efficiency/__init__.py | 2 + pybamm/parameters/__init__.py | 6 + pybamm/plotting/__init__.py | 2 + pybamm/solvers/__init__.py | 5 + pybamm/solvers/c_solvers/__init__.py | 1 + pybamm/spatial_methods/__init__.py | 2 + 51 files changed, 137 insertions(+), 330 deletions(-) diff --git a/pybamm/__init__.py b/pybamm/__init__.py index 24af0671cf..a6da38904c 100644 --- a/pybamm/__init__.py +++ b/pybamm/__init__.py @@ -196,333 +196,8 @@ # Remove any imported modules, so we don't expose them as part of pybamm del sys -__all__ = ['AbsoluteValue', 'Addition', 'Ai2020', 'AlgebraicSolver', - 'AlternativeEffectiveResistance2D', 'Arcsinh', 'Arctan', 'Array', - 'AsymmetricButlerVolmer', 'BackwardIndefiniteIntegral', - 'BaseBatteryModel', 'BaseEffectiveResistance', 'BaseElectrode', - 'BaseElectrolyteConductivity', 'BaseElectrolyteDiffusion', - 'BaseIndefiniteIntegral', 'BaseInterface', 'BaseKinetics', - 'BaseLeadingOrderSurfaceForm', 'BaseMechanics', 'BaseModel', - 'BaseOpenCircuitPotential', 'BaseParameters', 'BaseParticle', - 'BasePlating', 'BasePotentialPair', 'BaseSolver', 'BaseStep', - 'BaseStepExplicit', 'BaseStepImplicit', 'BaseSubModel', - 'BaseTermination', 'BaseThermal', 'BaseThroughCellModel', - 'BaseTransverseModel', 'BasicDFN', 'BasicDFNComposite', - 'BasicDFNHalfCell', 'BasicFull', 'BasicSPM', 'BatchStudy', - 'BatteryModelDomainOptions', 'BatteryModelOptions', - 'BatteryModelPhaseOptions', 'BinaryOperator', - 'BoundaryConditionsDict', 'BoundaryGradient', 'BoundaryIntegral', - 'BoundaryMass', 'BoundaryOperator', 'BoundaryValue', 'Broadcast', - 'Bruggeman', 'CCCVFunctionControl', 'CRate', 'Callback', - 'CallbackList', 'CasadiAlgebraicSolver', 'CasadiConverter', - 'CasadiSolver', 'Ceiling', 'Chebyshev1DSubMesh', 'Chen2020', - 'Chen2020_composite', 'Citations', 'Composite', - 'CompositeAlgebraic', 'CompositeDifferential', 'Concatenation', - 'ConcatenationVariable', 'Constant', 'ConstantConcentration', - 'ConstantSEI', 'Cos', 'Cosh', 'CrackPropagation', - 'CrateTermination', 'Current', 'CurrentCollector1D', - 'CurrentCollector2D', 'CurrentDriven', - 'CurrentForInverseButlerVolmer', - 'CurrentForInverseButlerVolmerLithiumMetal', - 'CurrentSigmoidOpenCircuitPotential', 'CurrentTermination', - 'CustomPrint', 'CustomStepExplicit', 'CustomStepImplicit', - 'CustomTermination', 'DFN', 'DOMAIN_LEVELS', - 'DefiniteIntegralVector', 'DeltaFunction', 'DiffusionLimited', - 'Discretisation', 'DiscretisationError', 'Divergence', 'Division', - 'Domain', 'DomainConcatenation', 'DomainError', - 'DomainGeometricParameters', 'DomainLeadAcidParameters', - 'DomainLithiumIonParameters', 'DomainThermalParameters', 'Downwind', - 'DummySolver', 'E', 'Ecker2015', 'Ecker2015_graphite_halfcell', - 'EcmParameters', 'EffectiveResistance', 'ElectricalParameters', - 'ElectrodeSOHHalfCell', 'ElectrodeSOHSolver', 'EmptySolution', - 'EqualHeaviside', 'Equality', 'EquationDict', 'Erf', 'EvaluateAt', - 'EvaluatorJax', 'EvaluatorJaxJacobian', 'EvaluatorJaxSensitivities', - 'EvaluatorPython', 'Event', 'EventType', 'Exp', 'Experiment', - 'Explicit', 'ExplicitCurrentControl', 'ExplicitPowerControl', - 'ExplicitResistanceControl', 'ExplicitTimeIntegral', - 'Exponential1DSubMesh', 'F', 'FORMAT', 'FickianDiffusion', - 'FiniteVolume', 'Floor', 'ForwardTafel', 'Full', 'FullAlgebraic', - 'FullBroadcast', 'FullBroadcastToEdges', 'FullDifferential', - 'Function', 'FunctionControl', 'FunctionParameter', 'FuzzyDict', - 'GREEK_LETTERS', 'GeometricParameters', 'Geometry', 'GeometryError', - 'Gradient', 'GradientSquared', 'IDAKLUJax', 'IDAKLUSolver', - 'IndefiniteIntegral', 'IndependentVariable', 'Index', 'Inner', - 'InputParameter', 'Integral', 'Integrated', 'Interpolant', - 'InverseButlerVolmer', 'Isothermal', 'JAXLIB_VERSION', - 'JAX_VERSION', 'Jacobian', 'JaxCooMatrix', 'JaxSolver', - 'KNOWN_COORD_SYS', - 'LFP_electrolyte_exchange_current_density_kashkooli2017', - 'LFP_ocp_Afshar2017', 'LOG_FORMATTER', 'LOQS', 'LRUDict', - 'Laplacian', 'Latexify', 'LeadAcidParameters', 'LeadingOrder', - 'LeadingOrderAlgebraic', 'LeadingOrderDifferential', 'Linear', - 'LithiumIonParameters', 'LithiumMetalBaseModel', - 'LithiumMetalExplicit', 'LithiumMetalSurfaceForm', 'Log', - 'LoggingCallback', 'LoopList', 'LossActiveMaterial', 'Lumped', - 'MPM', 'MSMR', 'MSMRButlerVolmer', 'MSMRDiffusion', - 'MSMROpenCircuitPotential', 'MSMR_example_set', 'Marcus', - 'MarcusHushChidsey', 'Marquis2019', 'Mass', 'Matrix', - 'MatrixMultiplication', 'Max', 'Maximum', 'Mesh', 'MeshGenerator', - 'Min', 'Minimum', 'ModelError', 'ModelWarning', 'Modulo', - 'Mohtat2020', 'Multiplication', 'NCA_Kim2011', - 'NMC_diffusivity_PeymanMPM', - 'NMC_electrolyte_exchange_current_density_PeymanMPM', - 'NMC_entropic_change_PeymanMPM', 'NMC_ocp_PeymanMPM', - 'NaturalNumberOption', 'Negate', 'NewmanTobias', 'NoConvection', - 'NoMechanics', 'NoOxygen', 'NoPlating', 'NoReaction', 'NoSEI', - 'NotConstant', 'NotEqualHeaviside', 'NullParameters', - 'NumpyConcatenation', 'NumpyEncoder', 'OCVElement', 'OKane2022', - 'OKane2022_graphite_SiOx_halfcell', 'ORegan2022', 'OneDimensionalX', - 'OperatingModes', 'OptionError', 'OptionWarning', 'PHASE_NAMES', - 'PRINT_NAME_OVERRIDES', 'Parameter', 'ParameterSets', - 'ParameterValues', 'ParticleGeometricParameters', - 'ParticleLithiumIonParameters', 'PhaseLeadAcidParameters', - 'Plating', 'PolynomialProfile', 'PotentialPair1plus1D', - 'PotentialPair2plus1D', 'Power', 'PowerFunctionControl', - 'Prada2013', 'PrimaryBroadcast', 'PrimaryBroadcastToEdges', - 'ProcessedVariable', 'ProcessedVariableComputed', 'QuickPlot', - 'QuickPlotAxes', 'R', 'RAverage', 'RCElement', 'R_n', 'R_n_edge', - 'R_p', 'R_p_edge', 'Ramadass2004', 'ReactionDriven', - 'ReactionDrivenODE', 'Resistance', 'ResistanceFunctionControl', - 'ResistorElement', 'SEIGrowth', - 'SEI_limited_dead_lithium_OKane2022', 'SF', 'SPM', 'SPMe', 'Scalar', - 'ScikitChebyshev2DSubMesh', 'ScikitExponential2DSubMesh', - 'ScikitFiniteElement', 'ScikitSubMesh2D', 'ScikitUniform2DSubMesh', - 'ScipySolver', 'SecondaryBroadcast', 'SecondaryBroadcastToEdges', - 'Serialise', 'Settings', 'ShapeError', 'Sign', 'Simulation', 'Sin', - 'SingleOpenCircuitPotential', 'Sinh', 'SizeAverage', 'Solution', - 'SolverError', 'SolverWarning', 'SparseStack', 'SpatialMethod', - 'SpatialOperator', 'SpatialVariable', 'SpatialVariableEdge', - 'SpecificFunction', 'SpectralVolume', 'SpectralVolume1DSubMesh', - 'Sqrt', 'StateVector', 'StateVectorBase', 'StateVectorDot', - 'SubMesh', 'SubMesh0D', 'SubMesh1D', 'Subtraction', 'Sulzer2019', - 'SurfaceForm', 'SwellingOnly', 'Symbol', 'SymbolUnpacker', - 'SymmetricButlerVolmer', 'Tanh', 'TertiaryBroadcast', - 'TertiaryBroadcastToEdges', 'ThermalParameters', 'ThermalSubModel', - 'Thevenin', 'Time', 'Timer', 'TimerTime', 'Total', - 'TotalConcentration', 'TotalInterfacialCurrent', - 'TotalMainKinetics', 'TotalSEI', 'UnaryOperator', 'Uniform', - 'Uniform1DSubMesh', 'Upwind', 'UpwindDownwind', - 'UserSupplied1DSubMesh', 'UserSupplied2DSubMesh', 'Variable', - 'VariableBase', 'VariableDot', 'Vector', 'Voltage', - 'VoltageFunctionControl', 'VoltageModel', 'VoltageTermination', - 'XAverage', 'XAveragedPolynomialProfile', 'Xu2019', 'YZAverage', - 'Yang2017', 'ZAverage', 'ZeroDimensionalSpatialMethod', - 'active_material', 'add', 'algebraic_solver', - 'aluminium_heat_capacity_CRC', 'arcsinh', 'arctan', 'array', - 'averages', 'ax_max', 'ax_min', 'base_active_material', - 'base_battery_model', 'base_convection', 'base_current_collector', - 'base_electrode', 'base_electrolyte_conductivity', - 'base_electrolyte_diffusion', 'base_external_circuit', - 'base_interface', 'base_kinetics', 'base_lead_acid_model', - 'base_lithium_ion_model', 'base_mechanics', 'base_model', - 'base_ocp', 'base_ohm', 'base_oxygen_diffusion', 'base_parameters', - 'base_particle', 'base_plating', 'base_porosity', 'base_sei', - 'base_solver', 'base_step', 'base_submodel', 'base_thermal', - 'base_through_cell_convection', 'base_transport_efficiency', - 'base_transverse_convection', 'base_utilisation', 'basic_dfn', - 'basic_dfn_composite', 'basic_dfn_half_cell', 'basic_full', - 'basic_spm', 'batch_study', 'battery_geometry', 'binary_operators', - 'boundary_gradient', 'boundary_value', 'bpx', 'broadcasts', - 'bruggeman_transport_efficiency', 'butler_volmer', 'c1', 'c1_data', - 'c_rate', 'c_solvers', 'calculate_theoretical_energy', - 'callback_loop_decorator', 'callbacks', 'casadi_algebraic_solver', - 'casadi_solver', 'cell', 'citations', 'close_plots', - 'composite_conductivity', 'composite_ohm', - 'composite_surface_form_conductivity', 'concatenation', - 'concatenations', 'conductivity_Gu1997', 'constant_active_material', - 'constant_concentration', 'constant_porosity', 'constant_sei', - 'constant_utilisation', 'constants', 'convection', - 'convert_to_casadi', 'copper_heat_capacity_CRC', - 'copper_thermal_conductivity_CRC', 'copy_parameter_doc_from_parent', - 'cos', 'cosh', 'crack_propagation', 'cracking_rate_Ai2020', - 'create_jax_coo_matrix', 'create_object_of_size', 'current', - 'current_collector', 'current_driven_utilisation', - 'current_sigmoid_ocp', 'custom_print_func', 'dUdT', 'dUdT_data', - 'darken_thermodynamic_factor_Chapman1968', 'dfn', - 'diffusion_limited', 'diffusivity_Gu1997', 'discretisation', - 'discretisations', 'div', 'divide', 'dlnf_dlnc_Ai2020', - 'doc_extend_parent', 'doc_utils', 'domain_concatenation', - 'domain_size', 'downwind', 'dummy_solver', 'dynamic_plot', 'ecm', - 'ecm_model_options', 'ecm_parameters', - 'effective_resistance_current_collector', 'electrical_parameters', - 'electrode', 'electrode_soh', 'electrode_soh_half_cell', - 'electrolyte', 'electrolyte_TDF_EC_EMC_3_7_Landesfeind2019', - 'electrolyte_TDF_base_Landesfeind2019', 'electrolyte_conductivity', - 'electrolyte_conductivity_Ai2020', - 'electrolyte_conductivity_Capiglia1999', - 'electrolyte_conductivity_EC_EMC_3_7_Landesfeind2019', - 'electrolyte_conductivity_Ecker2015', - 'electrolyte_conductivity_Kim2011', - 'electrolyte_conductivity_Nyman2008', - 'electrolyte_conductivity_Nyman2008_arrhenius', - 'electrolyte_conductivity_PeymanMPM', - 'electrolyte_conductivity_Prada2013', - 'electrolyte_conductivity_Ramadass2004', - 'electrolyte_conductivity_Valoen2005', - 'electrolyte_conductivity_base_Landesfeind2019', - 'electrolyte_diffusion', 'electrolyte_diffusivity_Ai2020', - 'electrolyte_diffusivity_Capiglia1999', - 'electrolyte_diffusivity_EC_EMC_3_7_Landesfeind2019', - 'electrolyte_diffusivity_Ecker2015', - 'electrolyte_diffusivity_Kim2011', - 'electrolyte_diffusivity_Nyman2008', - 'electrolyte_diffusivity_Nyman2008_arrhenius', - 'electrolyte_diffusivity_PeymanMPM', - 'electrolyte_diffusivity_Ramadass2004', - 'electrolyte_diffusivity_Valoen2005', - 'electrolyte_diffusivity_base_Landesfeind2019', - 'electrolyte_transference_number_EC_EMC_3_7_Landesfeind2019', - 'electrolyte_transference_number_base_Landesfeind2019', - 'equivalent_circuit', 'equivalent_circuit_elements', 'erf', 'erfc', - 'evaluate_for_shape_using_domain', 'evaluate_python', 'event', - 'example_set', 'exceptions', 'exp', 'experiment', - 'explicit_control_external_circuit', 'explicit_convection', - 'explicit_surface_form_conductivity', 'expression_tree', - 'external_circuit', 'fickian_diffusion', 'find_symbol_in_dict', - 'find_symbol_in_model', 'find_symbol_in_tree', 'find_symbols', - 'finite_volume', 'full', 'full_battery_models', 'full_conductivity', - 'full_convection', 'full_diffusion', 'full_like', 'full_ohm', - 'full_oxygen_diffusion', 'full_surface_form_conductivity', - 'full_utilisation', 'function_control_external_circuit', - 'functions', 'geometric_parameters', 'geometry', - 'get_git_commit_info', 'get_initial_ocps', - 'get_initial_stoichiometries', - 'get_initial_stoichiometry_half_cell', 'get_log_level_func', - 'get_min_max_ocps', 'get_min_max_stoichiometries', 'get_new_logger', - 'get_parameter_values', 'get_parameters_filepath', - 'get_rng_min_max_name', 'get_size_distribution_parameters', 'grad', - 'grad_squared', 'graphite_LGM50_diffusivity_Chen2020', - 'graphite_LGM50_diffusivity_ORegan2022', - 'graphite_LGM50_electrolyte_exchange_current_density_Chen2020', - 'graphite_LGM50_electrolyte_exchange_current_density_ORegan2022', - 'graphite_LGM50_entropic_change_ORegan2022', - 'graphite_LGM50_heat_capacity_ORegan2022', - 'graphite_LGM50_ocp_Chen2020', 'graphite_LGM50_ocp_Chen2020_data', - 'graphite_LGM50_thermal_conductivity_ORegan2022', - 'graphite_cracking_rate_Ai2020', - 'graphite_diffusivity_Dualfoil1998', - 'graphite_diffusivity_Ecker2015', 'graphite_diffusivity_Kim2011', - 'graphite_diffusivity_PeymanMPM', - 'graphite_electrolyte_exchange_current_density_Dualfoil1998', - 'graphite_electrolyte_exchange_current_density_Ecker2015', - 'graphite_electrolyte_exchange_current_density_Kim2011', - 'graphite_electrolyte_exchange_current_density_PeymanMPM', - 'graphite_electrolyte_exchange_current_density_Ramadass2004', - 'graphite_entropic_change_Moura2016', - 'graphite_entropic_change_PeymanMPM', - 'graphite_entropy_Enertech_Ai2020_function', - 'graphite_mcmb2528_diffusivity_Dualfoil1998', - 'graphite_mcmb2528_ocp_Dualfoil1998', 'graphite_ocp_Ecker2015', - 'graphite_ocp_Enertech_Ai2020', 'graphite_ocp_Enertech_Ai2020_data', - 'graphite_ocp_Kim2011', 'graphite_ocp_PeymanMPM', - 'graphite_ocp_Ramadass2004', 'graphite_volume_change_Ai2020', - 'has_bc_of_form', 'have_idaklu', 'have_jax', - 'homogeneous_current_collector', 'id_to_python_variable', - 'idaklu_jax', 'idaklu_solver', 'idaklu_spec', - 'import_optional_dependency', 'independent_variable', 'inner', - 'input', 'input_parameter', 'install_jax', - 'integrated_conductivity', 'interface', 'interface_utilisation', - 'interpolant', 'intersect', 'inverse_butler_volmer', - 'inverse_kinetics', 'is_constant', 'is_constant_and_can_evaluate', - 'is_jax_compatible', 'is_matrix_minus_one', 'is_matrix_one', - 'is_matrix_x', 'is_matrix_zero', 'is_notebook', 'is_scalar', - 'is_scalar_minus_one', 'is_scalar_one', 'is_scalar_x', - 'is_scalar_zero', 'isothermal', 'jacobian', 'jax_bdf_integrate', - 'jax_bdf_solver', 'jax_solver', 'k_b', 'kinetics', 'laplacian', - 'latexify', 'lead_acid', 'lead_acid_parameters', - 'lead_dioxide_exchange_current_density_Sulzer2019', - 'lead_dioxide_ocp_Bode1977', - 'lead_exchange_current_density_Sulzer2019', 'lead_ocp_Bode1977', - 'leading_ohm', 'leading_order_conductivity', - 'leading_order_diffusion', 'leading_oxygen_diffusion', - 'leading_surface_form_conductivity', 'li_metal', - 'li_metal_electrolyte_exchange_current_density_Xu2019', - 'lico2_cracking_rate_Ai2020', 'lico2_diffusivity_Dualfoil1998', - 'lico2_diffusivity_Ramadass2004', - 'lico2_electrolyte_exchange_current_density_Dualfoil1998', - 'lico2_electrolyte_exchange_current_density_Ramadass2004', - 'lico2_entropic_change_Ai2020_function', - 'lico2_entropic_change_Moura2016', 'lico2_ocp_Ai2020', - 'lico2_ocp_Ai2020_data', 'lico2_ocp_Dualfoil1998', - 'lico2_ocp_Ramadass2004', 'lico2_volume_change_Ai2020', 'linear', - 'linspace', 'lithium_ion', 'lithium_ion_parameters', - 'lithium_plating', 'load', 'load_model', 'load_sim', 'log', 'log10', - 'logger', 'lognormal', 'loqs', 'loss_active_material', 'lrudict', - 'lumped', 'make_cycle_solution', 'marcus', 'matmul', 'matrix', - 'maximum', 'meshes', 'meshgrid', 'minimum', 'models', 'mpm', 'msmr', - 'msmr_butler_volmer', 'msmr_diffusion', 'msmr_ocp', 'multiply', - 'nca_diffusivity_Kim2011', - 'nca_electrolyte_exchange_current_density_Kim2011', - 'nca_ocp_Kim2011', 'nco_diffusivity_Ecker2015', - 'nco_electrolyte_exchange_current_density_Ecker2015', - 'nco_ocp_Ecker2015', 'negative_current_collector', - 'negative_electrode', 'negative_particle', 'new_levels', - 'newman_tobias', 'nmc_LGM50_diffusivity_Chen2020', - 'nmc_LGM50_diffusivity_ORegan2022', - 'nmc_LGM50_electrolyte_exchange_current_density_Chen2020', - 'nmc_LGM50_electrolyte_exchange_current_density_ORegan2022', - 'nmc_LGM50_electronic_conductivity_ORegan2022', - 'nmc_LGM50_entropic_change_ORegan2022', - 'nmc_LGM50_heat_capacity_ORegan2022', 'nmc_LGM50_ocp_Chen2020', - 'nmc_LGM50_thermal_conductivity_ORegan2022', - 'nmc_electrolyte_exchange_current_density_Xu2019', 'nmc_ocp_Xu2019', - 'no_convection', 'no_mechanics', 'no_oxygen', 'no_plating', - 'no_reaction', 'no_sei', 'normal_cdf', 'normal_pdf', - 'numpy_concatenation', 'ocv', 'ocv_data', 'ocv_element', 'ohm', - 'one_dimensional_submeshes', 'ones_like', 'open_circuit_potential', - 'operations', 'oxygen_diffusion', - 'oxygen_exchange_current_density_Sulzer2019', 'parameter', - 'parameter_sets', 'parameter_values', 'parameters', 'particle', - 'particle_mechanics', 'plating', - 'plating_exchange_current_density_OKane2020', 'plot', 'plot2D', - 'plot_summary_variables', 'plot_thermal_components', - 'plot_voltage_components', 'plotting', 'polynomial_profile', - 'porosity', 'positive_current_collector', 'positive_electrode', - 'positive_particle', 'potential_pair', 'pouch_cell', - 'pouch_cell_1D_current_collectors', - 'pouch_cell_2D_current_collectors', 'power', 'preamble', - 'prettify_print_name', 'print_citations', 'print_name', 'printing', - 'process', 'process_1D_data', 'process_2D_data', - 'process_2D_data_csv', 'process_3D_data_csv', - 'process_float_function_table', 'process_parameter_data', - 'processed_variable', 'processed_variable_computed', 'q_e', - 'quick_plot', 'r0', 'r0_data', 'r1', 'r1_data', 'r_average', - 'r_macro', 'r_macro_edge', 'r_n', 'r_n_edge', 'r_n_prim', 'r_n_sec', - 'r_p', 'r_p_edge', 'r_p_prim', 'r_p_sec', 'rc_element', - 'reaction_driven_porosity', 'reaction_driven_porosity_ode', - 'represents_positive_integer', 'resistance', 'resistor_element', - 'rest', 'root_dir', 'scalar', 'scikit_fem_submeshes', - 'scikit_finite_element', 'scipy_solver', 'sech', 'sei', - 'sei_growth', 'separator', - 'separator_LGM50_heat_capacity_ORegan2022', 'serialise', - 'set_logging_level', 'settings', 'setup_callbacks', 'sigmoid', - 'sign', - 'silicon_LGM50_electrolyte_exchange_current_density_Chen2020', - 'silicon_ocp_delithiation_Mark2016', - 'silicon_ocp_lithiation_Mark2016', 'simplified_concatenation', - 'simplified_domain_concatenation', 'simplified_function', - 'simplified_numpy_concatenation', 'simplified_power', - 'simplify_if_constant', 'simulation', 'sin', 'single_ocp', 'sinh', - 'size_average', 'size_distribution_parameters', - 'smooth_absolute_value', 'smooth_max', 'smooth_min', 'softminus', - 'softplus', 'solution', 'solvers', 'source', 'spatial_method', - 'spatial_methods', 'spectral_volume', 'split_long_string', 'spm', - 'spme', 'sqrt', 'standard_spatial_vars', 'state_vector', 'step', - 'step_termination', 'steps', 'string', - 'stripping_exchange_current_density_OKane2020', 'submodels', - 'substrings', 'subtract', 'surf', 'surface_form_ohm', - 'surface_potential_form', 'swelling_only', 'symbol', - 'sympy_overrides', 't', 'tafel', 'tanh', - 'theoretical_energy_integral', 'thermal', 'thermal_parameters', - 'thevenin', 'through_cell', 'to_python', 'total_active_material', - 'total_interfacial_current', 'total_main_kinetics', - 'total_particle_concentration', 'total_sei', 'transport_efficiency', - 'transverse', 'type_definitions', 'unary_operators', - 'uniform_convection', 'unpack_symbols', 'upwind', 'util', - 'value_based_charge_or_discharge', 'variable', 'vector', 'version', - 'voltage', 'voltage_model', 'volume_change_Ai2020', 'whole_cell', - 'x', 'x_average', 'x_averaged_polynomial_profile', 'x_edge', - 'x_full', 'x_n', 'x_n_edge', 'x_p', 'x_p_edge', 'x_s', 'x_s_edge', - 'xyz_average', 'y', 'y_edge', 'yz_average', 'z', 'z_average', - 'z_edge', 'zero_dimensional_method', 'zero_dimensional_submesh', - 'zeros_like'] +__all__ = ['batch_study', 'callbacks', 'citations', 'discretisations', + 'doc_utils', 'experiment', 'expression_tree', 'geometry', 'input', + 'logger', 'meshes', 'models', 'parameters', 'plotting', 'settings', + 'simulation', 'solvers', 'spatial_methods', 'type_definitions', + 'util', 'version'] diff --git a/pybamm/discretisations/__init__.py b/pybamm/discretisations/__init__.py index e69de29bb2..5dc6969c2d 100644 --- a/pybamm/discretisations/__init__.py +++ b/pybamm/discretisations/__init__.py @@ -0,0 +1 @@ +__all__ = ['discretisation'] diff --git a/pybamm/experiment/__init__.py b/pybamm/experiment/__init__.py index e69de29bb2..611abede0c 100644 --- a/pybamm/experiment/__init__.py +++ b/pybamm/experiment/__init__.py @@ -0,0 +1 @@ +__all__ = ['experiment', 'step'] diff --git a/pybamm/experiment/step/__init__.py b/pybamm/experiment/step/__init__.py index 17ab7c49f5..1810844d3f 100644 --- a/pybamm/experiment/step/__init__.py +++ b/pybamm/experiment/step/__init__.py @@ -1,3 +1,5 @@ from .steps import * from .base_step import BaseStep, BaseStepExplicit, BaseStepImplicit from .step_termination import * + +__all__ = ['base_step', 'step_termination', 'steps'] diff --git a/pybamm/expression_tree/__init__.py b/pybamm/expression_tree/__init__.py index e69de29bb2..0b06746e61 100644 --- a/pybamm/expression_tree/__init__.py +++ b/pybamm/expression_tree/__init__.py @@ -0,0 +1,5 @@ +__all__ = ['array', 'averages', 'binary_operators', 'broadcasts', + 'concatenations', 'exceptions', 'functions', 'independent_variable', + 'input_parameter', 'interpolant', 'matrix', 'operations', + 'parameter', 'printing', 'scalar', 'state_vector', 'symbol', + 'unary_operators', 'variable', 'vector'] diff --git a/pybamm/expression_tree/operations/__init__.py b/pybamm/expression_tree/operations/__init__.py index e69de29bb2..e1dd103840 100644 --- a/pybamm/expression_tree/operations/__init__.py +++ b/pybamm/expression_tree/operations/__init__.py @@ -0,0 +1,2 @@ +__all__ = ['convert_to_casadi', 'evaluate_python', 'jacobian', 'latexify', + 'serialise', 'unpack_symbols'] diff --git a/pybamm/expression_tree/printing/__init__.py b/pybamm/expression_tree/printing/__init__.py index e69de29bb2..d5d4656374 100644 --- a/pybamm/expression_tree/printing/__init__.py +++ b/pybamm/expression_tree/printing/__init__.py @@ -0,0 +1 @@ +__all__ = ['print_name', 'sympy_overrides'] diff --git a/pybamm/geometry/__init__.py b/pybamm/geometry/__init__.py index e69de29bb2..d763174ffb 100644 --- a/pybamm/geometry/__init__.py +++ b/pybamm/geometry/__init__.py @@ -0,0 +1 @@ +__all__ = ['battery_geometry', 'geometry', 'standard_spatial_vars'] diff --git a/pybamm/input/__init__.py b/pybamm/input/__init__.py index e69de29bb2..916888ce34 100644 --- a/pybamm/input/__init__.py +++ b/pybamm/input/__init__.py @@ -0,0 +1 @@ +__all__ = ['parameters'] diff --git a/pybamm/input/parameters/__init__.py b/pybamm/input/parameters/__init__.py index e69de29bb2..9ef23b743d 100644 --- a/pybamm/input/parameters/__init__.py +++ b/pybamm/input/parameters/__init__.py @@ -0,0 +1 @@ +__all__ = ['ecm', 'lead_acid', 'lithium_ion'] diff --git a/pybamm/input/parameters/ecm/__init__.py b/pybamm/input/parameters/ecm/__init__.py index e69de29bb2..65332e5c24 100644 --- a/pybamm/input/parameters/ecm/__init__.py +++ b/pybamm/input/parameters/ecm/__init__.py @@ -0,0 +1 @@ +__all__ = ['example_set'] diff --git a/pybamm/input/parameters/lead_acid/__init__.py b/pybamm/input/parameters/lead_acid/__init__.py index e69de29bb2..608e2b68b7 100644 --- a/pybamm/input/parameters/lead_acid/__init__.py +++ b/pybamm/input/parameters/lead_acid/__init__.py @@ -0,0 +1 @@ +__all__ = ['Sulzer2019'] diff --git a/pybamm/input/parameters/lithium_ion/__init__.py b/pybamm/input/parameters/lithium_ion/__init__.py index e69de29bb2..8f8e250f9d 100644 --- a/pybamm/input/parameters/lithium_ion/__init__.py +++ b/pybamm/input/parameters/lithium_ion/__init__.py @@ -0,0 +1,5 @@ +__all__ = ['Ai2020', 'Chen2020', 'Chen2020_composite', 'Ecker2015', + 'Ecker2015_graphite_halfcell', 'MSMR_example_set', 'Marquis2019', + 'Mohtat2020', 'NCA_Kim2011', 'OKane2022', + 'OKane2022_graphite_SiOx_halfcell', 'ORegan2022', 'Prada2013', + 'Ramadass2004', 'Xu2019'] diff --git a/pybamm/meshes/__init__.py b/pybamm/meshes/__init__.py index e69de29bb2..0bd3f8d78b 100644 --- a/pybamm/meshes/__init__.py +++ b/pybamm/meshes/__init__.py @@ -0,0 +1,2 @@ +__all__ = ['meshes', 'one_dimensional_submeshes', 'scikit_fem_submeshes', + 'zero_dimensional_submesh'] diff --git a/pybamm/models/__init__.py b/pybamm/models/__init__.py index e69de29bb2..3796f1264d 100644 --- a/pybamm/models/__init__.py +++ b/pybamm/models/__init__.py @@ -0,0 +1 @@ +__all__ = ['base_model', 'event', 'full_battery_models', 'submodels'] diff --git a/pybamm/models/full_battery_models/__init__.py b/pybamm/models/full_battery_models/__init__.py index e69de29bb2..135f678289 100644 --- a/pybamm/models/full_battery_models/__init__.py +++ b/pybamm/models/full_battery_models/__init__.py @@ -0,0 +1,2 @@ +__all__ = ['base_battery_model', 'equivalent_circuit', 'lead_acid', + 'lithium_ion'] diff --git a/pybamm/models/full_battery_models/equivalent_circuit/__init__.py b/pybamm/models/full_battery_models/equivalent_circuit/__init__.py index c4bf7d5a56..8c87ce3179 100644 --- a/pybamm/models/full_battery_models/equivalent_circuit/__init__.py +++ b/pybamm/models/full_battery_models/equivalent_circuit/__init__.py @@ -1 +1,3 @@ from .thevenin import * + +__all__ = ['ecm_model_options', 'thevenin'] diff --git a/pybamm/models/full_battery_models/lead_acid/__init__.py b/pybamm/models/full_battery_models/lead_acid/__init__.py index 5895bddeb4..b707e8922c 100644 --- a/pybamm/models/full_battery_models/lead_acid/__init__.py +++ b/pybamm/models/full_battery_models/lead_acid/__init__.py @@ -5,3 +5,5 @@ from .loqs import LOQS from .full import Full from .basic_full import BasicFull + +__all__ = ['base_lead_acid_model', 'basic_full', 'full', 'loqs'] diff --git a/pybamm/models/full_battery_models/lithium_ion/__init__.py b/pybamm/models/full_battery_models/lithium_ion/__init__.py index a58b5a6fe0..b02868dbe9 100644 --- a/pybamm/models/full_battery_models/lithium_ion/__init__.py +++ b/pybamm/models/full_battery_models/lithium_ion/__init__.py @@ -24,3 +24,8 @@ from .Yang2017 import Yang2017 from .mpm import MPM from .msmr import MSMR + +__all__ = ['Yang2017', 'base_lithium_ion_model', 'basic_dfn', + 'basic_dfn_composite', 'basic_dfn_half_cell', 'basic_spm', 'dfn', + 'electrode_soh', 'electrode_soh_half_cell', 'mpm', 'msmr', + 'newman_tobias', 'spm', 'spme'] diff --git a/pybamm/models/submodels/__init__.py b/pybamm/models/submodels/__init__.py index e69de29bb2..68950d1744 100644 --- a/pybamm/models/submodels/__init__.py +++ b/pybamm/models/submodels/__init__.py @@ -0,0 +1,5 @@ +__all__ = ['active_material', 'base_submodel', 'convection', + 'current_collector', 'electrode', 'electrolyte_conductivity', + 'electrolyte_diffusion', 'equivalent_circuit_elements', + 'external_circuit', 'interface', 'oxygen_diffusion', 'particle', + 'particle_mechanics', 'porosity', 'thermal', 'transport_efficiency'] diff --git a/pybamm/models/submodels/active_material/__init__.py b/pybamm/models/submodels/active_material/__init__.py index cb263eb4ff..ce03867c30 100644 --- a/pybamm/models/submodels/active_material/__init__.py +++ b/pybamm/models/submodels/active_material/__init__.py @@ -2,3 +2,6 @@ from .constant_active_material import Constant from .loss_active_material import LossActiveMaterial from .total_active_material import Total + +__all__ = ['base_active_material', 'constant_active_material', + 'loss_active_material', 'total_active_material'] diff --git a/pybamm/models/submodels/convection/__init__.py b/pybamm/models/submodels/convection/__init__.py index cc0a0d086d..45f1b13a03 100644 --- a/pybamm/models/submodels/convection/__init__.py +++ b/pybamm/models/submodels/convection/__init__.py @@ -1,2 +1,4 @@ from .base_convection import BaseModel from . import through_cell, transverse + +__all__ = ['base_convection', 'through_cell', 'transverse'] diff --git a/pybamm/models/submodels/convection/through_cell/__init__.py b/pybamm/models/submodels/convection/through_cell/__init__.py index ddcd5b9e9b..7b31a94264 100644 --- a/pybamm/models/submodels/convection/through_cell/__init__.py +++ b/pybamm/models/submodels/convection/through_cell/__init__.py @@ -2,3 +2,6 @@ from .no_convection import NoConvection from .explicit_convection import Explicit from .full_convection import Full + +__all__ = ['base_through_cell_convection', 'explicit_convection', + 'full_convection', 'no_convection'] diff --git a/pybamm/models/submodels/convection/transverse/__init__.py b/pybamm/models/submodels/convection/transverse/__init__.py index c2b2292168..9683fa0eb0 100644 --- a/pybamm/models/submodels/convection/transverse/__init__.py +++ b/pybamm/models/submodels/convection/transverse/__init__.py @@ -2,3 +2,6 @@ from .no_convection import NoConvection from .uniform_convection import Uniform from .full_convection import Full + +__all__ = ['base_transverse_convection', 'full_convection', 'no_convection', + 'uniform_convection'] diff --git a/pybamm/models/submodels/current_collector/__init__.py b/pybamm/models/submodels/current_collector/__init__.py index b721f14394..75eae41a34 100644 --- a/pybamm/models/submodels/current_collector/__init__.py +++ b/pybamm/models/submodels/current_collector/__init__.py @@ -10,3 +10,6 @@ PotentialPair1plus1D, PotentialPair2plus1D, ) + +__all__ = ['base_current_collector', 'effective_resistance_current_collector', + 'homogeneous_current_collector', 'potential_pair'] diff --git a/pybamm/models/submodels/electrode/__init__.py b/pybamm/models/submodels/electrode/__init__.py index ce60b7e1e7..c9abc0aeab 100644 --- a/pybamm/models/submodels/electrode/__init__.py +++ b/pybamm/models/submodels/electrode/__init__.py @@ -1,2 +1,4 @@ from .base_electrode import BaseElectrode from . import ohm + +__all__ = ['base_electrode', 'ohm'] diff --git a/pybamm/models/submodels/electrode/ohm/__init__.py b/pybamm/models/submodels/electrode/ohm/__init__.py index c25ece8717..0a120ab44a 100644 --- a/pybamm/models/submodels/electrode/ohm/__init__.py +++ b/pybamm/models/submodels/electrode/ohm/__init__.py @@ -4,3 +4,6 @@ from .leading_ohm import LeadingOrder from .surface_form_ohm import SurfaceForm from .li_metal import LithiumMetalExplicit, LithiumMetalSurfaceForm + +__all__ = ['base_ohm', 'composite_ohm', 'full_ohm', 'leading_ohm', 'li_metal', + 'surface_form_ohm'] diff --git a/pybamm/models/submodels/electrolyte_conductivity/__init__.py b/pybamm/models/submodels/electrolyte_conductivity/__init__.py index 04925ea890..48b3232d44 100644 --- a/pybamm/models/submodels/electrolyte_conductivity/__init__.py +++ b/pybamm/models/submodels/electrolyte_conductivity/__init__.py @@ -5,3 +5,7 @@ from .integrated_conductivity import Integrated from . import surface_potential_form + +__all__ = ['base_electrolyte_conductivity', 'composite_conductivity', + 'full_conductivity', 'integrated_conductivity', + 'leading_order_conductivity', 'surface_potential_form'] diff --git a/pybamm/models/submodels/electrolyte_conductivity/surface_potential_form/__init__.py b/pybamm/models/submodels/electrolyte_conductivity/surface_potential_form/__init__.py index 2af47138c8..ec443ccf51 100644 --- a/pybamm/models/submodels/electrolyte_conductivity/surface_potential_form/__init__.py +++ b/pybamm/models/submodels/electrolyte_conductivity/surface_potential_form/__init__.py @@ -15,3 +15,8 @@ # Explicit model from .explicit_surface_form_conductivity import Explicit + +__all__ = ['composite_surface_form_conductivity', + 'explicit_surface_form_conductivity', + 'full_surface_form_conductivity', + 'leading_surface_form_conductivity'] diff --git a/pybamm/models/submodels/electrolyte_diffusion/__init__.py b/pybamm/models/submodels/electrolyte_diffusion/__init__.py index 5636b77fea..3d03f53394 100644 --- a/pybamm/models/submodels/electrolyte_diffusion/__init__.py +++ b/pybamm/models/submodels/electrolyte_diffusion/__init__.py @@ -2,3 +2,6 @@ from .leading_order_diffusion import LeadingOrder from .full_diffusion import Full from .constant_concentration import ConstantConcentration + +__all__ = ['base_electrolyte_diffusion', 'constant_concentration', + 'full_diffusion', 'leading_order_diffusion'] diff --git a/pybamm/models/submodels/equivalent_circuit_elements/__init__.py b/pybamm/models/submodels/equivalent_circuit_elements/__init__.py index a4e76cc5b8..4ff6ee7c62 100644 --- a/pybamm/models/submodels/equivalent_circuit_elements/__init__.py +++ b/pybamm/models/submodels/equivalent_circuit_elements/__init__.py @@ -3,3 +3,6 @@ from .rc_element import RCElement from .thermal import ThermalSubModel from .voltage_model import VoltageModel + +__all__ = ['ocv_element', 'rc_element', 'resistor_element', 'thermal', + 'voltage_model'] diff --git a/pybamm/models/submodels/external_circuit/__init__.py b/pybamm/models/submodels/external_circuit/__init__.py index bd71790295..f51623b713 100644 --- a/pybamm/models/submodels/external_circuit/__init__.py +++ b/pybamm/models/submodels/external_circuit/__init__.py @@ -11,3 +11,6 @@ ResistanceFunctionControl, CCCVFunctionControl, ) + +__all__ = ['base_external_circuit', 'explicit_control_external_circuit', + 'function_control_external_circuit'] diff --git a/pybamm/models/submodels/interface/__init__.py b/pybamm/models/submodels/interface/__init__.py index 1a3ffd6876..7779c8365e 100644 --- a/pybamm/models/submodels/interface/__init__.py +++ b/pybamm/models/submodels/interface/__init__.py @@ -1,2 +1,6 @@ from .base_interface import BaseInterface from .total_interfacial_current import TotalInterfacialCurrent + +__all__ = ['base_interface', 'interface_utilisation', 'kinetics', + 'lithium_plating', 'open_circuit_potential', 'sei', + 'total_interfacial_current'] diff --git a/pybamm/models/submodels/interface/interface_utilisation/__init__.py b/pybamm/models/submodels/interface/interface_utilisation/__init__.py index f13ee19d6b..1ffe9da5f5 100644 --- a/pybamm/models/submodels/interface/interface_utilisation/__init__.py +++ b/pybamm/models/submodels/interface/interface_utilisation/__init__.py @@ -2,3 +2,6 @@ from .full_utilisation import Full from .constant_utilisation import Constant from .current_driven_utilisation import CurrentDriven + +__all__ = ['base_utilisation', 'constant_utilisation', + 'current_driven_utilisation', 'full_utilisation'] diff --git a/pybamm/models/submodels/interface/kinetics/__init__.py b/pybamm/models/submodels/interface/kinetics/__init__.py index d99ec56783..c083271263 100644 --- a/pybamm/models/submodels/interface/kinetics/__init__.py +++ b/pybamm/models/submodels/interface/kinetics/__init__.py @@ -12,3 +12,7 @@ CurrentForInverseButlerVolmer, CurrentForInverseButlerVolmerLithiumMetal, ) + +__all__ = ['base_kinetics', 'butler_volmer', 'diffusion_limited', + 'inverse_kinetics', 'linear', 'marcus', 'msmr_butler_volmer', + 'no_reaction', 'tafel', 'total_main_kinetics'] diff --git a/pybamm/models/submodels/interface/kinetics/inverse_kinetics/__init__.py b/pybamm/models/submodels/interface/kinetics/inverse_kinetics/__init__.py index e69de29bb2..dce1ad8271 100644 --- a/pybamm/models/submodels/interface/kinetics/inverse_kinetics/__init__.py +++ b/pybamm/models/submodels/interface/kinetics/inverse_kinetics/__init__.py @@ -0,0 +1 @@ +__all__ = ['inverse_butler_volmer'] diff --git a/pybamm/models/submodels/interface/lithium_plating/__init__.py b/pybamm/models/submodels/interface/lithium_plating/__init__.py index cea178158d..3415482028 100644 --- a/pybamm/models/submodels/interface/lithium_plating/__init__.py +++ b/pybamm/models/submodels/interface/lithium_plating/__init__.py @@ -1,3 +1,5 @@ from .base_plating import BasePlating from .no_plating import NoPlating from .plating import Plating + +__all__ = ['base_plating', 'no_plating', 'plating'] diff --git a/pybamm/models/submodels/interface/open_circuit_potential/__init__.py b/pybamm/models/submodels/interface/open_circuit_potential/__init__.py index 5f8a409bba..23658d67fa 100644 --- a/pybamm/models/submodels/interface/open_circuit_potential/__init__.py +++ b/pybamm/models/submodels/interface/open_circuit_potential/__init__.py @@ -2,3 +2,5 @@ from .single_ocp import SingleOpenCircuitPotential from .current_sigmoid_ocp import CurrentSigmoidOpenCircuitPotential from .msmr_ocp import MSMROpenCircuitPotential + +__all__ = ['base_ocp', 'current_sigmoid_ocp', 'msmr_ocp', 'single_ocp'] diff --git a/pybamm/models/submodels/interface/sei/__init__.py b/pybamm/models/submodels/interface/sei/__init__.py index 5f151daf0e..e7cd3d4bb1 100644 --- a/pybamm/models/submodels/interface/sei/__init__.py +++ b/pybamm/models/submodels/interface/sei/__init__.py @@ -3,3 +3,5 @@ from .no_sei import NoSEI from .constant_sei import ConstantSEI from .sei_growth import SEIGrowth + +__all__ = ['base_sei', 'constant_sei', 'no_sei', 'sei_growth', 'total_sei'] diff --git a/pybamm/models/submodels/oxygen_diffusion/__init__.py b/pybamm/models/submodels/oxygen_diffusion/__init__.py index a5161f93f9..864bf2ef4d 100644 --- a/pybamm/models/submodels/oxygen_diffusion/__init__.py +++ b/pybamm/models/submodels/oxygen_diffusion/__init__.py @@ -2,3 +2,6 @@ from .leading_oxygen_diffusion import LeadingOrder from .full_oxygen_diffusion import Full from .no_oxygen import NoOxygen + +__all__ = ['base_oxygen_diffusion', 'full_oxygen_diffusion', + 'leading_oxygen_diffusion', 'no_oxygen'] diff --git a/pybamm/models/submodels/particle/__init__.py b/pybamm/models/submodels/particle/__init__.py index 237b2c19c8..1f52863fc6 100644 --- a/pybamm/models/submodels/particle/__init__.py +++ b/pybamm/models/submodels/particle/__init__.py @@ -4,3 +4,7 @@ from .x_averaged_polynomial_profile import XAveragedPolynomialProfile from .total_particle_concentration import TotalConcentration from .msmr_diffusion import MSMRDiffusion + +__all__ = ['base_particle', 'fickian_diffusion', 'msmr_diffusion', + 'polynomial_profile', 'total_particle_concentration', + 'x_averaged_polynomial_profile'] diff --git a/pybamm/models/submodels/particle_mechanics/__init__.py b/pybamm/models/submodels/particle_mechanics/__init__.py index 9b89a95d55..7aec637e7d 100644 --- a/pybamm/models/submodels/particle_mechanics/__init__.py +++ b/pybamm/models/submodels/particle_mechanics/__init__.py @@ -2,3 +2,6 @@ from .crack_propagation import CrackPropagation from .swelling_only import SwellingOnly from .no_mechanics import NoMechanics + +__all__ = ['base_mechanics', 'crack_propagation', 'no_mechanics', + 'swelling_only'] diff --git a/pybamm/models/submodels/porosity/__init__.py b/pybamm/models/submodels/porosity/__init__.py index de09dca46c..e45768a9c1 100644 --- a/pybamm/models/submodels/porosity/__init__.py +++ b/pybamm/models/submodels/porosity/__init__.py @@ -2,3 +2,6 @@ from .constant_porosity import Constant from .reaction_driven_porosity import ReactionDriven from .reaction_driven_porosity_ode import ReactionDrivenODE + +__all__ = ['base_porosity', 'constant_porosity', 'reaction_driven_porosity', + 'reaction_driven_porosity_ode'] diff --git a/pybamm/models/submodels/thermal/__init__.py b/pybamm/models/submodels/thermal/__init__.py index 056a555e3f..cc8f769f36 100644 --- a/pybamm/models/submodels/thermal/__init__.py +++ b/pybamm/models/submodels/thermal/__init__.py @@ -2,3 +2,5 @@ from .isothermal import Isothermal from .lumped import Lumped from . import pouch_cell + +__all__ = ['base_thermal', 'isothermal', 'lumped', 'pouch_cell'] diff --git a/pybamm/models/submodels/thermal/pouch_cell/__init__.py b/pybamm/models/submodels/thermal/pouch_cell/__init__.py index 7d0ddedbdf..571577e71a 100644 --- a/pybamm/models/submodels/thermal/pouch_cell/__init__.py +++ b/pybamm/models/submodels/thermal/pouch_cell/__init__.py @@ -1,3 +1,6 @@ from .x_full import OneDimensionalX from .pouch_cell_1D_current_collectors import CurrentCollector1D from .pouch_cell_2D_current_collectors import CurrentCollector2D + +__all__ = ['pouch_cell_1D_current_collectors', + 'pouch_cell_2D_current_collectors', 'x_full'] diff --git a/pybamm/models/submodels/transport_efficiency/__init__.py b/pybamm/models/submodels/transport_efficiency/__init__.py index 13fbe8487d..4cb1619a83 100644 --- a/pybamm/models/submodels/transport_efficiency/__init__.py +++ b/pybamm/models/submodels/transport_efficiency/__init__.py @@ -1,2 +1,4 @@ from .base_transport_efficiency import BaseModel from .bruggeman_transport_efficiency import Bruggeman + +__all__ = ['base_transport_efficiency', 'bruggeman_transport_efficiency'] diff --git a/pybamm/parameters/__init__.py b/pybamm/parameters/__init__.py index cf81b82fdd..33d427b007 100644 --- a/pybamm/parameters/__init__.py +++ b/pybamm/parameters/__init__.py @@ -4,3 +4,9 @@ process_2D_data_csv, process_3D_data_csv, ) + +__all__ = ['base_parameters', 'bpx', 'constants', 'ecm_parameters', + 'electrical_parameters', 'geometric_parameters', + 'lead_acid_parameters', 'lithium_ion_parameters', 'parameter_sets', + 'parameter_values', 'process_parameter_data', + 'size_distribution_parameters', 'thermal_parameters'] diff --git a/pybamm/plotting/__init__.py b/pybamm/plotting/__init__.py index e69de29bb2..80a7b78ace 100644 --- a/pybamm/plotting/__init__.py +++ b/pybamm/plotting/__init__.py @@ -0,0 +1,2 @@ +__all__ = ['dynamic_plot', 'plot', 'plot2D', 'plot_summary_variables', + 'plot_thermal_components', 'plot_voltage_components', 'quick_plot'] diff --git a/pybamm/solvers/__init__.py b/pybamm/solvers/__init__.py index e69de29bb2..fc8be7e2f8 100644 --- a/pybamm/solvers/__init__.py +++ b/pybamm/solvers/__init__.py @@ -0,0 +1,5 @@ +__all__ = ['algebraic_solver', 'base_solver', 'c_solvers', + 'casadi_algebraic_solver', 'casadi_solver', 'dummy_solver', + 'idaklu_jax', 'idaklu_solver', 'jax_bdf_solver', 'jax_solver', + 'lrudict', 'processed_variable', 'processed_variable_computed', + 'scipy_solver', 'solution'] diff --git a/pybamm/solvers/c_solvers/__init__.py b/pybamm/solvers/c_solvers/__init__.py index e69de29bb2..a9a2c5b3bb 100644 --- a/pybamm/solvers/c_solvers/__init__.py +++ b/pybamm/solvers/c_solvers/__init__.py @@ -0,0 +1 @@ +__all__ = [] diff --git a/pybamm/spatial_methods/__init__.py b/pybamm/spatial_methods/__init__.py index e69de29bb2..56b9988536 100644 --- a/pybamm/spatial_methods/__init__.py +++ b/pybamm/spatial_methods/__init__.py @@ -0,0 +1,2 @@ +__all__ = ['finite_volume', 'scikit_finite_element', 'spatial_method', + 'spectral_volume', 'zero_dimensional_method'] From ecd559a64f5558142a33dd5828f8f960274e6f3f Mon Sep 17 00:00:00 2001 From: Arjun Verma Date: Thu, 2 May 2024 12:39:45 +0530 Subject: [PATCH 3/4] Suggestions from code review Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> --- pybamm/solvers/c_solvers/__init__.py | 1 - 1 file changed, 1 deletion(-) diff --git a/pybamm/solvers/c_solvers/__init__.py b/pybamm/solvers/c_solvers/__init__.py index a9a2c5b3bb..e69de29bb2 100644 --- a/pybamm/solvers/c_solvers/__init__.py +++ b/pybamm/solvers/c_solvers/__init__.py @@ -1 +0,0 @@ -__all__ = [] From d87955be420052391a621c4938a976011bc048ac Mon Sep 17 00:00:00 2001 From: "arjxn.py" Date: Mon, 13 May 2024 21:13:54 +0530 Subject: [PATCH 4/4] Fix breaking import --- pybamm/models/submodels/transport_efficiency/__init__.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pybamm/models/submodels/transport_efficiency/__init__.py b/pybamm/models/submodels/transport_efficiency/__init__.py index d3cd7c048e..3c084c4c47 100644 --- a/pybamm/models/submodels/transport_efficiency/__init__.py +++ b/pybamm/models/submodels/transport_efficiency/__init__.py @@ -1,5 +1,4 @@ from .base_transport_efficiency import BaseModel -from .bruggeman_transport_efficiency import Bruggeman from .bruggeman import Bruggeman from .cation_exchange_membrane import CationExchangeMembrane from .heterogeneous_catalyst import HeterogeneousCatalyst @@ -9,6 +8,6 @@ from .random_overlapping_cylinders import RandomOverlappingCylinders from .tortuosity_factor import TortuosityFactor -__all__ = ['base_transport_efficiency', 'bruggeman_transport_efficiency', 'bruggeman', 'cation_exchange_membrane', +__all__ = ['base_transport_efficiency', 'bruggeman', 'cation_exchange_membrane', 'heterogeneous_catalyst', 'hyperbola_of_revolution', 'ordered_packing', 'overlapping_spheres', 'random_overlapping_cylinders', 'tortuosity_factor']