Merge pull request #228 from lucasimi/add-nicegui-app

Add nicegui app

Author: lucasimi

.github/workflows/test-bench.yml

@@ -49,7 +49,7 @@ jobs:
 
       - name: Install dependencies
         run: | 
-          python -m pip install -e .[dev]
+          python -m pip install -e .[dev,app]
 
       - name: Run benchmarks
         run: | 

.github/workflows/test-unit.yml

@@ -49,7 +49,7 @@ jobs:
 
       - name: Install dependencies
         run: | 
-          python -m pip install -e .[dev]
+          python -m pip install -e .[dev,app]
 
       - name: Run tests and code coverage
         run: | 

README.md

@@ -45,9 +45,9 @@ and in the
 
 - **Interactive app**
 
-    Provides an interactive web-based interface (via Streamlit) for dynamic
-    exploration of Mapper graph structures, offering real-time adjustments to
-    parameters and visualizations.
+    Provides an interactive web-based interface for dynamic exploration of
+    Mapper graph structures, offering real-time adjustments to parameters and
+    visualizations.
 
 ## Background
 
@@ -138,21 +138,23 @@ More examples can be found in the
 
 ## Interactive App
 
-Use our Streamlit app to visualize and explore your data without writing code.
-You can run a live demo directly on
-[Streamlit Cloud](https://tda-mapper-app.streamlit.app/),
-or locally on your machine. The first time you run the app locally, you may
-need to install the required dependencies from the `requirements.txt` file by
-running 
+Use our app to interactively visualize and explore your data without writing
+code. You can try it right away using 
+[our live demo](https://tda-mapper-app.up.railway.app/),
+or run it locally on your machine.
 
-```bash
-pip install -r app/requirements.txt
-```
+To run it locally:
 
-then run the app locally with 
+1. Install the app and its dependencies:
 
-```bash
-streamlit run app/streamlit_app.py
-```
+    ```bash
+    pip install tda-mapper[app]
+    ```
+
+2. Launch the app:
+
+    ```bash
+    tda-mapper-app
+    ```
 
 ![tda-mapper-app](https://github.com/lucasimi/tda-mapper-python/raw/main/resources/tda-mapper-app.png)

app/streamlit_app.py

@@ -959,4 +959,14 @@ def main():
     st.markdown(FOOTER)
 
 
-main()
+def redirect():
+    st.markdown(
+        """
+        ## 🚨 Notice: This app is no longer not maintained and will be removed soon.
+
+        ### 👉 To continue using the service, please switch to the [new, updated version](https://tda-mapper-app.up.railway.app/).
+        """
+    )
+
+
+redirect()

docs/source/index.rst

@@ -14,8 +14,6 @@
    :target: https://codecov.io/github/lucasimi/tda-mapper-python
 .. |DOI| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.10642381-blue?logo=doi&logoColor=silver
    :target: https://doi.org/10.5281/zenodo.10642381
-.. |Streamlit App| image:: https://img.shields.io/badge/Streamlit-App-blue?logo=streamlit&logoColor=silver
-   :target: https://tda-mapper-app.streamlit.app/
 .. |Step 1| image:: https://github.com/lucasimi/tda-mapper-python/raw/main/resources/mapper_1.png
 .. |Step 2| image:: https://github.com/lucasimi/tda-mapper-python/raw/main/resources/mapper_2.png
 .. |Step 3| image:: https://github.com/lucasimi/tda-mapper-python/raw/main/resources/mapper_3.png
@@ -68,9 +66,9 @@ Core features
 
 - **Interactive app**
 
-   Provides an interactive web-based interface (via Streamlit) for dynamic
-   exploration of Mapper graph structures, offering real-time adjustments to
-   parameters and visualizations.
+   Provides an interactive web-based interface for dynamic exploration of
+   Mapper graph structures, offering real-time adjustments to parameters and
+   visualizations.
 
 
 Background

docs/source/quickstart.rst

@@ -92,27 +92,24 @@ More examples can be found in the
 Interactive App
 ---------------
 
-Use our Streamlit app to visualize and explore your data without writing code.
-You can run a live demo directly on
-`Streamlit Cloud <https://tda-mapper-app.streamlit.app/>`__,
-or locally on your machine using the following:
-
-Use our Streamlit app to visualize and explore your data without writing code.
-You can run a live demo directly on
-`Streamlit Cloud <https://tda-mapper-app.streamlit.app/>`__,
-or locally on your machine. The first time you run the app locally, you may
-need to install the required dependencies from the `requirements.txt` file by
-running
+Use our app to interactively visualize and explore your data without writing
+code. You can try it right away using 
+`our live demo <https://tda-mapper-app.up.railway.app/>`__,
+or run it locally on your machine.
 
-.. code:: bash
+To run it locally:
 
-   pip install -r app/requirements.txt
+1. Install the app and its dependencies:
 
-then run the app locally with 
+   .. code:: bash
 
-.. code:: bash
+      pip install tda-mapper[app]
+
+2. Launch the app:
+
+   .. code:: bash
 
-   streamlit run app/streamlit_app.py
+      tda-mapper-app
 
 |Interactive App|
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tda-mapper"
-version = "0.11.2"
+version = "0.12.0"
 description = "A simple and efficient Python implementation of Mapper algorithm for Topological Data Analysis"
 readme = "README.md"
 authors = [{ name = "Luca Simi", email = "[email protected]" }]
@@ -44,14 +44,25 @@ requires-python = ">=3.8"
 [project.optional-dependencies]
 dev = [
     "coverage[toml]",
-    "pandas",
+    "pandas<3.0.0",
     "scikit-learn<1.6.0",
     "pytest",
+    "pytest-asyncio",
     "black[jupyter]",
     "isort",
     "flake8",
+    "kaleido",
     "nbformat>=4.2.0",
 ]
+app = [
+    "pandas<3.0.0",
+    "scikit-learn<1.6.0",
+    "umap-learn<0.6.0",
+    "nicegui>=2.18.0,<3.0.0",
+]
+
+[project.scripts]
+tda-mapper-app = "tdamapper._run_app:run"
 
 [project.urls]
 Homepage = "https://github.com/lucasimi/tda-mapper-python"
@@ -88,3 +99,15 @@ include_trailing_comma = true
 force_grid_wrap = 0
 combine_as_imports = true
 skip = ["venv", ".venv", "build", "dist"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+asyncio_default_fixture_loop_scope = "function"
+filterwarnings = [
+  'ignore::DeprecationWarning:_plotly_utils\.basevalidators',
+]
+
+markers = [
+    "module_under_test",
+]

resources/tda-mapper-app.png

@@ -0,0 +1,9 @@
+from tdamapper.app import main
+
+
+def run():
+    main()
+
+
+if __name__ in {"__main__", "__mp_main__", "tdamapper._run_app"}:
+    run()