Skip to content

Commit

Permalink
Adding index.rst and updating the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
georgedimitriadis committed Dec 1, 2021
1 parent c5c5886 commit b30b178
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Heron

A more thorough description of both why Heron exists in the first place and how to use it (before the advent of a full manual) can be found in [this document](https://medium.com/@gdimitri/heron-a-hybrid-approach-to-data-pipelines-in-python-aa7719fe8f2e).

## Introduction

Heron is a Python only graphical editor designed to initiate, connect and orchestrate multiple processes, potentially running on multiple computers. Each process is graphically represented as a node with inputs and outputs. Connecting an output of one process to the input of another will result in the data generated by the output process to be passed to the input one, subsequently triggering the input processes functionality.
Expand Down Expand Up @@ -31,18 +33,17 @@ pyzmq >= 22.x

numpy

dearpygui = 0.8.xx

opencv = 4.x (3.x should work but not tested)
dearpygui = 1.1

paramikro (required if the multiple computers fuctionality is utilised)

pynput (for the user input nodes)
For using the in-Node visualisation capabilities and for a good few Nodes (Visualiser, Cameras, OpenCV filters) opencv = 4.x is required (3.x should work but not tested). Heron by itself will run without it but those Nodes and any in-Node visualisation won't.

Other libraries are used in specific Nodes as needs be but one can check the import statements of the Worker scripts of the specific Operations.


diskarray (for the save numpy node)

If you use conda then dearpygui and diskarray have to be installed by pip (no conda packages yet).
Trying to install diskarray will try to install numpy (on top of the conda install numpy). Do not do that! First "pip install basescript" (a diskarray requirement) and then "pip install diskarray --no-dependencies" which will install only diskarray.
If you use conda then dearpygui has to be installed by pip (no conda packages yet).


## Use
Expand Down
Empty file added index.rst
Empty file.

0 comments on commit b30b178

Please sign in to comment.