Skip to content

Commit

Permalink
docs: added link to ref for loading function
Browse files Browse the repository at this point in the history
  • Loading branch information
maximelucas committed Sep 1, 2024
1 parent 610f9c9 commit 6a968bd
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 16 deletions.
6 changes: 3 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
xgi-data
gallery
contribute
about_us


Software for higher-order networks
Expand All @@ -27,6 +26,7 @@ with group (higher-order) interactions. It provides tools to:
* analyze the structure of higher-order networks with metrics and algorithms
* compute nodes and edge statistics in a unified interface
* draw higher-order networks
* manipulate hypergraphs (undirected and directed) and simplicial complexes


Higher-order networks generalize standard (pairwise) networks by allowing to encode higher-order interactions,
Expand All @@ -47,15 +47,15 @@ Corresponding Data
==================

A number of higher-order datasets are available in the `XGI-DATA repository <https://github.com/xgi-org/xgi-data>`_ and can be easily accessed with the ``load_xgi_data()`` function.
More information about the datasets and how to load them is in the `XGI-DATA menu <xgi-data.html>`_
More information about the datasets and how to load them is in the `XGI-DATA menu <xgi-data.html>`_.

Get involved
==================

To simply getting news and updates, you can sign up for our `mailing list <http://eepurl.com/igE6ez>`_ and follow XGI on `Twitter <https://twitter.com/xginets>`_ or `Mastodon <https://mathstodon.xyz/@xginets>`_!

If you want to contribute, even better! The XGI community always welcomes contributions, no matter how small.
For more information, see `contribution guide <development.html>`_
For more information, see our `contribution guide <contribute.html>`_.



Expand Down
2 changes: 1 addition & 1 deletion docs/source/user_guides.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _guides:

***********************************
User guides
User Guides
***********************************


Expand Down
35 changes: 23 additions & 12 deletions docs/source/xgi-data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,29 @@ XGI-DATA

XGI-DATA is a repository of openly available hypergraph datasets in JSON format with corresponding documentation of network statistics, limitations of the data, and methods of collection. They are hosted in the `XGI Community <https://zenodo.org/communities/xgi>`_ on Zenodo. This is loosely inspired by `Datasheets for Datasets <https://arxiv.org/abs/1803.09010>`_ by Gebru et al.

Loading datasets
----------------

Loading a dataset using XGI is as simple as the following two lines:

.. code-block:: python
import xgi
H = xgi.load_xgi_data("<dataset_name>")
XGI-DATA uses an HTTP request to load the hypergraph dataset. See the `Reference <api/readwrite/xgi.readwrite.xgi_data.html>`_ for a complete description of the function.

The directed hypergraph datasets from the Biochemical, Genetic and Genomic (BIGG) database can also be loaded with:


.. code-block:: python
import xgi
H = xgi.load_bigg_data("<dataset_name>")
See the `Reference <api/readwrite/xgi.readwrite.bigg_data.html>`_ for a complete description of the function.

Dataset format
--------------

Expand All @@ -24,18 +47,6 @@ The xgi-data format for higher-order datasets is a JSON data structure with the

* :code:`edge-dict`: This tag accesses the edge IDs and the corresponding nodes which participate in that hyperedge.

Loading datasets
----------------

Loading a dataset using XGI is as simple as the following two lines:

.. code-block:: python
import xgi
H = xgi.load_xgi_data("<dataset_name>")
XGI-DATA uses an HTTP request to load the hypergraph dataset.


Network Statistics
------------------
Expand Down

0 comments on commit 6a968bd

Please sign in to comment.