-
-Tutorials
----------
-
-.. If you update this toctree, also update the manual toctree in the
- main index.rst.template
-
-.. toctree::
- :maxdepth: 2
- :hidden:
-
- overview
- installation/index
- intro_tutorials/index
diff --git a/docs/source/getting_started/installation/index.rst b/docs/source/getting_started/installation/index.rst
deleted file mode 100644
index 820b9aa4eb..0000000000
--- a/docs/source/getting_started/installation/index.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-=========================
-Installation
-=========================
-
-.. toctree::
- :maxdepth: 1
-
- install_python
- install_rust
diff --git a/docs/source/getting_started/installation/install_python.rst b/docs/source/getting_started/installation/install_python.rst
deleted file mode 100644
index ec9a8f1cb8..0000000000
--- a/docs/source/getting_started/installation/install_python.rst
+++ /dev/null
@@ -1,98 +0,0 @@
-.. _install-python:
-
-{{ header }}
-
-=====================
-Python
-=====================
-
-The easiest way to install raphtory is to install it
-via pip, `pip install raphtory`.
-This is the recommended installation method for most users.
-
-.. _install.version:
-
-Python version support
-----------------------
-
-Officially Python 3.10.
-
-Installing raphtory
--------------------
-
-Installing from PyPI
-~~~~~~~~~~~~~~~~~~~~
-
-Raphtory can be installed via pip from
-`PyPI `__.
-
-.. note::
- You must have ``pip>=23`` to install from PyPI.
-
-::
-
- pip install raphtory
-
-
-Installing from source
-~~~~~~~~~~~~~~~~~~~~~~
-
-Installing from source is the quickest way to:
-
-* Try a new feature that will be shipped in the next release (that is, a feature from a pull-request that was recently merged to the main branch).
-* Check whether a bug you encountered has been fixed since the last release.
-
-Note that first uninstalling raphtory might be required to be able to install from source, as version numbers may not be up to date::
-
- pip uninstall raphtory -y
-
-Requirements
-------------
-
-To install raphtory from source, you need the following:
-
-* `git `__ to clone the repository.
-* `rust `__ to build the rust modules.
-* `python `__ to run the setup script.
-* `pip `__ to install the python package.
-* `virtualenv` to create a virtual environment for the python package or `conda`
-* `maturin `__ to build the python package.
-* `requirements` listed in the requirements.txt file.
-
-Installing directly from github source
---------------------------------------
-
-The following will pull the raphtory repository from git and install the python package from source.
-
- pip install -e 'git+https://github.com/Pometry/Raphtory.git#egg=raphtory&subdirectory=python'
-
-
-Installing directly from source
--------------------------------
-
-If you are developing raphtory and want to build & install the python package locally, you can do so with the following command:
-
- make build-all
- or
- cd python && maturin develop
-
-
-Running the test suite
-----------------------
-
-Raphtory is equipped with an exhaustive set of unit tests.
-To run it on your machine to verify that everything is working
-(and that you have all of the dependencies installed), make sure you have `pytest
-`__ >= 7.0
-
-Test dependencies:
-
- python -m pip install -q pytest networkx numpy seaborn pandas nbmake pytest-xdist matplotlib
-
-To run `raphtory` python tests:
-
- cd python && pytest
-
-To run notebook tests:
-
- cd python/tests && pytest --nbmake --nbmake-timeout=1200 .
diff --git a/docs/source/getting_started/installation/install_rust.rst b/docs/source/getting_started/installation/install_rust.rst
deleted file mode 100644
index 088904be9d..0000000000
--- a/docs/source/getting_started/installation/install_rust.rst
+++ /dev/null
@@ -1,99 +0,0 @@
-.. _install-rust:
-
-{{ header }}
-
-===================
-Rust
-===================
-
-The easiest way to install raphtory is to install it
-via cargo, `cargo add raphtory`.
-This is the recommended installation method for most users.
-
-.. _install.version-rust:
-
-Rust version support
-----------------------
-
-Officially Rust 1.67.1
-
-Installing raphtory
--------------------
-
-Installing from Cargo
-~~~~~~~~~~~~~~~~~~~~~
-
-Raphtory can be installed via pip from
-`Cargo `__.
-
-.. note::
- You must have ``rust>=1.67.1`` to install from cargo.
-
-::
-
- cargo add raphtory
-
-
-Installing from source
-~~~~~~~~~~~~~~~~~~~~~~
-
-Installing from source is the quickest way to:
-
-* Try a new feature that will be shipped in the next release (that is, a feature from a pull-request that was recently merged to the main branch).
-* Check whether a bug you encountered has been fixed since the last release.
-
-Note that first uninstalling raphtory might be required to be able to install from source, as version numbers may not be up to date::
-
- cargo remove raphtory
-
-Requirements
-------------
-
-To install raphtory from source, you need the following:
-
-* `git `__ to clone the repository.
-* `rust `__ to build the rust modules.
-* `make `__ to run the build script.
-
-Installing directly from source
--------------------------------
-
-Building the rust core is done using cargo. The following command will build the core.
-
- make rust-build
-
-or
-
- cargo build
-
-Import the raphtory package into a rust project
------------------------------------------------
-
-To use the raphtory core in a rust project, add the following to your Cargo.toml file:
-Note: The path should be the path to the raphtory directory
-
-
-
- [dependencies]
-
- raphtory = {path = "../raphtory", version = "0.3.0" }
-
-
-or
-
-
- [dependencies]
-
- raphtory = "0.3.0"
-
-
-Running the test suite
-----------------------
-
-Raphtory is equipped with an exhaustive set of unit tests.
-To run it on your machine to verify that everything is working
-(and that you have all of the dependencies installed)
-
-To run `raphtory` rust tests:
-
- cargo test
\ No newline at end of file
diff --git a/docs/source/getting_started/intro_tutorials/01_quickstart.rst b/docs/source/getting_started/intro_tutorials/01_quickstart.rst
deleted file mode 100644
index 33d3e98370..0000000000
--- a/docs/source/getting_started/intro_tutorials/01_quickstart.rst
+++ /dev/null
@@ -1,143 +0,0 @@
-.. _gettingstarted_quickstart:
-
-{{ header }}
-
-How do I create a graph, add nodes/edges, add properties, run algorithms?
-==========================================================================
-
-.. raw:: html
-
-
-
-
-I want to create a graph
-
-.. ipython:: python
-
- import raphtory
- g = raphtory.Graph()
-
-To load the raphtory package and start working with it, import the
-package. We recommend to import the package under the alias ``raphtory``.
-
-
-.. raw:: html
-
-
-
-
-How do I add nodes and edges?
-=====================================
-
-.. raw:: html
-
-
-
-
-I want to add two nodes and an edge into the graph.
-
-.. ipython:: python
-
- g.add_vertex(0, "Ben")
- g.add_vertex(1, "Hamza")
- g.add_edge(2, "Ben", "Hamza")
-
-
-Here we have added a node called "Ben" a time 0, and a node called "Hamza" at time 1.
-Next we added an edge between "Ben" and "Hamza" at time 2.
-
-.. raw:: html
-
-
-
-
-.. note::
- These don't have any properties, but we will add them below!
-
-
-
-How do I add nodes and edges with properties?
-==============================================
-
-.. raw:: html
-
-
-
-
-I want to add properties with my nodes and edges.
-
-.. ipython:: python
-
- g.add_vertex(3, "Rachel", {"class": "student", "age": 20})
- g.add_vertex(4, "Shivam", {"class": "student", "age": 21})
- g.add_edge(5, "Rachel", "Shivam", {"class": "friendship"})
-
-
-Here we have added a node called "Rachel" a time 3, with the properies class and age.
-Similarly, we have doen the same for a node called "Shivam" at time 4.
-Next we added an edge between "Rachel" and "Shivam" at time 5 with the property name "class" and the value "friendship".
-
-.. raw:: html
-
-
-
-
-
-
-How do I run an algorithm?
-=====================================
-
-.. raw:: html
-
-
-
-
-I'd like to run a Max Out Degree algorithm.
-
-.. ipython:: python
-
- from raphtory import algorithms
- print("Graph - Max out degree: %i" % algorithms.max_out_degree(g))
-
-Here we have imported the algorithms package, and then run the max out degree algorithm on the graph.
-
-
-.. raw:: html
-
-
-
-
-
-
-How do I view / visualise my graph?
-=====================================
-
-.. raw:: html
-
-
-
-
-I'd like to view my graph.
-
-.. ipython:: python
-
- from raphtory import vis
- vis.to_networkx(g)
-
-or you can show it with pyvis vis
-
-
-.. ipython:: python
-
- from raphtory import vis
- v = vis.to_pyvis(g)
- v.show('graph.html')
-
-Here we have imported the vis package, and then converted the graph to a networkx / pyvis graph.
-We can then view the graph in a notebook, or save it to a file.
-
-.. raw:: html
-
-
\n",
- "\n",
- "As with the quick start install guide, this and all following python pages are built as iPython notebooks. If you want to follow along on your own machine, click the `open on github` link in the top right of this page.\n",
- "\n",
- "## Let's have a look at the example data\n",
- "\n",
- "The data we are going to use is two `csv` files which will be pulled from our Github data repository. These are the structure of the graph (`lotr.csv`) and some metadata about the characters (`lotr_properties.csv`)\n",
- "\n",
- "For the structure file each line contains two characters that appeared in the same sentence, along with the sentence number, which we will use as a `timestamp`. The first line of the file is `Gandalf,Elrond,33` which tells us that Gandalf and Elrond appears together in sentence 33.\n",
- "\n",
- "For the properties file each line gives a characters name, their race and gender. For example `Gimli,dwarf,male`.\n",
- "\n",
- "\n",
- "### Downloading the csv from Github 💾\n",
- "\n",
- "The following `curl` command will download the csv files and save them in the `tmp` directory on your computer. This will be deleted when you restart your computer, but it's only a couple of KB in any case.\n",
- "\n"
- ]
- },
- {
- "cell_type": "code",
- "execution_count": 1,
- "metadata": {
- "tags": []
- },
- "outputs": [
- {
- "name": "stdout",
- "output_type": "stream",
- "text": [
- "****Downloading Data****\n",
- " % Total % Received % Xferd Average Speed Time Time Time Current\n",
- " Dload Upload Total Spent Left Speed\n",
- "100 52206 100 52206 0 0 154k 0 --:--:-- --:--:-- --:--:-- 160k\n",
- " % Total % Received % Xferd Average Speed Time Time Time Current\n",
- " Dload Upload Total Spent Left Speed\n",
- "100 686 100 686 0 0 2906 0 --:--:-- --:--:-- --:--:-- 2995\n",
- " % Total % Received % Xferd Average Speed Time Time Time Current\n",
- " Dload Upload Total Spent Left Speed\n",
- "100 69632 100 69632 0 0 287k 0 --:--:-- --:--:-- --:--:-- 296k\n",
- "****LOTR GRAPH STRUCTURE****\n",
- "Gandalf,Elrond,33\n",
- "Frodo,Bilbo,114\n",
- "Blanco,Marcho,146\n",
- "****LOTR GRAPH PROPERTIES****\n",
- "Aragorn,men,male\n",
- "Gandalf,ainur,male\n",
- "Goldberry,ainur,female\n"
- ]
- }
- ],
- "source": [
- "print(\"****Downloading Data****\")\n",
- "!curl -o /tmp/lotr.csv https://raw.githubusercontent.com/Raphtory/Data/main/lotr.csv\n",
- "!curl -o /tmp/lotr_properties.csv https://raw.githubusercontent.com/Raphtory/Data/main/lotr_properties.csv\n",
- "!curl -o /tmp/lotr.db https://raw.githubusercontent.com/Raphtory/Data/main/lotr.db\n",
- "print(\"****LOTR GRAPH STRUCTURE****\")\n",
- "!head -n 3 /tmp/lotr.csv\n",
- "print(\"****LOTR GRAPH PROPERTIES****\")\n",
- "!head -n 3 /tmp/lotr_properties.csv"
- ]
- },
- {
- "cell_type": "markdown",
- "metadata": {},
- "source": [
- "## Setting up our imports and Raphtory\n",
- "Now that we have our data we can sort out our imports and create the Raphtory `Graph` which we will use to build our graphs.\n",
- "\n",
- "The imports are for parsing CSV files, accessing pandas dataframes, and bringing in all the Raphtory classes we will use in the tutorial.\n",
- "\n",
- "The filenames are pointing at the data we just downloaded. If you change the download location above, make sure to change them here as well."
- ]
- },
- {
- "cell_type": "code",
- "execution_count": 2,
- "metadata": {
- "tags": []
- },
- "outputs": [],
- "source": [
- "import csv\n",
- "import pandas as pd\n",
- "from raphtory import Graph\n",
- "\n",
- "structure_file = \"/tmp/lotr.csv\"\n",
- "properties_file = \"/tmp/lotr_properties.csv\"\n",
- "graph = Graph(1)\n"
- ]
- },
- {
- "cell_type": "markdown",
- "metadata": {},
- "source": [
- "## Adding data directly into the Graph\n",
- "\n",
- "The simplest way to add data into a graph is to directly call the `add_vertex` and `add_edge` functions, which we saw in the quick start guide. These have required arguments defining the time the addition occurred and an identifier for the entity being updated. These functions, however, have several optional arguments allowing us to add `properties` and within this, `types`, on top of the base structure. \n",
- "\n",
- "\n",
- "| Function | Required Arguments | Optional Arguments |\n",
- "|--------------|-------------------------------|----------------------------------------------|\n",
- "| `add_vertex` | `timestamp`,`vertex_id` | `properties` |\n",
- "| `add_edge` | `timestamp`,`src_id`,`dst_id` | `properties` |\n",
- "\n",
- "\n",
- "Lets take a look at this with our example data. In the below code we are opening The Lord of The Rings structural data via the csv reader and looping through each line. \n",
- "\n",
- "To insert the data we:\n",
- "\n",
- "* Extract the two characters names, referring to them as the `source_node` and `destination_node`.\n",
- "* Extract the sentence number, referring to is as `timestamp`. This is then cast to an `int` as `epoch` timestamps in Raphtory must be a number.\n",
- "* Call `add_vertex` for both nodes, setting their type to `Character`.\n",
- "* Create an edge between them via `add_edge` and label this a `Co-occurence`."
- ]
- },
- {
- "cell_type": "code",
- "execution_count": 3,
- "metadata": {
- "tags": []
- },
- "outputs": [],
- "source": [
- "with open(structure_file, 'r') as csvfile:\n",
- " datareader = csv.reader(csvfile)\n",
- " for row in datareader:\n",
- "\n",
- " source_node = row[0]\n",
- " destination_node = row[1]\n",
- " timestamp = int(row[2])\n",
- " \n",
- " graph.add_vertex(timestamp, source_node, {\"vertex_type\": \"Character\"})\n",
- " graph.add_vertex(timestamp, destination_node, {\"vertex_type\": \"Character\"}) \n",
- " graph.add_edge(timestamp, source_node, destination_node, {\"edge_type\": \"Character_Co-occurence\"})"
- ]
- },
- {
- "cell_type": "markdown",
- "metadata": {},
- "source": [
- "## Let's see if the data has ingested\n",
- "\n",
- "To do this, much like the quick start, we can run a query on our graph. As Raphtory allows us to explore the network's history, lets add a bit of this in as well. \n",
- "\n",
- "Below we check the data contained in the graph by running the `earliest_time()`, `latest_time()`, and `len` the vertices and edges. "
- ]
- },
- {
- "cell_type": "code",
- "execution_count": 17,
- "metadata": {
- "tags": []
- },
- "outputs": [
- {
- "name": "stdout",
- "output_type": "stream",
- "text": [
- "Earliest time: 33\n",
- "Latest time: 32674\n",
- "Number of vertices: 139\n",
- "Number of edges: 701\n"
- ]
- }
- ],
- "source": [
- "print(\"Earliest time: %i\" % graph.earliest_time())\n",
- "print(\"Latest time: %i\" % graph.latest_time())\n",
- "\n",
- "print(\"Number of vertices: %i\" % len(graph.vertices()))\n",
- "print(\"Number of edges: %i\" % len(graph.edges()))"
- ]
- },
- {
- "cell_type": "markdown",
- "metadata": {},
- "source": [
- "We can also access a specific vertex, such as `Gandalf`, and see his degree at different points in time using the `at()` function. \n",
- "\n",
- "In the first call, we get the entire graph at time 1000, and then check the degree of gandalf. \n",
- "\n",
- "In the second call, we get the vertex gandalf, get their instance at time 10,000 and the degree. "
- ]
- },
- {
- "cell_type": "code",
- "execution_count": 18,
- "metadata": {},
- "outputs": [
- {
- "name": "stdout",
- "output_type": "stream",
- "text": [
- "Gandalf's degree at 1000: 4\n",
- "Gandalf's degree at 10,000: 26\n"
- ]
- }
- ],
- "source": [
- "print(\"Gandalf's degree at 1000: %i\" % graph.at(1000).vertex(\"Gandalf\").degree())\n",
- "\n",
- "print(\"Gandalf's degree at 10,000: %i\" % graph.vertex(\"Gandalf\").at(10000).degree())"
- ]
- },
- {
- "cell_type": "markdown",
- "metadata": {},
- "source": [
- "## Updating graphs, merging datasets and adding properties\n",
- "\n",
- "One cool thing about Raphtory is that we can freely insert new information at any point in time and it will be automatically inserted in chronological order. This makes it really easy to merge datasets or ingest out of order data. \n",
- "\n",
- "A property on a vertex or edge can be either static or non-static. \n",
- "\n",
- "* Static properties, do not change and are fixed throughout the life of the graph, e.g. the `name` property. \n",
- "* Non-static properties can change over time, e.g. `balance` of a bank account. \n",
- "\n",
- "All property objects require the user to specify a name and value.\n",
- "\n",
- "To explore this and to add some properties to our graph, lets load our second dataset!\n",
- "\n",
- "Below we are opening our property file the same way as the structure file. This data does not have a time element, so we can add the properties as static properties. This means they will be available at evert point in time and the values will stay the same. \n",
- "\n",
- "Now it's worthwhile noting that we aren't calling a function called `update_vertex` or something similar, even though we know the vertex exists. This is because everything is considered an addition into the history and Raphtory sorts all the ordering internally!"
- ]
- },
- {
- "cell_type": "code",
- "execution_count": 23,
- "metadata": {
- "tags": []
- },
- "outputs": [],
- "source": [
- "with open(properties_file, 'r') as csvfile:\n",
- " datareader = csv.reader(csvfile)\n",
- " for row in datareader:\n",
- " graph.add_vertex_properties(row[0], {\"race\": row[1],\"gender\": row[2]})\n"
- ]
- },
- {
- "cell_type": "markdown",
- "metadata": {},
- "source": [
- "## Using our properties as part of a query\n",
- "To quickly see if our new properties are included in the graph we can write a new query! Lets have a look at the dwarves who have the most interactions.\n",
- "\n",
- "To start we can create a function which for each vertex and check the size of exploded edges. This takes each edge and measures how many times it was updated. E.g. if Gimli and Balin met four times, in the graph they have one edge between them. But if we explode this edge, we can see each time they met. \n",
- "\n",
- "We can iterate through each vertex and filter by the **race** property and remove anyone who isn't a **dwarf**.\n",
- "\n",
- "Finally, we can sort the data into a dataframe to see **Gimli** has by far the most!"
- ]
- },
- {
- "cell_type": "code",
- "execution_count": 51,
- "metadata": {},
- "outputs": [
- {
- "data": {
- "text/html": [
- "
\n",
- "\n",
- "
\n",
- " \n",
- "
\n",
- "
\n",
- "
timestamp
\n",
- "
name
\n",
- "
interactions
\n",
- "
\n",
- " \n",
- " \n",
- "
\n",
- "
3
\n",
- "
31247
\n",
- "
Gimli
\n",
- "
185
\n",
- "
\n",
- "
\n",
- "
1
\n",
- "
31129
\n",
- "
Glóin
\n",
- "
31
\n",
- "
\n",
- "
\n",
- "
2
\n",
- "
10938
\n",
- "
Balin
\n",
- "
14
\n",
- "
\n",
- "
\n",
- "
0
\n",
- "
9605
\n",
- "
Thorin
\n",
- "
5
\n",
- "
\n",
- " \n",
- "
\n",
- "
"
- ],
- "text/plain": [
- " timestamp name interactions\n",
- "3 31247 Gimli 185\n",
- "1 31129 Glóin 31\n",
- "2 10938 Balin 14\n",
- "0 9605 Thorin 5"
- ]
- },
- "execution_count": 51,
- "metadata": {},
- "output_type": "execute_result"
- }
- ],
- "source": [
- "result = []\n",
- "# This returns an iterator, so we should store the value to avoid a deadlock\n",
- "vertices = list(graph.vertices())\n",
- "\n",
- "for vertex in vertices:\n",
- " if vertex.property(\"race\") == \"dwarf\":\n",
- " interactions = sum([len(e.explode()) for e in vertex.edges()])\n",
- " latest = vertex.latest_time()\n",
- " result.append({\"timestamp\": latest, \"name\": vertex.name(), \"interactions\": interactions })\n",
- "\n",
- "pd.DataFrame(result).sort_values(by=\"interactions\",ascending=False) "
- ]
- }
- ],
- "metadata": {
- "kernelspec": {
- "display_name": "Python 3 (ipykernel)",
- "language": "python",
- "name": "python3"
- },
- "language_info": {
- "codemirror_mode": {
- "name": "ipython",
- "version": 3
- },
- "file_extension": ".py",
- "mimetype": "text/x-python",
- "name": "python",
- "nbconvert_exporter": "python",
- "pygments_lexer": "ipython3",
- "version": "3.10.9"
- },
- "vscode": {
- "interpreter": {
- "hash": "a9a34730827747ae273d5a5e0748f342e2039a3997e32d9a086d01739bd0f055"
- }
- }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}
diff --git a/docs/source/getting_started/overview.rst b/docs/source/getting_started/overview.rst
deleted file mode 100644
index e3b3757952..0000000000
--- a/docs/source/getting_started/overview.rst
+++ /dev/null
@@ -1,48 +0,0 @@
-.. _overview:
-
-{{ header }}
-
-****************
-Package overview
-****************
-
-Raphtory is an in-memory graph tool written in Rust with friendly Python APIs on top.
-It is blazingly fast, scales to hundreds of millions of edges
-on your laptop, and can be dropped into your existing pipelines.
-
-It supports time traveling, multilayer modelling, and advanced analytics beyond simple querying like
-community evolution, dynamic scoring, and mining temporal motifs.
-
-Successful contributions will be reward with swizzling swag!
-
-Getting support
----------------
-
-The first stop for raphtory issues and ideas is the `GitHub Issue Tracker
-`__. If you have a general question,
-raphtory community experts can answer through `Slack
-`__.
-
-Bounty Board
-------------
-
-We offer bounties for the following contributions to the project, please see below to
-win some cool swag! `Our Github bounty board `__
-
-Community
----------
-
-Raphtory is actively supported today by a community of software engineering experts and world-class researchers around
-the world. Thanks to `pometry `__ and `all of our contributors `__.
-
-If you're interested in contributing, please visit the :ref:`contributing guide `.
-
-Development team
------------------
-
-The list of the Core Team members and more detailed information can be found on the `pometry website `__.
-
-License
--------
-
-.. literalinclude:: ../../../LICENSE
diff --git a/docs/source/images/index_api.svg b/docs/source/images/index_api.svg
deleted file mode 100644
index c9eee89983..0000000000
--- a/docs/source/images/index_api.svg
+++ /dev/null
@@ -1,24 +0,0 @@
-
\ No newline at end of file
diff --git a/docs/source/images/index_contribute.svg b/docs/source/images/index_contribute.svg
deleted file mode 100644
index 91b4140ec5..0000000000
--- a/docs/source/images/index_contribute.svg
+++ /dev/null
@@ -1,19 +0,0 @@
-
\ No newline at end of file
diff --git a/docs/source/images/index_getting_started.svg b/docs/source/images/index_getting_started.svg
deleted file mode 100644
index 3756254230..0000000000
--- a/docs/source/images/index_getting_started.svg
+++ /dev/null
@@ -1,16 +0,0 @@
-
\ No newline at end of file
diff --git a/docs/source/images/index_user_guide.svg b/docs/source/images/index_user_guide.svg
deleted file mode 100644
index 4eee142cdf..0000000000
--- a/docs/source/images/index_user_guide.svg
+++ /dev/null
@@ -1,16 +0,0 @@
-
\ No newline at end of file
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 76856225c0..1f33acfc47 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,112 +1,91 @@
-:notoc:
+.. _api_menu:
-.. Raphtory documentation master file, created by
+{{ header }}
-.. module:: Raphtory
+****************
+Raphtory
+****************
-****************************************
-Raphtory documentation
-****************************************
+.. automodule:: raphtory
+ :autosummary:
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :private-members:
+ :inherited-members:
-**Date**: |today| **Version**: |version|
+Algorithms
+-------------------
-**Useful links**:
-`Source Repository `__ |
-`Issues & Ideas `__ |
-`Slack Support `__
+.. automodule:: raphtory.algorithms
+ :autosummary:
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :private-members:
+ :inherited-members:
-:mod:`Raphtory` is an in-memory graph tool written in Rust with friendly Python APIs on top.
-It is blazingly fast, scales to hundreds of millions of edges on your laptop, and can be
-dropped into your existing pipelines with a simple `pip install raphtory`.
+Visualisation
+-------------------
-.. grid:: 1 2 2 2
- :gutter: 4
- :padding: 2 2 0 0
- :class-container: sd-text-center
+.. automodule:: raphtory.export
+ :autosummary:
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :private-members:
+ :inherited-members:
- .. grid-item-card:: Getting started
- :img-top: images/index_getting_started.svg
- :class-card: intro-card
- :shadow: md
- New to *Raphtory*? Check out the getting started guides. They contain an
- introduction to *Raphtory'* main concepts and links to additional tutorials.
+Null Models
+--------------------------
- +++
+.. automodule:: raphtory.nullmodels
+ :autosummary:
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :private-members:
+ :inherited-members:
- .. button-ref:: getting_started
- :ref-type: ref
- :click-parent:
- :color: secondary
- :expand:
+Graph Generation
+--------------------------
+
+.. automodule:: raphtory.graph_gen
+ :autosummary:
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :private-members:
+ :inherited-members:
+
+GraphQL Server
+--------------------------
+
+.. automodule:: raphtory.graphql
+ :autosummary:
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :inherited-members:
- To the getting started guides
- .. grid-item-card:: User guide
- :img-top: images/index_user_guide.svg
- :class-card: intro-card
- :shadow: md
- The user guide provides in-depth information on the
- key concepts of Raphtory with useful background information and explanation.
- +++
- .. button-ref:: user_guide
- :ref-type: ref
- :click-parent:
- :color: secondary
- :expand:
- To the user guide
- .. grid-item-card:: API reference
- :img-top: images/index_api.svg
- :class-card: intro-card
- :shadow: md
- The reference guide contains a detailed description of
- the Raphtory API. The reference describes how the methods work and which parameters can
- be used. It assumes that you have an understanding of the key concepts.
- +++
- .. button-ref:: api
- :ref-type: ref
- :click-parent:
- :color: secondary
- :expand:
- To the reference guide
- .. grid-item-card:: Developer guide
- :img-top: images/index_contribute.svg
- :class-card: intro-card
- :shadow: md
- Saw a typo in the documentation? Want to improve
- existing functionalities? The contributing guidelines will guide
- you through the process of improving Raphtory.
- +++
- .. button-ref:: development
- :ref-type: ref
- :click-parent:
- :color: secondary
- :expand:
- To the development guide
-.. toctree::
- :maxdepth: 3
- :hidden:
- :titlesonly:
- getting_started/index
- development/index
- api/index
- userguide/index
diff --git a/docs/source/userguide/graphql.rst b/docs/source/userguide/graphql.rst
deleted file mode 100644
index 7f37f323d9..0000000000
--- a/docs/source/userguide/graphql.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-{{ header }}
-
-********************
-GraphQL
-********************
diff --git a/docs/source/userguide/index.rst b/docs/source/userguide/index.rst
deleted file mode 100644
index c2ff591b2c..0000000000
--- a/docs/source/userguide/index.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-{{ header }}
-
-.. _user_guide:
-
-==========
-User Guide
-==========
-
-This guide explains each component of raphtory.
-
-.. toctree::
- :maxdepth: 2
-
- raphtory
- rust
- js
- graphql
- io
\ No newline at end of file
diff --git a/docs/source/userguide/io.rst b/docs/source/userguide/io.rst
deleted file mode 100644
index 873ab6a0f4..0000000000
--- a/docs/source/userguide/io.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-{{ header }}
-
-********************
-IO
-********************
\ No newline at end of file
diff --git a/docs/source/userguide/js.rst b/docs/source/userguide/js.rst
deleted file mode 100644
index 655c049d97..0000000000
--- a/docs/source/userguide/js.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-{{ header }}
-
-********************
-JS
-********************
\ No newline at end of file
diff --git a/docs/source/userguide/raphtory.rst b/docs/source/userguide/raphtory.rst
deleted file mode 100644
index da063304f4..0000000000
--- a/docs/source/userguide/raphtory.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-{{ header }}
-
-********************
-Raphtory
-********************
\ No newline at end of file
diff --git a/docs/source/userguide/rust.rst b/docs/source/userguide/rust.rst
deleted file mode 100644
index 5f2b2dbc24..0000000000
--- a/docs/source/userguide/rust.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-{{ header }}
-
-********************
-Rust
-********************
\ No newline at end of file
diff --git a/examples/custom-algorithm/src/main.rs b/examples/custom-algorithm/src/main.rs
index 2d4590edf7..97c250f6f8 100644
--- a/examples/custom-algorithm/src/main.rs
+++ b/examples/custom-algorithm/src/main.rs
@@ -2,7 +2,7 @@ use async_graphql::dynamic::{FieldValue, ResolverContext, TypeRef};
use async_graphql::FieldResult;
use dynamic_graphql::internal::TypeName;
use dynamic_graphql::SimpleObject;
-use raphtory::db::view_api::GraphViewOps;
+use raphtory::db::view::GraphViewOps;
use raphtory_graphql::{Algorithm, RaphtoryServer};
#[derive(SimpleObject)]
@@ -29,7 +29,7 @@ impl Algorithm for DummyAlgorithm {
) -> FieldResult