Spaces:
Sleeping
Sleeping
| <html class="writer-html5" lang="en" data-content_root="./"> | |
| <head> | |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| <title>streamlit_src.controllers package — Air Quality Forecast documentation</title> | |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" /> | |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> | |
| <script src="_static/jquery.js?v=5d32c60e"></script> | |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> | |
| <script src="_static/documentation_options.js?v=5929fcd5"></script> | |
| <script src="_static/doctools.js?v=9bcbadda"></script> | |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> | |
| <script src="_static/js/theme.js"></script> | |
| <link rel="index" title="Index" href="genindex.html" /> | |
| <link rel="search" title="Search" href="search.html" /> | |
| <link rel="next" title="streamlit_src.views package" href="streamlit_src.views.html" /> | |
| <link rel="prev" title="streamlit_src package" href="streamlit_src.html" /> | |
| </head> | |
| <body class="wy-body-for-nav"> | |
| <div class="wy-grid-for-nav"> | |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> | |
| <div class="wy-side-scroll"> | |
| <div class="wy-side-nav-search" > | |
| <a href="index.html" class="icon icon-home"> | |
| Air Quality Forecast | |
| </a> | |
| <div role="search"> | |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> | |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> | |
| <input type="hidden" name="check_keywords" value="yes" /> | |
| <input type="hidden" name="area" value="default" /> | |
| </form> | |
| </div> | |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> | |
| <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> | |
| <ul class="current"> | |
| <li class="toctree-l1 current"><a class="reference internal" href="modules.html">air-quality-forecast</a><ul class="current"> | |
| <li class="toctree-l2"><a class="reference internal" href="air_quality_forecast.html">air_quality_forecast package</a></li> | |
| <li class="toctree-l2 current"><a class="reference internal" href="streamlit_src.html">streamlit_src package</a><ul class="current"> | |
| <li class="toctree-l3 current"><a class="reference internal" href="streamlit_src.html#subpackages">Subpackages</a><ul class="current"> | |
| <li class="toctree-l4 current"><a class="current reference internal" href="#">streamlit_src.controllers package</a></li> | |
| <li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html">streamlit_src.views package</a></li> | |
| <li class="toctree-l4"><a class="reference internal" href="streamlit_src.models.html">streamlit_src.models package</a></li> | |
| </ul> | |
| </li> | |
| <li class="toctree-l3"><a class="reference internal" href="streamlit_src.html#submodules">Submodules</a></li> | |
| <li class="toctree-l3"><a class="reference internal" href="streamlit_src.html#module-streamlit_src.app">streamlit_src.app module</a></li> | |
| <li class="toctree-l3"><a class="reference internal" href="streamlit_src.html#module-streamlit_src">Module contents</a></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| </div> | |
| </nav> | |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > | |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | |
| <a href="index.html">Air Quality Forecast</a> | |
| </nav> | |
| <div class="wy-nav-content"> | |
| <div class="rst-content"> | |
| <div role="navigation" aria-label="Page navigation"> | |
| <ul class="wy-breadcrumbs"> | |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> | |
| <li class="breadcrumb-item"><a href="modules.html">air-quality-forecast</a></li> | |
| <li class="breadcrumb-item"><a href="streamlit_src.html">streamlit_src package</a></li> | |
| <li class="breadcrumb-item active">streamlit_src.controllers package</li> | |
| <li class="wy-breadcrumbs-aside"> | |
| <a href="_sources/streamlit_src.controllers.rst.txt" rel="nofollow"> View page source</a> | |
| </li> | |
| </ul> | |
| <hr/> | |
| </div> | |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | |
| <div itemprop="articleBody"> | |
| <section id="streamlit-src-controllers-package"> | |
| <h1>streamlit_src.controllers package<a class="headerlink" href="#streamlit-src-controllers-package" title="Link to this heading">ο</a></h1> | |
| <section id="submodules"> | |
| <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">ο</a></h2> | |
| </section> | |
| <section id="module-streamlit_src.controllers.admin_controller"> | |
| <span id="streamlit-src-controllers-admin-controller-module"></span><h2>streamlit_src.controllers.admin_controller module<a class="headerlink" href="#module-streamlit_src.controllers.admin_controller" title="Link to this heading">ο</a></h2> | |
| <dl class="py class"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController"> | |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">streamlit_src.controllers.admin_controller.</span></span><span class="sig-name descname"><span class="pre">AdminController</span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController" title="Link to this definition">ο</a></dt> | |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">UserController</span></code></p> | |
| <p>A class to handle the admin interface. Inherits from UserController</p> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._check_data_out_of_distribution"> | |
| <span class="sig-name descname"><span class="pre">_check_data_out_of_distribution</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">threshold</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">3</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._check_data_out_of_distribution"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._check_data_out_of_distribution" title="Link to this definition">ο</a></dt> | |
| <dd><p>Checks if the input data is out of distribution compared to the training data. | |
| Displays which features exceed the threshold.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> | |
| <dd class="field-odd"><ul class="simple"> | |
| <li><p><strong>data</strong> (<em>pd.DataFrame</em>) β The new input data to validate.</p></li> | |
| <li><p><strong>threshold</strong> (<em>float</em>) β The Z-score threshold to determine out of distribution.</p></li> | |
| </ul> | |
| </dd> | |
| <dt class="field-even">Returns<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>True if the input data is out of distribution, False otherwise.</p> | |
| </dd> | |
| <dt class="field-odd">Return type<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>bool</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._compute_distribution_statistics"> | |
| <span class="sig-name descname"><span class="pre">_compute_distribution_statistics</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">DataFrame</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">DataFrame</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._compute_distribution_statistics"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._compute_distribution_statistics" title="Link to this definition">ο</a></dt> | |
| <dd><p>Computes the means and standard deviations of the features in the dataset.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p><dl class="simple"> | |
| <dt>A tuple of two DataFrames. The first DataFrame contains the means of the features</dt><dd><p>and the second DataFrame contains the standard deviations of the features.</p> | |
| </dd> | |
| </dl> | |
| </p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._data_is_valid"> | |
| <span class="sig-name descname"><span class="pre">_data_is_valid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._data_is_valid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._data_is_valid" title="Link to this definition">ο</a></dt> | |
| <dd><p>Performs data validation on the uploaded user data.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p><strong>data</strong> (<em>pd.DataFrame</em>) β The user data.</p> | |
| </dd> | |
| <dt class="field-even">Returns<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>True if the data is valid, otherwise False.</p> | |
| </dd> | |
| <dt class="field-odd">Return type<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>bool</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._feature_importance"> | |
| <span class="sig-name descname"><span class="pre">_feature_importance</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._feature_importance"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._feature_importance" title="Link to this definition">ο</a></dt> | |
| <dd><p>Retrieves the feature importance values and their corresponding feature names.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>A tuple containing the feature names and their importance values.</p> | |
| </dd> | |
| <dt class="field-even">Return type<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>Tuple[list, list]</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._make_custom_predictions"> | |
| <span class="sig-name descname"><span class="pre">_make_custom_predictions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._make_custom_predictions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._make_custom_predictions" title="Link to this definition">ο</a></dt> | |
| <dd><p>Makes a custom prediction for the admin interface.</p> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._make_prediction"> | |
| <span class="sig-name descname"><span class="pre">_make_prediction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._make_prediction"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._make_prediction" title="Link to this definition">ο</a></dt> | |
| <dd><p>Makes a prediction using an XGBoost model.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p><strong>data</strong> (<em>pd.DataFrame</em>) β The data to make the prediction on.</p> | |
| </dd> | |
| <dt class="field-even">Returns<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>The prediction.</p> | |
| </dd> | |
| <dt class="field-odd">Return type<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>pd.DataFrame</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._model_metrics"> | |
| <span class="sig-name descname"><span class="pre">_model_metrics</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._model_metrics"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._model_metrics" title="Link to this definition">ο</a></dt> | |
| <dd><p>Computes the metrics for the admin interface.</p> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._show_current_data"> | |
| <span class="sig-name descname"><span class="pre">_show_current_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._show_current_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._show_current_data" title="Link to this definition">ο</a></dt> | |
| <dd><p>Shows the current data on the main page of the user interface.</p> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController.show_dashboard"> | |
| <span class="sig-name descname"><span class="pre">show_dashboard</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController.show_dashboard"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController.show_dashboard" title="Link to this definition">ο</a></dt> | |
| <dd><p>Shows the main page of the admin interface.</p> | |
| </dd></dl> | |
| </dd></dl> | |
| </section> | |
| <section id="module-streamlit_src.controllers.home_controller"> | |
| <span id="streamlit-src-controllers-home-controller-module"></span><h2>streamlit_src.controllers.home_controller module<a class="headerlink" href="#module-streamlit_src.controllers.home_controller" title="Link to this heading">ο</a></h2> | |
| <dl class="py class"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.home_controller.HomeController"> | |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">streamlit_src.controllers.home_controller.</span></span><span class="sig-name descname"><span class="pre">HomeController</span></span><a class="reference internal" href="_modules/streamlit_src/controllers/home_controller.html#HomeController"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.home_controller.HomeController" title="Link to this definition">ο</a></dt> | |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> | |
| <p>Handles the logic for the home page, including switching between user and admin views.</p> | |
| <p>The home page is the main entry point for the Streamlit application. | |
| It contains a text input for the admin password, which is hashed and compared to the stored hash. | |
| If the password is correct, the user is logged in as an admin and the admin view is displayed. | |
| Otherwise, the user view is displayed.</p> | |
| <dl class="py attribute"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.home_controller.HomeController.__ADMIN_PASSWORD_HASH"> | |
| <span class="sig-name descname"><span class="pre">__ADMIN_PASSWORD_HASH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'240be518fabd2724ddb6f04eeb1da5967448d7e831c08c8fa822809f74c720a9'</span></em><a class="headerlink" href="#streamlit_src.controllers.home_controller.HomeController.__ADMIN_PASSWORD_HASH" title="Link to this definition">ο</a></dt> | |
| <dd></dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.home_controller.HomeController._hash_password"> | |
| <span class="sig-name descname"><span class="pre">_hash_password</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/home_controller.html#HomeController._hash_password"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.home_controller.HomeController._hash_password" title="Link to this definition">ο</a></dt> | |
| <dd><p>Hash the input password using SHA-256.</p> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.home_controller.HomeController._run"> | |
| <span class="sig-name descname"><span class="pre">_run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/home_controller.html#HomeController._run"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.home_controller.HomeController._run" title="Link to this definition">ο</a></dt> | |
| <dd><p>Runs the application logic for the home page.</p> | |
| <p>This method is responsible for rendering the home page and | |
| handling the userβs choice of whether to view the user dashboard | |
| or admin dashboard. If the user chooses to view the admin dashboard, | |
| the user is prompted to enter the admin password. If the password | |
| is valid, the user is logged in as an admin and the admin dashboard | |
| is displayed. If the password is invalid, the user is logged out and | |
| the user dashboard is displayed.</p> | |
| </dd></dl> | |
| </dd></dl> | |
| </section> | |
| <section id="module-streamlit_src.controllers.user_controller"> | |
| <span id="streamlit-src-controllers-user-controller-module"></span><h2>streamlit_src.controllers.user_controller module<a class="headerlink" href="#module-streamlit_src.controllers.user_controller" title="Link to this heading">ο</a></h2> | |
| <dl class="py class"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController"> | |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">streamlit_src.controllers.user_controller.</span></span><span class="sig-name descname"><span class="pre">UserController</span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController" title="Link to this definition">ο</a></dt> | |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> | |
| <p>A class to handle the user interface.</p> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._compare_to_who"> | |
| <span class="sig-name descname"><span class="pre">_compare_to_who</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._compare_to_who"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._compare_to_who" title="Link to this definition">ο</a></dt> | |
| <dd><p>Compare the current pollutant levels to WHO guidelines.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>A list of tuples containing the pollutant name, comparison message, and message type.</p> | |
| </dd> | |
| <dt class="field-even">Return type<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>list</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._create_gauge_plot"> | |
| <span class="sig-name descname"><span class="pre">_create_gauge_plot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guideline</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Figure</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._create_gauge_plot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._create_gauge_plot" title="Link to this definition">ο</a></dt> | |
| <dd><p>Create a gauge plot for a given pollutant value and guideline.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> | |
| <dd class="field-odd"><ul class="simple"> | |
| <li><p><strong>value</strong> (<em>float</em>) β The pollutant concentration value.</p></li> | |
| <li><p><strong>guideline</strong> (<em>float</em>) β The WHO guideline value for the pollutant.</p></li> | |
| <li><p><strong>title</strong> (<em>str</em>) β The title of the gauge plot.</p></li> | |
| </ul> | |
| </dd> | |
| <dt class="field-even">Returns<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>A Plotly figure representing the gauge plot.</p> | |
| </dd> | |
| <dt class="field-odd">Return type<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>go.Figure</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._display_compare_who"> | |
| <span class="sig-name descname"><span class="pre">_display_compare_who</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._display_compare_who"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._display_compare_who" title="Link to this definition">ο</a></dt> | |
| <dd><p>Displays the WHO comparison on the main page of the user interface.</p> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._display_plots"> | |
| <span class="sig-name descname"><span class="pre">_display_plots</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._display_plots"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._display_plots" title="Link to this definition">ο</a></dt> | |
| <dd><p>Displays the plots on the main page of the user interface.</p> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._display_sources"> | |
| <span class="sig-name descname"><span class="pre">_display_sources</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._display_sources"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._display_sources" title="Link to this definition">ο</a></dt> | |
| <dd><p>Displays the sources on the main page of the user interface.</p> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._get_color"> | |
| <span class="sig-name descname"><span class="pre">_get_color</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">who_limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._get_color"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._get_color" title="Link to this definition">ο</a></dt> | |
| <dd><p>Calculate a color based on a given pollutant value and WHO guideline.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> | |
| <dd class="field-odd"><ul class="simple"> | |
| <li><p><strong>value</strong> (<em>float</em>) β The pollutant concentration value.</p></li> | |
| <li><p><strong>who_limit</strong> (<em>float</em>) β The WHO guideline value for the pollutant.</p></li> | |
| </ul> | |
| </dd> | |
| <dt class="field-even">Returns<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>A hex color code representing the calculated color.</p> | |
| </dd> | |
| <dt class="field-odd">Return type<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>str</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._get_next_three_days_dates"> | |
| <span class="sig-name descname"><span class="pre">_get_next_three_days_dates</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._get_next_three_days_dates"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._get_next_three_days_dates" title="Link to this definition">ο</a></dt> | |
| <dd><p>Get the next three daysβ dates.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>A tuple of three date objects.</p> | |
| </dd> | |
| <dt class="field-even">Return type<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>tuple</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._is_current_data_available"> | |
| <span class="sig-name descname"><span class="pre">_is_current_data_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._is_current_data_available"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._is_current_data_available" title="Link to this definition">ο</a></dt> | |
| <dd><p>Checks if the current data is available.</p> | |
| <p>The current data is not available from 00:00 to 04:15. | |
| This is because the API is queried every 15 minutes, and the | |
| data is not available for a short period of time before and after | |
| the new data is fetched.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>True if the current data is available, False otherwise.</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._prepare_awareness_content"> | |
| <span class="sig-name descname"><span class="pre">_prepare_awareness_content</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._prepare_awareness_content"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._prepare_awareness_content" title="Link to this definition">ο</a></dt> | |
| <dd><p>Prepare awareness content including a random fact, expanders, and health message based on air quality data.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>A tuple containing the random fact, awareness expanders, and health message.</p> | |
| </dd> | |
| <dt class="field-even">Return type<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>Tuple[str, List[Tuple[str, str]], Dict[str, str]]</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._prepare_data_for_view"> | |
| <span class="sig-name descname"><span class="pre">_prepare_data_for_view</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._prepare_data_for_view"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._prepare_data_for_view" title="Link to this definition">ο</a></dt> | |
| <dd><p>Prepares the current data for the view.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>The current data in a pandas DataFrame.</p> | |
| </dd> | |
| <dt class="field-even">Return type<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>pd.DataFrame</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._prepare_gauge_plots"> | |
| <span class="sig-name descname"><span class="pre">_prepare_gauge_plots</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._prepare_gauge_plots"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._prepare_gauge_plots" title="Link to this definition">ο</a></dt> | |
| <dd><p>Prepare gauge plots for the next three daysβ NO2 and O3 levels.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>A list of tuples containing the day index, formatted date, and two plotly figures (for NO2 and O3).</p> | |
| </dd> | |
| <dt class="field-even">Return type<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>list</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._prepare_line_plot"> | |
| <span class="sig-name descname"><span class="pre">_prepare_line_plot</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Figure</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._prepare_line_plot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._prepare_line_plot" title="Link to this definition">ο</a></dt> | |
| <dd><p>Prepare a line plot for the next three daysβ NO2 and O3 levels.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>A plotly figure object.</p> | |
| </dd> | |
| <dt class="field-even">Return type<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>go.Figure</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._quiz"> | |
| <span class="sig-name descname"><span class="pre">_quiz</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._quiz"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._quiz" title="Link to this definition">ο</a></dt> | |
| <dd><p>Show a _quiz question and return the answer and whether the answer was correct.</p> | |
| <dl class="field-list simple"> | |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>A tuple containing the answer and a boolean indicating whether the answer was correct.</p> | |
| </dd> | |
| <dt class="field-even">Return type<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>tuple</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._raise_awareness"> | |
| <span class="sig-name descname"><span class="pre">_raise_awareness</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._raise_awareness"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._raise_awareness" title="Link to this definition">ο</a></dt> | |
| <dd><p>Shows the awareness content on the main page of the user interface.</p> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._show_current_data"> | |
| <span class="sig-name descname"><span class="pre">_show_current_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._show_current_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._show_current_data" title="Link to this definition">ο</a></dt> | |
| <dd><p>Shows the current data on the main page of the user interface.</p> | |
| </dd></dl> | |
| <dl class="py method"> | |
| <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController.show_dashboard"> | |
| <span class="sig-name descname"><span class="pre">show_dashboard</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController.show_dashboard"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController.show_dashboard" title="Link to this definition">ο</a></dt> | |
| <dd><p>Shows the main page of the user interface.</p> | |
| </dd></dl> | |
| </dd></dl> | |
| </section> | |
| <section id="module-streamlit_src.controllers"> | |
| <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-streamlit_src.controllers" title="Link to this heading">ο</a></h2> | |
| </section> | |
| </section> | |
| </div> | |
| </div> | |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> | |
| <a href="streamlit_src.html" class="btn btn-neutral float-left" title="streamlit_src package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | |
| <a href="streamlit_src.views.html" class="btn btn-neutral float-right" title="streamlit_src.views package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> | |
| </div> | |
| <hr/> | |
| <div role="contentinfo"> | |
| <p>© Copyright 2024, Aleksandar Todorov, Christian Kobriger, Lukasz Sawala, Csenge Szoke.</p> | |
| </div> | |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a | |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> | |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. | |
| </footer> | |
| </div> | |
| </div> | |
| </section> | |
| </div> | |
| <script> | |
| jQuery(function () { | |
| SphinxRtdTheme.Navigation.enable(true); | |
| }); | |
| </script> | |
| </body> | |
| </html> | |