Skip to content

Commit 6f19f53

Browse files
committed
update README
1 parent 8b34e7c commit 6f19f53

1 file changed

Lines changed: 19 additions & 9 deletions

File tree

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,29 @@
33
Simple distributed data manipulation and processing routines for Julia.
44

55
This was originally developed for
6-
[GigaSOM.jl](https://github.com/LCSB-BioCore/GigaSOM.jl), this package contains
7-
the separated-out lightweight distributed-processing framework that can be used
8-
with GigaSOM.
6+
[`GigaSOM.jl`](https://github.com/LCSB-BioCore/GigaSOM.jl); DiDa.jl package
7+
contains the separated-out lightweight distributed-processing framework that
8+
was used in `GigaSOM.jl`.
99

1010
## Why?
1111

12-
This provides a very simple, imperative and straightforward way to move your
13-
data around a cluster of Julia processes created by the `Distributed` package,
12+
DiDa.jl provides a very simple, imperative and straightforward way to move your
13+
data around a cluster of Julia processes created by the
14+
[`Distributed`](https://docs.julialang.org/en/v1/stdlib/Distributed/) package,
1415
and run computation on the distributed data pieces. The main aim of the package
15-
is to avoid anything complicated-- the first version used in GigaSOM had just
16-
under 500 lines of relatively straightforward code with comments.
17-
18-
Most importantly, distributed processing should be simple and accessible.
16+
is to avoid anything complicated-- the first version used in
17+
[GigaSOM](https://github.com/LCSB-BioCore/GigaSOM.jl) had just under 500 lines
18+
of relatively straightforward code (including the doc-comments).
19+
20+
Compared to plain `Distributed` API, you get more straightforward data
21+
manipulation primitives, some extra control over the precise place where code
22+
is executed, and a few high-level functions. These include a distributed
23+
version of `mapreduce`, simpler work-alike of the
24+
[DistributedArrays](https://github.com/JuliaParallel/DistributedArrays.jl)
25+
functionality, and easy-to-use distributed dataset saving and loading.
26+
27+
Most importantly, the main motivation behind the package is that the
28+
distributed processing should be simple and accessible.
1929

2030
## Brief how-to
2131

0 commit comments

Comments
 (0)