Skip to content

Commit 2b1c651

Browse files
committed
Fixed readme and docs. Added redirect
1 parent 85a9492 commit 2b1c651

5 files changed

Lines changed: 29 additions & 28 deletions

File tree

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ and in the
4545

4646
- **Interactive app**
4747

48-
Provides an interactive web-based interface (via Streamlit) for dynamic
49-
exploration of Mapper graph structures, offering real-time adjustments to
50-
parameters and visualizations.
48+
Provides an interactive web-based interface for dynamic exploration of
49+
Mapper graph structures, offering real-time adjustments to parameters and
50+
visualizations.
5151

5252
## Background
5353

@@ -138,21 +138,20 @@ More examples can be found in the
138138

139139
## Interactive App
140140

141-
Use our Streamlit app to visualize and explore your data without writing code.
142-
You can run a live demo directly on
143-
[Streamlit Cloud](https://tda-mapper-app.streamlit.app/),
141+
Use our app to visualize and explore your data without writing code. You can
142+
use it directly on
143+
[Our Demo App](https://tda-mapper-app.up.railway.app/),
144144
or locally on your machine. The first time you run the app locally, you may
145-
need to install the required dependencies from the `requirements.txt` file by
146-
running
145+
need to install the required dependencies by running
147146

148147
```bash
149-
pip install -r app/requirements.txt
148+
pip install tda-mapper[app]
150149
```
151150

152151
then run the app locally with
153152

154153
```bash
155-
streamlit run app/streamlit_app.py
154+
tda-mapper-app
156155
```
157156

158157
![tda-mapper-app](https://github.com/lucasimi/tda-mapper-python/raw/main/resources/tda-mapper-app.png)

app/streamlit_app.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -959,4 +959,14 @@ def main():
959959
st.markdown(FOOTER)
960960

961961

962-
main()
962+
def redirect():
963+
st.markdown(
964+
"""
965+
## 🚨 Notice: This app is no longer not maintained and will be removed soon.
966+
967+
### 👉 To continue using the service, please switch to the [new, updated version](https://tda-mapper-app.up.railway.app/).
968+
"""
969+
)
970+
971+
972+
redirect()

docs/source/index.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@
1414
:target: https://codecov.io/github/lucasimi/tda-mapper-python
1515
.. |DOI| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.10642381-blue?logo=doi&logoColor=silver
1616
:target: https://doi.org/10.5281/zenodo.10642381
17-
.. |Streamlit App| image:: https://img.shields.io/badge/Streamlit-App-blue?logo=streamlit&logoColor=silver
18-
:target: https://tda-mapper-app.streamlit.app/
1917
.. |Step 1| image:: https://github.com/lucasimi/tda-mapper-python/raw/main/resources/mapper_1.png
2018
.. |Step 2| image:: https://github.com/lucasimi/tda-mapper-python/raw/main/resources/mapper_2.png
2119
.. |Step 3| image:: https://github.com/lucasimi/tda-mapper-python/raw/main/resources/mapper_3.png
@@ -68,9 +66,9 @@ Core features
6866

6967
- **Interactive app**
7068

71-
Provides an interactive web-based interface (via Streamlit) for dynamic
72-
exploration of Mapper graph structures, offering real-time adjustments to
73-
parameters and visualizations.
69+
Provides an interactive web-based interface for dynamic exploration of
70+
Mapper graph structures, offering real-time adjustments to parameters and
71+
visualizations.
7472

7573

7674
Background

docs/source/quickstart.rst

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -92,27 +92,21 @@ More examples can be found in the
9292
Interactive App
9393
---------------
9494

95-
Use our Streamlit app to visualize and explore your data without writing code.
96-
You can run a live demo directly on
97-
`Streamlit Cloud <https://tda-mapper-app.streamlit.app/>`__,
98-
or locally on your machine using the following:
99-
100-
Use our Streamlit app to visualize and explore your data without writing code.
101-
You can run a live demo directly on
102-
`Streamlit Cloud <https://tda-mapper-app.streamlit.app/>`__,
95+
Use our app to visualize and explore your data without writing code. You can
96+
use it directly on
97+
`Our Demo App <https://tda-mapper-app.up.railway.app/>`__,
10398
or locally on your machine. The first time you run the app locally, you may
104-
need to install the required dependencies from the `requirements.txt` file by
105-
running
99+
need to install the required dependencies by running
106100

107101
.. code:: bash
108102
109-
pip install -r app/requirements.txt
103+
pip install tda-mapper[app]
110104
111105
then run the app locally with
112106

113107
.. code:: bash
114108
115-
streamlit run app/streamlit_app.py
109+
tda-mapper-app
116110
117111
|Interactive App|
118112

resources/tda-mapper-app.png

172 KB
Loading

0 commit comments

Comments
 (0)