Adds __all__ to submodules recursively

pybamm/discretisations/__init__.py

@@ -0,0 +1 @@
+__all__ = ['discretisation']

pybamm/experiment/__init__.py

@@ -0,0 +1 @@
+__all__ = ['experiment', 'step']

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']

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']

pybamm/expression_tree/operations/__init__.py

@@ -0,0 +1,2 @@
+__all__ = ['convert_to_casadi', 'evaluate_python', 'jacobian', 'latexify',
+           'serialise', 'unpack_symbols']

pybamm/expression_tree/printing/__init__.py

@@ -0,0 +1 @@
+__all__ = ['print_name', 'sympy_overrides']

pybamm/geometry/__init__.py

@@ -0,0 +1 @@
+__all__ = ['battery_geometry', 'geometry', 'standard_spatial_vars']

pybamm/input/__init__.py

@@ -0,0 +1 @@
+__all__ = ['parameters']

pybamm/input/parameters/__init__.py

@@ -0,0 +1 @@
+__all__ = ['ecm', 'lead_acid', 'lithium_ion']

pybamm/input/parameters/ecm/__init__.py

@@ -0,0 +1 @@
+__all__ = ['example_set']

pybamm/input/parameters/lead_acid/__init__.py

@@ -0,0 +1 @@
+__all__ = ['Sulzer2019']

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']

pybamm/meshes/__init__.py

@@ -0,0 +1,2 @@
+__all__ = ['meshes', 'one_dimensional_submeshes', 'scikit_fem_submeshes',
+           'zero_dimensional_submesh']

pybamm/models/__init__.py

@@ -0,0 +1 @@
+__all__ = ['base_model', 'event', 'full_battery_models', 'submodels']

pybamm/models/full_battery_models/__init__.py

@@ -0,0 +1,2 @@
+__all__ = ['base_battery_model', 'equivalent_circuit', 'lead_acid',
+           'lithium_ion']

pybamm/models/full_battery_models/equivalent_circuit/__init__.py

@@ -1 +1,3 @@
 from .thevenin import *
+
+__all__ = ['ecm_model_options', 'thevenin']

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']

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']

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']

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']

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']

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']

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']

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']

pybamm/models/submodels/electrode/__init__.py

@@ -1,2 +1,4 @@
 from .base_electrode import BaseElectrode
 from . import ohm
+
+__all__ = ['base_electrode', 'ohm']

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']

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']

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']

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']

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']

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']

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']

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']

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']

pybamm/models/submodels/interface/kinetics/inverse_kinetics/__init__.py

@@ -0,0 +1 @@
+__all__ = ['inverse_butler_volmer']

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']

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']

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']

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']

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']

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']

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']

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']

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']

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']

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']

pybamm/plotting/__init__.py

@@ -0,0 +1,2 @@
+__all__ = ['dynamic_plot', 'plot', 'plot2D', 'plot_summary_variables',
+           'plot_thermal_components', 'plot_voltage_components', 'quick_plot']

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']

pybamm/solvers/c_solvers/__init__.py

@@ -0,0 +1 @@
+__all__ = []

pybamm/spatial_methods/__init__.py

@@ -0,0 +1,2 @@
+__all__ = ['finite_volume', 'scikit_finite_element', 'spatial_method',
+           'spectral_volume', 'zero_dimensional_method']