Skip to content

Commit 13f16a8

Browse files
committed
Add a pointer to the REST API
1 parent 6500b3e commit 13f16a8

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

README-PUBSUB.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# The Publisher-Subscriber Model in Caterva2
2-
This functionality is in alpha mode, and is not yet available in the main branch of Caterva2. If you are interested in testing it, please contact the Caterva2 team.
3-
# =============================
4-
Caterva2 also offers the possibility of using the publisher-subscriber (pub-sub) message pattern. Under this framework, when a user uses a client (Web API, Python API or command line) to query datasets, the client will connect to a Caterva2 **subscriber** service, which in turn will communicate with the associated **publishers** to which it is subscribed, to retrieve the requested datasets. This subscriber/publisher interaction is mediated by a **broker** service.
2+
**Note**: this functionality is in alpha stage. If you are interested in testing it, please contact the Caterva2 team.
3+
4+
Caterva2 offers the possibility of using the publisher-subscriber (pub-sub) message pattern. Under this framework, when a user uses a client (Web API, Python API or command line) to query datasets, the client will connect to a Caterva2 **subscriber** service, which in turn will communicate with the associated **publishers** to which it is subscribed, to retrieve the requested datasets. This subscriber/publisher interaction is mediated by a **broker** service.
55

66
In order to set up a Caterva2 deployment to enable the publisher-subscriber model on your system, you will thus need the following components:
77

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ The Python API is the recommended way for building your own Caterva2 clients, wh
2525
The main role of the Caterva2 package is to provide a simple and lightweight library to build your own Caterva2 clients. The variety of interfaces available allows you to choose the one that best fits your needs. For example, querying a dataset from source can be accomplished :
2626
- Via the [Web API](https://ironarray.io/caterva2-doc/tutorials/web-client.html) using a browser <img src="./doc/_static/web-data-view.png" alt="Figure: Web data browser and viewer" width="100%"/>
2727
- Via the [Python API](https://ironarray.io/caterva2-doc/tutorials/API.html)
28+
- Via the [REST API](https://cat2.cloud/demo/docs) using a REST client like [Postman](https://www.postman.com/) or [curl](https://curl.se/)
2829
```
2930
client = cat2.Client("https://cat2.cloud/demo")
3031
client.get("@public/examples/tomo-guess-test.b2nd")

0 commit comments

Comments
 (0)