Skip to content

Commit f27c6bf

Browse files
committed
Update README.md
1 parent 89b6bf1 commit f27c6bf

File tree

1 file changed

+44
-11
lines changed

1 file changed

+44
-11
lines changed

README.md

Lines changed: 44 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,56 @@
1-
# clojask
1+
# Clojask
22
Clojure data frame with parallel computing on larger-than-memory datasets
33

4-
#### Run the main function in `core`:
4+
### Features
55

6-
```
7-
lein run
8-
```
6+
- **Unlimited size**
7+
8+
Theoretically speaking, it supports dataset larger than memory, even to infinity!
9+
10+
- **Fast**
11+
12+
Faster than Dask in most operations, and the larger the dataframe is, the bigger the advantage
13+
14+
- **All native types**
15+
16+
All the datatypes used to store data is native Clojure (or Java) types!
17+
18+
- **From file to file**
19+
20+
Integrate IO inside the dataframe. No need to write your own read-in and output functions!
21+
22+
- **Parallel**
923

10-
#### Run the tests in `test`:
24+
Most operations could be executed into multiple threads or even machines. See the principle in [Onyx](http://www.onyxplatform.org/).
25+
26+
- **Lazy operations**
27+
28+
Most operations will not be executed immediately. Dataframe will intelligently pipeline the operations altogether in computation.
29+
30+
### Installation
31+
32+
Available on [Clojars](https://clojars.org/com.github.clojure-finance/clojask).
33+
34+
Insert this line into your `project.clj` if using Leiningen.
1135

1236
```
13-
lein test
37+
[com.github.clojure-finance/clojask "1.0.0"]
1438
```
1539

40+
Insert this line into your `deps.edn` if using CLI.
1641

17-
To run a particular test defined in the namespace:
1842
```
19-
lein test :only core-test/df-api-test
43+
com.github.clojure-finance/clojask {:mvn/version "1.0.0"}
2044
```
2145

22-
#### Requirements for the input file:
23-
- the first row should contain the column names
46+
### Documentation
47+
48+
The detailed doc for every API can be found [here](https://clojure-finance.github.io/clojask-website/posts-output/API/).
49+
50+
### Examples
51+
52+
A separate repository for some typical usage of Clojask can be found [here](https://github.com/clojure-finance/clojask-examples).
53+
54+
### Problem Feedback
55+
56+
If your question is not answered in existing [issues](https://github.com/clojure-finance/clojask/issues). Feel free to create a new one.

0 commit comments

Comments
 (0)