Skip to content

Commit

Permalink
[Project] Release 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
EgorOrachyov committed Apr 2, 2021
1 parent 8fda70e commit 7f037ae
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 58 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![JB Research](https://jb.gg/badges/research-flat-square.svg)](https://research.jetbrains.org/)
[![Ubuntu](https://github.com/JetBrains-Research/cuBool/workflows/Ubuntu/badge.svg?branch=master)](https://github.com/JetBrains-Research/cuBool/actions)
[![License](https://img.shields.io/badge/license-MIT-orange)](https://github.com/JetBrains-Research/cuBool/blob/master/LICENSE)
[![Package](https://img.shields.io/badge/pypi%20package-alpha-%233776ab)](https://test.pypi.org/project/pycubool/)
[![Package](https://img.shields.io/badge/pypi%20package-1.0.0-%233776ab)](https://pypi.org/project/pycubool/)

**cuBool** is a linear Boolean algebra library primitives and operations for
work with sparse matrices written on the NVIDIA CUDA platform. The primary
Expand All @@ -28,6 +28,8 @@ for computations on CPU side only. This backend is selected automatically
if Cuda compatible device is not presented in the system. This can be quite handy for
prototyping algorithms on a local computer for later running on a powerful server.

**PyPI package web page** is following [link](https://pypi.org/project/pycubool/).

### Features

- [X] Library C interface
Expand All @@ -52,10 +54,10 @@ prototyping algorithms on a local computer for later running on a powerful serve
- [X] Tests for Python wrapper
- [X] Pip package
- [X] Code examples
- [ ] User guide
- [X] User guide
- [X] Unit Tests collection
- [X] Publish built artifacts and shared libs
- [ ] Publish stable source code archives
- [X] Publish stable source code archives

## Simple example

Expand Down
54 changes: 1 addition & 53 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,26 +60,6 @@ b[2, 1] = True
print(a, b, a.mxm(b), sep="\n")
```

Output:

```
0 1 2
0 | 1 . . | 0
1 | . . 1 | 1
0 1 2
0 1 2 3
0 | . 1 1 . | 0
1 | . . . 1 | 1
2 | . 1 . . | 2
0 1 2 3
0 1 2 3
0 | . 1 1 . | 0
1 | . 1 . . | 1
0 1 2 3
```

## Transitive closure example

Compute the transitive closure problem for the directed graph and print the result:
Expand All @@ -104,24 +84,6 @@ while total != t.nvals:
print(a, t, sep="\n")
```

Output:

```
0 1 2 3
0 | . 1 . . | 0
1 | . . 1 . | 1
2 | 1 . . 1 | 2
3 | . . 1 . | 3
0 1 2 3
0 1 2 3
0 | 1 1 1 1 | 0
1 | 1 1 1 1 | 1
2 | 1 1 1 1 | 2
3 | 1 1 1 1 | 3
0 1 2 3
```

## GraphViz example

Generate GraphViz graph script for a graph stored as a set of adjacency matrices:
Expand All @@ -145,21 +107,7 @@ b[3, 2] = True
print(cb.matrices_to_gviz(matrices={"a": a, "b": b}, graph_name=name, edge_colors=colors))
```

Output:

```
digraph G {
graph [label=Test];
node [color=black];
0 -> 1 [label=a,color=red];
1 -> 2 [label=a,color=red];
2 -> 0 [label=a,color=red];
2 -> 3 [label=b,color=green];
3 -> 2 [label=b,color=green];
}
```

As an image:
Script can be rendered by any [gviz tool](https://dreampuf.github.io/GraphvizOnline/) online and the result can be following:

![gviz-example](https://raw.githubusercontent.com/JetBrains-Research/cuBool/master/docs/pictures/gviz_example.png)

Expand Down
2 changes: 2 additions & 0 deletions python/publish_pypi.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
python3 setup.py sdist bdist_wheel
twine upload --verbose dist/*
File renamed without changes.
4 changes: 2 additions & 2 deletions python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

setuptools.setup(
name="pycubool",
version="0.0.1",
version="1.0.0",
author="Egor Orachyov",
author_email="[email protected]",
license="MIT",
Expand All @@ -23,7 +23,7 @@
"Bug Tracker": "https://github.com/JetBrains-Research/cuBool/issues"
},
classifiers=[
"Development Status :: 3 - Alpha",
"Development Status :: 5 - Production/Stable",
"Programming Language :: Python :: 3",
"Programming Language :: C++",
"License :: OSI Approved :: MIT License",
Expand Down

0 comments on commit 7f037ae

Please sign in to comment.