Reorganized directory structure to match cuDf, added in files to matc…

…h cudf. Some files are left blank to be filled in later
oorliu · Feb 4, 2019 · f03851c · f03851c
1 parent 2992ac2
commit f03851c
Show file tree

Hide file tree

Showing 50 changed files with 145 additions and 2 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,2 @@
+# Ignore cmake builds from local machine that might have occured before attempting Docker build. Including these files will cause CMake cache conflict issues
+/cpp/build
diff --git a/.gitattributes b/.gitattributes
diff --git a/.gitmodules b/.gitmodules
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,53 @@
+# Contributing to cuGraph
+
+If you are interested in contributing to cuGraph, your contributions will fall
+into three categories:
+1. You want to report a bug, feature request, or documentation issue
+    - File an [issue](https://github.com/rapidsai/cugraph/issues/new/choose)
+    describing what you encountered or what you want to see changed.
+    - The RAPIDS team will evaluate the issues and triage them, scheduling
+    them for a release. If you believe the issue needs priority attention
+    comment on the issue to notify the team.
+2. You want to propose a new Feature and implement it
+    - Post about your intended feature, and we shall discuss the design and
+    implementation.
+    - Once we agree that the plan looks good, go ahead and implement it, using
+    the [code contributions](#code-contributions) guide below.
+3. You want to implement a feature or bug-fix for an outstanding issue
+    - Follow the [code contributions](#code-contributions) guide below.
+    - If you need more context on a particular issue, please ask and we shall
+    provide.
+
+## Code contributions
+
+### Your first issue
+
+1. Read the project's [README.md](https://github.com/rapidsai/cudf/blob/master/README.md)
+    to learn how to setup the development environment
+2. Find an issue to work on. The best way is to look for the [good first issue](https://github.com/rapidsai/cugraph/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+    or [help wanted](https://github.com/rapidsai/cugraph/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) labels
+3. Comment on the issue saying you are going to work on it
+4. Code! Make sure to update unit tests!
+5. When done, [create your pull request](https://github.com/rapidsai/cugraph/compare)
+6. Verify that CI passes all [status checks](https://help.github.com/articles/about-status-checks/). Fix if needed
+7. Wait for other developers to review your code and update code as needed
+8. Once reviewed and approved, a RAPIDS developer will merge your pull request
+
+Remember, if you are unsure about anything, don't hesitate to comment on issues
+and ask for clarifications!
+
+### Seasoned developers
+
+Once you have gotten your feet wet and are more comfortable with the code, you
+can look at the prioritized issues of our next release in our [project boards](https://github.com/rapidsai/cudf/projects).
+
+> **Pro Tip:** Always look at the release board with the highest number for
+issues to work on. This is where RAPIDS developers also focus their efforts.
+
+Look at the unassigned issues, and find an issue you are comfortable with
+contributing to. Start with _Step 3_ from above, commenting on the issue to let
+others know you are working on it. If you have any questions related to the
+implementation of the issue, ask them in the issue instead of the PR.
+
+## Attribution
+Portions adopted from https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md
diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/README.md b/README.md
@@ -47,6 +47,7 @@ This project uses cmake for building the C/C++ library. To configure cmake,
 run:
 
 ```bash
+cd cpp	      # enter cpp directory
 mkdir build   # create build directory for out-of-source build
 cd build      # enter the build directory
 cmake .. -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX 

diff --git a/conda/environments/builddocs_py35.yml b/conda/environments/builddocs_py35.yml
diff --git a/CMakeLists.txt → cpp/CMakeLists.txt b/CMakeLists.txt → cpp/CMakeLists.txt
diff --git a/cmake/Modules/ConfigureArrow.cmake → cpp/cmake/Modules/ConfigureArrow.cmake b/cmake/Modules/ConfigureArrow.cmake → cpp/cmake/Modules/ConfigureArrow.cmake
diff --git a/cmake/Modules/ConfigureGoogleTest.cmake → cpp/cmake/Modules/ConfigureGoogleTest.cmake b/cmake/Modules/ConfigureGoogleTest.cmake → cpp/cmake/Modules/ConfigureGoogleTest.cmake
diff --git a/cmake/Modules/FindArrow.cmake → cpp/cmake/Modules/FindArrow.cmake b/cmake/Modules/FindArrow.cmake → cpp/cmake/Modules/FindArrow.cmake
diff --git a/cmake/Templates/Arrow.CMakeLists.txt.cmake → ...make/Templates/Arrow.CMakeLists.txt.cmake b/cmake/Templates/Arrow.CMakeLists.txt.cmake → ...make/Templates/Arrow.CMakeLists.txt.cmake
diff --git a/...Templates/GoogleTest.CMakeLists.txt.cmake → ...Templates/GoogleTest.CMakeLists.txt.cmake b/...Templates/GoogleTest.CMakeLists.txt.cmake → ...Templates/GoogleTest.CMakeLists.txt.cmake
diff --git a/include/cugraph.h → cpp/include/cugraph.h b/include/cugraph.h → cpp/include/cugraph.h
diff --git a/include/functions.h → cpp/include/functions.h b/include/functions.h → cpp/include/functions.h
diff --git a/include/nvgraph_gdf.h → cpp/include/nvgraph_gdf.h b/include/nvgraph_gdf.h → cpp/include/nvgraph_gdf.h
diff --git a/include/rmm_utils.h → cpp/include/rmm_utils.h b/include/rmm_utils.h → cpp/include/rmm_utils.h
diff --git a/include/types.h → cpp/include/types.h b/include/types.h → cpp/include/types.h
diff --git a/src/COOtoCSR.cuh → cpp/src/COOtoCSR.cuh b/src/COOtoCSR.cuh → cpp/src/COOtoCSR.cuh
diff --git a/src/bfs.cu → cpp/src/bfs.cu b/src/bfs.cu → cpp/src/bfs.cu
diff --git a/src/bfs.cuh → cpp/src/bfs.cuh b/src/bfs.cuh → cpp/src/bfs.cuh
diff --git a/src/bfs_kernels.cuh → cpp/src/bfs_kernels.cuh b/src/bfs_kernels.cuh → cpp/src/bfs_kernels.cuh
diff --git a/src/cugraph.cu → cpp/src/cugraph.cu b/src/cugraph.cu → cpp/src/cugraph.cu
diff --git a/src/graph_utils.cuh → cpp/src/graph_utils.cuh b/src/graph_utils.cuh → cpp/src/graph_utils.cuh
diff --git a/src/grmat.cu → cpp/src/grmat.cu b/src/grmat.cu → cpp/src/grmat.cu
diff --git a/src/nvgraph_gdf.cu → cpp/src/nvgraph_gdf.cu b/src/nvgraph_gdf.cu → cpp/src/nvgraph_gdf.cu
diff --git a/src/pagerank.cu → cpp/src/pagerank.cu b/src/pagerank.cu → cpp/src/pagerank.cu
diff --git a/src/pagerank.cuh → cpp/src/pagerank.cuh b/src/pagerank.cuh → cpp/src/pagerank.cuh
diff --git a/src/renumber.cuh → cpp/src/renumber.cuh b/src/renumber.cuh → cpp/src/renumber.cuh
diff --git a/src/tests/CMakeLists.txt → cpp/src/tests/CMakeLists.txt b/src/tests/CMakeLists.txt → cpp/src/tests/CMakeLists.txt
diff --git a/src/tests/datasets.tar.gz → cpp/src/tests/datasets.tar.gz b/src/tests/datasets.tar.gz → cpp/src/tests/datasets.tar.gz
diff --git a/src/tests/gdf_graph/gdf_graph.cu → cpp/src/tests/gdf_graph/gdf_graph.cu b/src/tests/gdf_graph/gdf_graph.cu → cpp/src/tests/gdf_graph/gdf_graph.cu
diff --git a/src/tests/grmat/grmat_test.cu → cpp/src/tests/grmat/grmat_test.cu b/src/tests/grmat/grmat_test.cu → cpp/src/tests/grmat/grmat_test.cu
diff --git a/src/tests/high_res_clock.h → cpp/src/tests/high_res_clock.h b/src/tests/high_res_clock.h → cpp/src/tests/high_res_clock.h
diff --git a/src/tests/mmio.c → cpp/src/tests/mmio.c b/src/tests/mmio.c → cpp/src/tests/mmio.c
diff --git a/src/tests/mmio.h → cpp/src/tests/mmio.h b/src/tests/mmio.h → cpp/src/tests/mmio.h
diff --git a/...ts/nvgraph_plugin/nvgraph_gdf_jaccard.cpp → ...ts/nvgraph_plugin/nvgraph_gdf_jaccard.cpp b/...ts/nvgraph_plugin/nvgraph_gdf_jaccard.cpp → ...ts/nvgraph_plugin/nvgraph_gdf_jaccard.cpp
diff --git a/...ts/nvgraph_plugin/nvgraph_gdf_louvain.cpp → ...ts/nvgraph_plugin/nvgraph_gdf_louvain.cpp b/...ts/nvgraph_plugin/nvgraph_gdf_louvain.cpp → ...ts/nvgraph_plugin/nvgraph_gdf_louvain.cpp
diff --git a/...tests/nvgraph_plugin/nvgraph_gdf_sssp.cpp → ...tests/nvgraph_plugin/nvgraph_gdf_sssp.cpp b/...tests/nvgraph_plugin/nvgraph_gdf_sssp.cpp → ...tests/nvgraph_plugin/nvgraph_gdf_sssp.cpp
diff --git a/src/tests/pagerank/pagerank_test.cu → cpp/src/tests/pagerank/pagerank_test.cu b/src/tests/pagerank/pagerank_test.cu → cpp/src/tests/pagerank/pagerank_test.cu
diff --git a/src/tests/renumber/renumber_test.cu → cpp/src/tests/renumber/renumber_test.cu b/src/tests/renumber/renumber_test.cu → cpp/src/tests/renumber/renumber_test.cu
diff --git a/src/tests/test_utils.h → cpp/src/tests/test_utils.h b/src/tests/test_utils.h → cpp/src/tests/test_utils.h
diff --git a/src/utilities/error_utils.h → cpp/src/utilities/error_utils.h b/src/utilities/error_utils.h → cpp/src/utilities/error_utils.h
diff --git a/src/utilities/sm_utils.h → cpp/src/utilities/sm_utils.h b/src/utilities/sm_utils.h → cpp/src/utilities/sm_utils.h
diff --git a/print_env.sh b/print_env.sh
@@ -0,0 +1,76 @@
+#!/usr/bin/env bash
+# Reports relevant environment information useful for diagnosing and
+# debugging cuGraph issues.
+# Usage: 
+# "./print_env.sh" - prints to stdout
+# "./print_env.sh > env.txt" - prints to file "env.txt"
+
+echo "**git***"
+if [ "$(git rev-parse --is-inside-work-tree 2>/dev/null)" == "true" ]; then
+git log --decorate -n 1
+else
+echo "Not inside a git repository"
+fi
+echo 
+
+echo "***OS Information***"
+cat /etc/*-release
+uname -a
+echo 
+
+echo "***GPU Information***"
+nvidia-smi
+echo 
+
+echo "***CPU***"
+lscpu
+echo
+
+echo "***CMake***"
+which cmake && cmake --version 
+echo 
+
+echo "***g++***"
+which g++ && g++ --version 
+echo 
+
+echo "***nvcc***"
+which nvcc && nvcc --version 
+echo 
+
+echo "***Python***"
+which python && python --version
+echo
+
+echo "***Environment Variables***"
+
+printf '%-32s: %s\n' PATH $PATH
+
+printf '%-32s: %s\n' LD_LIBRARY_PATH $LD_LIBRARY_PATH
+
+printf '%-32s: %s\n' NUMBAPRO_NVVM $NUMBAPRO_NVVM
+
+printf '%-32s: %s\n' NUMBAPRO_LIBDEVICE $NUMBAPRO_LIBDEVICE
+
+printf '%-32s: %s\n' CONDA_PREFIX $CONDA_PREFIX
+
+printf '%-32s: %s\n' PYTHON_PATH $PYTHON_PATH
+
+echo
+
+
+# Print conda packages if conda exists
+if type "conda" &> /dev/null; then
+echo '***conda packages***'
+which conda && conda list 
+echo
+# Print pip packages if pip exists
+elif type "pip" &> /dev/null; then
+echo "conda not found"
+echo "***pip packages***"
+which pip && pip list
+echo
+else
+echo "conda not found"
+echo "pip not found"
+fi
diff --git a/readthedocs.yml b/readthedocs.yml
@@ -0,0 +1,9 @@
+
+build:
+   image: latest
+
+python:
+   version: 3.5
+
+conda:
+   file: conda/environments/builddocs_py35.yml
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,2 @@
+[flake8]
+exclude = img,notebooks,thirdparty,__init__.py,libgdf,build
diff --git a/setup.py b/setup.py
@@ -82,8 +82,8 @@ def locate_nvgraph():
                             cudf_include,
                             NVGRAPH['include'],
                             CUDA['include'],
-                            'src',
-                            'include',
+                            'cpp/src',
+                            'cpp/include',
                             '../gunrock',
                             '../gunrock/externals/moderngpu/include',
                             '../gunrock/externals/cub'],

diff --git a/setup_pip.py b/setup_pip.py
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Ignore cmake builds from local machine that might have occured before attempting Docker build. Including these files will cause CMake cache conflict issues
		/cpp/build
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		[flake8]
		exclude = img,notebooks,thirdparty,__init__.py,libgdf,build