Rework readme and add patchelf dependencies

README.md

@@ -2,176 +2,53 @@
     <img src="./docs/src/logo.svg" width="400">
 </p>
 
-<h3 align="center">
-Dataflow Oriented Robotic Architecture ⚡
-</h3>
 
----
-
-`dora` goal is to be a low latency, composable, and distributed data flow.
-
-This project is in early development, and many features have yet to be implemented with breaking changes. Please don't take for granted the current design.
-
-`dora` primary support is with `Linux` as it is the primary OS for both Cloud and small computers. If you wish to use `dora` with another OS, please compile from source.
-
----
-## 📖 Documentation
 
-The documentation can be found here: [https://dora-rs.github.io/dora/](https://dora-rs.github.io/dora/) 
+<h2 align="center">
+  <a href="https://dora.carsmos.ai">Website</a>
+  |
+  <a href="https://dora.carsmos.ai/docs/api/python-api">Python API</a>
+  -
+  <a href="https://docs.rs/dora-node-api/latest/dora_node_api/">Rust API</a>
+  |
+  <a href="https://dora.carsmos.ai/docs/guides/">Guide</a>
+  |
+  <a href="https://github.com/orgs/dora-rs/discussions">Discussion</a>
+</h2>
+
+<div align="center">
+  <a href="https://github.com/dora-rs/dora/actions">
+    <img src="https://github.com/dora-rs/dora/workflows/CI/badge.svg" alt="Build and test"/>
+  </a>
+  <a href="https://crates.io/crates/dora-rs">
+    <img src="https://img.shields.io/crates/v/dora_node_api.svg"/>
+  </a>
+  <a href="https://docs.rs/dora-node-api/latest/dora_node_api/">
+    <img src="https://docs.rs/dora-node-api/badge.svg" alt="rust docs"/>
+  </a>
+  <a href="https://pypi.org/project/dora-rs/">
+    <img src="https://img.shields.io/pypi/v/dora-rs.svg" alt="PyPi Latest Release"/>
+  </a>
+</div>
 
 ---
 
-## Getting started
-
-
-1. Install `dora` binaries from GitHub releases
-
-For linux
-```bash
-wget https://github.com/dora-rs/dora/releases/download/<version>/dora-<version>-x86_64-Linux.zip
-unzip dora-<version>-x86_64-Linux.zip
-python3 -m pip install dora-rs==<version>
-PATH=$PATH:$(pwd)
-dora --help
-```
-
-> This is `x86_64` only for the moment.
+In 2023, AI is booming! Robotic framework however hasn't changed much in years... This is why we create dora-rs! dora-rs is a new robotic framework that brings modernity into robotic application.
 
-2. Create a new dataflow
+## Why dora-rs?
 
-```bash
-dora new abc_project --lang python
-cd abc_project
-```
-
-This creates the following `abc_project` directory
-```bash
-.
-├── dataflow.yml
-├── node_1
-│   └── node_1.py
-├── op_1
-│   └── op_1.py
-└── op_2
-    └── op_2.py
-```
-
-3. Start `dora-coordinator` in a separate terminal window
-```bash
-# New terminal window
-dora up 
-```
-
-4. Start your dataflow
-```bash
-# Other window
-dora start dataflow.yml
-# Output: c95d118b-cded-4531-a0e4-cd85b7c3916c
-```
-The output is the unique ID of the dataflow instance, which can be used to control it through the `dora` CLI.
-
-5. You will see in your `dora-coordinator` window operators receiving ticks.
-```bash
-Received input tick, with data: b''
-Received input tick, with data: b''
-Received input tick, with data: b''
-...
-```
-
-6. Stop your dataflow
-```bash
-dora stop c95d118b-cded-4531-a0e4-cd85b7c3916c
-```
-(Pass the ID returned by `dora start` here.)
-
-7. You can then add or modify operators or nodes. For adding nodes easily, you can use the `dora` CLI again:
-
-- Run `dora new --kind operator --lang rust <name>` to create a new Rust operator named `<name>`.
-- Run `dora new --kind custom-node --lang rust <name>` to create a new custom node named `<name>`.
-
-You need to add the created operators/nodes to your dataflow YAML file.
-
-8. You can also download already implemented operators by putting links in the dataflow. This example will launch a webcam plot stream. 
-
-```yaml
-nodes:
-  - id: op_1
-    operator:
-      python: https://raw.githubusercontent.com/dora-rs/dora-drives/main/operators/webcam_op.py
-      inputs:
-        tick: dora/timer/millis/100
-      outputs:
-        - image
-  - id: op_2
-    operator:
-      python: https://raw.githubusercontent.com/dora-rs/dora-drives/main/physicals/plot.py
-      inputs:
-        image: op_1/image 
-```
-> Make sure to have a webcam and cv2 install via: `pip install opencv-python`
----
-
-## ✨ Features
-
-Composability as:
-- [x] `YAML` declarative programming
-- [x] Isolated operators and custom nodes that can be reused.
-- [x] Hot Reloading for Python Operators
-
-Low latency as:
-- [x] written in  <i>...Cough...blazingly fast ...Cough...</i> Rust.
-- [x] PubSub communication with shared memory!
-- [x] Zero-copy!
-
-Distributed as:
-- [ ] PubSub communication between machines with [`zenoh`](https://github.com/eclipse-zenoh/zenoh)
-- [x] Distributed telemetry with [`opentelemetry`](https://github.com/open-telemetry/opentelemetry-rust)
-
-## Support matrix
-
-### Programming Language API:
-
-- [x] Rust
-- [x] Python
-- [x] C
-- [x] C++
-- [ ] WebAssembly (Wished for)
-
-### OS:
-- [x] Linux Ubuntu (tested)
-- [x] MacOS (tested)
-- [x] Windows (tested)
-
-> Although, MacOS and Windows has a low priority for us now.
-
-### Platform:
-- [x] x86 (tested)
-- [ ] aarch64
-
-> Other platforms should also work althougth we haven't tested them yet.
-
-### Data Format
-- [x] Bytes
-- [x] Arrow Array (Uint8) for Python
-- [ ] Arrow Array (Uint16, Int32, ...) (Planned feature)
-- [ ] Arrow Map (Wished feature)
-
-### Local Communication
-- [x] TCP
-- [x] Shared Memory
-
-### Remote Communication
-- [x] TCP
-- [ ] Zenoh
-
----
 
+<p align="center">
+    <img src="./docs/src/latency.png" width="600">
+    
+</p>
 
-## 🏁 Further reading
+dora-rs can already show impressive performance, as much as 17x when compared to ROS 2! This is the result of using our own shared memory server and Apache Arrow to achieve zero copy!
 
-- Check out [dora-drives](https://github.com/dora-rs/dora-drives) for a template of an autonomous vehicle within a simulation.
+Those performance improvements make a world of difference for beginners, AI practitioners, and weekend hobbyists who have been limited by the lack of support for Python in this field!
 
+And that's only one example of the many innovative features that we can show for dora-rs!
 
-## ⚖️ LICENSE 
+## ⚖️ License
 
 This project is licensed under Apache-2.0. Check out [NOTICE.md](NOTICE.md) for more information.

examples/python-operator-dataflow/run.sh

@@ -4,6 +4,7 @@ python3 -m venv .env
 . $(pwd)/.env/bin/activate
 # Dev dependencies
 pip install maturin
+pip install patchelf
 cd ../../apis/python/node
 maturin develop
 cd ../../../examples/python-operator-dataflow