Skip to content

Commit 6fa656d

Browse files
committed
docs(README): update container information
1 parent 1e21e65 commit 6fa656d

File tree

2 files changed

+25
-33
lines changed

2 files changed

+25
-33
lines changed

README.rst

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -81,33 +81,29 @@ supported:
8181
container
8282
~~~~~~~~~
8383

84-
Two `marimo <https://github.com/marimo-team/marimo>`__ apps exist in
85-
``./marimos``, ``validation.py`` and ``network.py``. These are both
86-
included in the ``ghcr.io/nialov/fractopo-app:latest`` image. By
87-
default, when the image is run, the network analysis app is run. To run
88-
the validation app, add an environment variable ``RUN_MODE`` to the
89-
container with a value of ``validation``.
84+
A `marimo <https://github.com/marimo-team/marimo>`__ +
85+
`FastAPI <https://github.com/fastapi/fastapi>`__ app exists in
86+
``./marimos``, ``api.py``. This is included in the
87+
``ghcr.io/nialov/fractopo-app:latest`` image. By default, when the image
88+
is run, the network analysis app is run accessible at root (``/``). To
89+
access validation functinality, use path ``/validation``. Network
90+
analysis is also available at ``/network``.
9091

9192
The app host and port can be chosen with ``HOST`` (default is
9293
``0.0.0.0``) and ``PORT`` (default is ``2718``) environment variables.
9394
With ``docker`` you can, of course, expose in whichever port you choose.
9495

9596
Example ``docker`` invocations are below.
9697

97-
To run network analysis:
98+
To run app:
9899

99100
.. code:: bash
100101
101-
# RUN_MODE=network specified explicitly even if it is the default
102-
docker run --rm --interactive --tty --publish 2718:2718 --env RUN_MODE=network ghcr.io/nialov/fractopo-app:latest
102+
docker run --rm --interactive --tty --publish 2718:2718 ghcr.io/nialov/fractopo-app:latest
103103
104-
To run validation:
105-
106-
.. code:: bash
107-
108-
docker run --rm --interactive --tty --publish 2718:2718 --env RUN_MODE=validation ghcr.io/nialov/fractopo-app:latest
109-
110-
The app should be available at http://localhost:2718
104+
The network analysis functionality should be available at
105+
http://localhost:2718/network and validation functionality at
106+
http://localhost:2718/validation.
111107

112108
Usage
113109
-----

docs_src/index.rst

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -98,33 +98,29 @@ supported:
9898
container
9999
~~~~~~~~~
100100

101-
Two `marimo <https://github.com/marimo-team/marimo>`__ apps exist in
102-
``./marimos``, ``validation.py`` and ``network.py``. These are both
103-
included in the ``ghcr.io/nialov/fractopo-app:latest`` image. By
104-
default, when the image is run, the network analysis app is run. To run
105-
the validation app, add an environment variable ``RUN_MODE`` to the
106-
container with a value of ``validation``.
101+
A `marimo <https://github.com/marimo-team/marimo>`__ +
102+
`FastAPI <https://github.com/fastapi/fastapi>`__ app exists in
103+
``./marimos``, ``api.py``. This is included in the
104+
``ghcr.io/nialov/fractopo-app:latest`` image. By default, when the image
105+
is run, the network analysis app is run accessible at root (``/``). To
106+
access validation functinality, use path ``/validation``. Network
107+
analysis is also available at ``/network``.
107108

108109
The app host and port can be chosen with ``HOST`` (default is
109110
``0.0.0.0``) and ``PORT`` (default is ``2718``) environment variables.
110111
With ``docker`` you can, of course, expose in whichever port you choose.
111112

112113
Example ``docker`` invocations are below.
113114

114-
To run network analysis:
115+
To run app:
115116

116117
.. code:: bash
117118
118-
# RUN_MODE=network specified explicitly even if it is the default
119-
docker run --rm --interactive --tty --publish 2718:2718 --env RUN_MODE=network ghcr.io/nialov/fractopo-app:latest
119+
docker run --rm --interactive --tty --publish 2718:2718 ghcr.io/nialov/fractopo-app:latest
120120
121-
To run validation:
122-
123-
.. code:: bash
124-
125-
docker run --rm --interactive --tty --publish 2718:2718 --env RUN_MODE=validation ghcr.io/nialov/fractopo-app:latest
126-
127-
The app should be available at http://localhost:2718
121+
The network analysis functionality should be available at
122+
http://localhost:2718/network and validation functionality at
123+
http://localhost:2718/validation.
128124

129125
Usage
130126
-----
@@ -437,7 +433,7 @@ Copyright © 2020-2026, Nikolas Ovaskainen.
437433
:target: https://mybinder.org/v2/gh/nialov/fractopo/HEAD?filepath=docs_src%2Fnotebooks%2Ffractopo_network_1.ipynb
438434
.. |Zenodo| image:: https://zenodo.org/badge/297451015.svg
439435
:target: https://zenodo.org/badge/latestdoi/297451015
440-
.. [[[end]]] (checksum: 03b8bc905d987b2f0346263e2055bca2)
436+
.. [[[end]]] (checksum: 0fed91a430072b847114ba600a6aec78)
441437
442438
.. toctree::
443439
:hidden:

0 commit comments

Comments
 (0)