Module pyaurorax.models

Interact with various auroral models, such as the TREx Auroral Transport Model (ATM).

Sub-modules

pyaurorax.models.atm

Classes

class ModelsManager (aurorax_obj)

Expand source code

class ModelsManager:
    """
    The ModelsManager object is initialized within every PyAuroraX object. It acts as a way to access 
    the submodules and carry over configuration information in the super class.
    """

    def __init__(self, aurorax_obj):
        self.__aurorax_obj = aurorax_obj

        # initialize sub-modules
        self.__atm = ATMManager(self.__aurorax_obj)

    # ------------------------------------------
    # properties for submodule managers
    # ------------------------------------------
    @property
    def atm(self):
        """
        Access to the `atm` submodule from within a PyAuroraX object.
        """
        return self.__atm

The ModelsManager object is initialized within every PyAuroraX object. It acts as a way to access the submodules and carry over configuration information in the super class.

Instance variables

prop atm

Expand source code

@property
def atm(self):
    """
    Access to the `atm` submodule from within a PyAuroraX object.
    """
    return self.__atm

Access to the pyaurorax.models.atm submodule from within a PyAuroraX object.