-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generate latest docs on CI, from commit d1b26e2.
- Loading branch information
0 parents
commit d1bdb4a
Showing
98 changed files
with
14,590 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,142 @@ | ||
.git | ||
**/.git | ||
|
||
# contents from .gitignore | ||
# Prerequisites | ||
*.d | ||
|
||
# Object files | ||
*.o | ||
*.ko | ||
*.obj | ||
*.elf | ||
|
||
# Linker output | ||
*.ilk | ||
*.map | ||
*.exp | ||
|
||
# Precompiled Headers | ||
*.gch | ||
*.pch | ||
|
||
# Libraries | ||
*.lib | ||
*.a | ||
*.la | ||
*.lo | ||
|
||
# Shared objects (inc. Windows DLLs) | ||
*.dll | ||
*.so | ||
*.so.* | ||
*.dylib | ||
|
||
# Executables | ||
*.exe | ||
*.out | ||
*.app | ||
*.i*86 | ||
*.x86_64 | ||
*.hex | ||
|
||
# Debug files | ||
*.dSYM/ | ||
*.su | ||
*.idb | ||
*.pdb | ||
|
||
# Kernel Module Compile Results | ||
*.mod* | ||
*.cmd | ||
.tmp_versions/ | ||
modules.order | ||
Module.symvers | ||
Mkfile.old | ||
dkms.conf | ||
|
||
# Specific files | ||
*.bc | ||
|
||
# Python | ||
__pycache__/ | ||
*.pyc | ||
.ipynb_checkpoints | ||
*.egg-info/ | ||
*.eggs | ||
python/*.eggs | ||
*.whl | ||
|
||
# coordinator | ||
coordinator/proto | ||
|
||
# python | ||
python/proto | ||
|
||
# Gar file | ||
*.gar | ||
|
||
# dot file | ||
*.dot | ||
|
||
# Protobuf GRPC | ||
*.pb.* | ||
*_pb2.py* | ||
*_pb2_grpc.py* | ||
|
||
# Visual Studio Code | ||
.vscode/ | ||
.project | ||
.classpath | ||
.factorypath | ||
.settings | ||
|
||
# Mac OSX | ||
.DS_store | ||
|
||
# CLion | ||
.idea/ | ||
cmake-build-*/ | ||
**/*.iml | ||
**/target/ | ||
|
||
# Workspace | ||
workspace/ | ||
|
||
# etcd data directory | ||
default.etcd/ | ||
|
||
# outer build directory | ||
build/ | ||
analytical_engine/build/ | ||
|
||
# pom generated by maven-flatten-plugin | ||
**/.flattened-pom.xml | ||
|
||
# java sdk | ||
java/**/dependency-reduced-pom.xml | ||
|
||
# GraphLearn | ||
coordinator/graphlearn* | ||
|
||
# Lock files | ||
Chart.lock | ||
**/Cargo.lock | ||
package.lock | ||
|
||
# Core dump | ||
core.* | ||
*.core | ||
|
||
# cache | ||
.cache | ||
|
||
# GRIN header files | ||
interfaces/grin/include/ | ||
interfaces/grin/build/ | ||
|
||
# tmp directory | ||
tmp/ | ||
|
||
apps/networkx/client/python/dist/ | ||
apps/networkx/python_bindings/build/ |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
repos: | ||
- repo: https://github.com/awslabs/git-secrets.git | ||
rev: master | ||
hooks: | ||
- id: git-secrets |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions
1
_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css
Large diffs are not rendered by default.
Oops, something went wrong.
1 change: 1 addition & 0 deletions
1
_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
7 changes: 7 additions & 0 deletions
7
_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
:root { | ||
--tabs-color-label-active: hsla(231, 99%, 66%, 1); | ||
--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); | ||
--tabs-color-overline: rgb(207, 236, 238); | ||
--tabs-color-underline: rgb(207, 236, 238); | ||
--tabs-size-label: 1rem; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
.. GART documentation master file, created by | ||
sphinx-quickstart on Tue Aug 27 10:19:05 2019. | ||
You can adapt this file completely to your liking, but it should at least | ||
contain the root `toctree` directive. | ||
.. meta:: | ||
:description: GART is a graph extension that includes an interface to an RDBMS and a dynamic graph store for online graph processing. | ||
:keywords: distributed-systems, distributed, graph-analytics, in-memory-storage, big-data-analytics, distributed-comp | ||
|
||
GART: Graph Analysis on Relational Transactional Datasets | ||
================================================================= | ||
|
||
|Discussion| |License| |USENIX| | ||
|
||
.. include:: documentation/getting-started/intro-content | ||
|
||
---------------- | ||
|
||
.. panels:: | ||
:header: text-center | ||
:column: col-lg-12 p-2 | ||
|
||
.. link-button:: documentation/getting-started/quick-start | ||
:type: ref | ||
:text: Getting Started | ||
:classes: btn-block stretched-link | ||
^^^^^^^^^^^^ | ||
Get started with GART. | ||
|
||
--- | ||
|
||
.. link-button:: documentation/design/architecture | ||
:type: ref | ||
:text: Design | ||
:classes: btn-block stretched-link | ||
^^^^^^^^^^^^ | ||
Learn about the architecture and key concepts of GART. | ||
|
||
--- | ||
|
||
.. link-button:: documentation/deployment/deploy-local | ||
:type: ref | ||
:text: Deployment | ||
:classes: btn-block stretched-link | ||
^^^^^^^^^^^^ | ||
Build environment and deploy GART. | ||
|
||
--- | ||
|
||
.. link-button:: documentation/tutorials/data-source-config | ||
:type: ref | ||
:text: Tutorials | ||
:classes: btn-block stretched-link | ||
^^^^^^^^^^^^ | ||
Explore use cases and tutorials where GART can bring added value. | ||
|
||
--- | ||
|
||
.. link-button:: https://github.com/GraphScope/GART | ||
:type: url | ||
:text: Getting Involved | ||
:classes: btn-block stretched-link | ||
^^^^^^^^^^^^ | ||
Get involved and become part of the GART community. | ||
|
||
Read the Paper | ||
-------------- | ||
|
||
- Sijie Shen, Zihang Yao, Lin Shi, Lei Wang, Longbin Lai, Qian Tao, Li Su, Rong Chen, Wenyuan Yu, Haibo Chen, Binyu Zang, Jingren Zhou. | ||
`Bridging the Gap between Relational OLTP and Graph-based OLAP <https://www.usenix.org/system/files/atc23-shen.pdf>`_. | ||
USENIX Annual Technical Conference, Boston, MA, USA, July 2023. |USENIX|. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Getting Started | ||
:hidden: | ||
|
||
documentation/getting-started/introduction | ||
documentation/getting-started/quick-start | ||
documentation/getting-started/use-cases | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Design | ||
:hidden: | ||
|
||
documentation/design/architecture | ||
documentation/design/key-concepts | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Deployment | ||
:hidden: | ||
|
||
documentation/deployment/deploy-local | ||
documentation/deployment/deploy-cloud | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Tutorials | ||
:hidden: | ||
|
||
documentation/tutorials/data-source-config | ||
|
||
.. |Discussion| image:: https://img.shields.io/badge/Discuss-Ask%20Questions-blue?logo=GitHub | ||
:target: https://github.com/GraphScope/GART/issues | ||
|
||
.. |License| image:: https://img.shields.io/github/license/graphscope/gart | ||
:target: https://github.com/GraphScope/GART/blob/main/LICENSE | ||
|
||
.. |USENIX| image:: https://img.shields.io/badge/USENIX-blue | ||
:target: https://www.usenix.org/conference/atc23/presentation/shen |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.. _deploy-on-cloud: | ||
|
||
On-Cloud Deployment | ||
==================== | ||
|
||
XXX (deploy by docker/K8S) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
.. _deploy-local: | ||
|
||
Local Deployment | ||
==================== | ||
|
||
This section describes how to deploy GART locally. | ||
|
||
Requirements | ||
------------ | ||
|
||
- `glog`_ | ||
- `gflags`_ | ||
- `etcd-cpp-apiv3`_ | ||
- `TBB`_ | ||
- `librdkafka`_ | ||
- `Vineyard`_ | ||
- `Apache Kafka`_ | ||
- `Debezium`_ (preferred) or `Maxwell`_ | ||
|
||
|
||
Install Dependencies | ||
-------------------- | ||
|
||
To simplify installing dependencies, we provide a script (`scripts/install-deps.sh`_) for installing GART's dependency environment. | ||
|
||
.. code-block:: bash | ||
:linenos: | ||
$ git clone https://github.com/GraphScope/GART.git gart | ||
$ cd gart | ||
$ ./scripts/install-deps.sh /path/to/your/installation # install dependencies | ||
Compile and Install GART | ||
------------------------ | ||
|
||
.. code-block:: bash | ||
:linenos: | ||
$ mkdir -p build; cd build | ||
$ cmake .. -DCMAKE_BUILD_TYPE=Release | ||
$ make -j | ||
$ sudo make install | ||
.. _glog: https://github.com/google/glog | ||
.. _gflags: https://github.com/gflags/gflags | ||
.. _etcd-cpp-apiv3: https://github.com/etcd-cpp-apiv3/etcd-cpp-apiv3 | ||
.. _TBB: https://github.com/oneapi-src/oneTBB | ||
.. _librdkafka: https://github.com/confluentinc/librdkafka | ||
.. _Vineyard: https://github.com/v6d-io/v6d | ||
.. _Apache Kafka: https://kafka.apache.org/quickstart | ||
.. _Debezium: https://github.com/debezium/debezium | ||
.. _Maxwell: https://github.com/zendesk/maxwell | ||
.. _scripts/install-deps.sh: https://github.com/GraphScope/GART/blob/main/scripts/install-deps.sh |
Oops, something went wrong.