Skip to content

Commit

Permalink
Hermes page updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
izzet committed Nov 16, 2023
1 parent 57c9d9a commit d77a0d7
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 14 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Main Scenario

:::info

Hermes **1.1.0** is now available! [Download now](https://github.com/HDFGroup/hermes/releases) for the latest features and improvements. For more information, visit the [Hermes project page](/research/projects/hermes).

:::

![Deep Distributed Storage Hierarchy (DDSH)](images/Hermes_hierachy.jpg)

Consider an HPC cluster equipped with a deep, distributed [storage
Expand Down
23 changes: 11 additions & 12 deletions docs/03-hermes/07-adapters.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Adapters

[[../images/Hermes_Ecosystem.jpg|Hermes Adapters]]
![Hermes Ecosystem](images/Hermes_Ecosystem.jpg)

Instead of the [Hermes primitives](05-programming.md), existing applications
use I/O libraries and middleware such as the C standard I/O library,
Expand All @@ -9,10 +9,9 @@ buffering solution, a set of _adapters_ is provided in the form of
`LD_PRELOAD`-able shared libraries. These adapters perform the task of
mapping between the application view of I/O primitives (e.g., files)
and the Hermes primitives. An exemplary discussion of such mappings
can be found in [_Enosis: Bridging the Semantic Gap between File-based
and Object-based Data Models_](http://www.cs.iit.edu/~scs/assets/files/Enosis.pdf) and
[_Syndesis: Mapping Objects to Files for a Unified Data Access
System_](http://www.cs.iit.edu/~scs/assets/files/Syndesis.pdf).
can be found in [Enosis: Bridging the Semantic Gap between File-based
and Object-based Data Models](http://www.cs.iit.edu/~scs/assets/files/Enosis.pdf) and [Syndesis: Mapping Objects to Files for a Unified Data Access
System](http://www.cs.iit.edu/~scs/assets/files/Syndesis.pdf).

Another important task of Hermes adapters is to collect I/O profiling
that supports the detection of I/O patterns.
Expand Down Expand Up @@ -69,7 +68,7 @@ The PubSub adapter for Hermes stands a bit different from other adapters due to

A simple example of, one of, the ZeroMQ C++ API.

```
```cpp
#include <string>
#include <zmq.hpp>
int main()
Expand All @@ -84,7 +83,7 @@ int main()

And an example of the Kafka C++ API.

```
```cpp
#include "kafka/KafkaProducer.h"
#include <iostream>
#include <string>
Expand Down Expand Up @@ -114,7 +113,7 @@ In all functions `hapi` stands for objects under the `hermes::api` namespace.
#### `connect`
```
```cpp
hapi::Status connect(const std::string &config_file);
hapi::Status connect();
- Connects to the Hermes instance
Expand All @@ -124,15 +123,15 @@ hapi::Status connect();

#### `attach`

```
```cpp
hapi::Status attach(const std::string& topic);
- Attaches to a topic, creating it if it doesn't exist
- topic: The name of the topic
```
#### `detach`
```
```cpp
hapi::Status detach(const std::string& topic);
- Detaches from the topic cleaning up all client-local metadata
- topic: The name of the topic
Expand All @@ -141,7 +140,7 @@ hapi::Status detach(const std::string& topic);

#### `publish`

```
```cpp
hapi::Status publish(const std::string& topic, const std::vector<unsigned char>& message);
- Puts a message to a topic
- topic: The name of the topic
Expand All @@ -151,7 +150,7 @@ hapi::Status publish(const std::string& topic, const std::vector<unsigned char>
#### `subscribe`
```
```cpp
std::pair<std::vector<unsigned char>, hapi::Status> subscribe( const std::string& topic);
- Retrieves the next message from the topic
- topic: The name of the topic
Expand Down
5 changes: 4 additions & 1 deletion docs/03-hermes/_category_.yml
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
label: "Hermes"
label: "Hermes"
link:
type: generated-index
description: "Hermes is a middeware library that automatically manages buffering in heterogeneous storage environments."
2 changes: 1 addition & 1 deletion src/pages/research/projects/hermes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ environments.

:::info

Hermes **1.1.0** is now available! [Download now](https://github.com/HDFGroup/hermes/releases) for the latest features and improvements. For more information, visit our [release notes](https://github.com/HDFGroup/hermes/releases/tag/v1.1.0).
Hermes **1.1.0** is now available! [Download now](https://github.com/HDFGroup/hermes/releases) for the latest features and improvements.

:::

Expand Down

0 comments on commit d77a0d7

Please sign in to comment.