Skip to content

Commit

Permalink
Deploying to gh-pages from @ f968c26 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
arashbm committed Oct 15, 2024
1 parent eae1331 commit 63d6923
Show file tree
Hide file tree
Showing 48 changed files with 97 additions and 71 deletions.
40 changes: 28 additions & 12 deletions _sources/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can install the most recent stable release from the PyPi index using pip:
The first command makes sure your pip installation is up-to-date, the second
command installs the most recent version of Reticula from the repository.

The binding currently supports Python versions 3.8, 3.9, 3.10 and 3.11.
The binding currently supports Python versions 3.10, 3.11, 3.12 and 3.13.

If you need to install the library on a system with no pre-compiled Wheels, you
can also build and install the binding from scrach. Chack out the
Expand Down Expand Up @@ -64,7 +64,7 @@ Building the Python binding from scratch
In order to build the Python binding on a development machine, you need to make
sure Python development headers are installed and accessible, a modern version
of GCC ( >= 10.2) is installed and accessible and that you have access to
approximatly infinite RAM (> 40GB) and time.
approximatly infinite memory (> 40GB) and about 20 minutes.

.. code-block:: console
Expand All @@ -73,26 +73,42 @@ approximatly infinite RAM (> 40GB) and time.
$ mkdir dist
$ python -m pip install --upgrade pip
$ python -m pip wheel . -w dist/
$ python -m auditwheel dist/*.whl
$ python -m pip install wheelhouse/*.whl
$ python -m pip install dist/*.whl
If you actively developing the Python binding (perhaps to send a pull request?
Thank you very much!) you might want to avoid re-building everything from
scratch every single time. In this scenario, I recommand disabling build
isolation and cleaning steps of :command:`pip wheel` by using this command
instead:
isolation of :command:`pip wheel` by using this command instead:

.. code-block:: console
$ python -m pip wheel . -w dist/ --verbose --no-build-isolation --no-clean
$ python -m pip wheel -w dist/ --verbose --no-build-isolation -Cbuild-dir=build .
This needs you to manually have the required python packages installed. You can
find a list of these packages and acceptable version in the
Or just directly re-install the package on your system, meaning that in every
iteration you just need to run:

.. code-block:: console
$ python -m pip install --verbose --force-reinstall --no-build-isolation -Cbuild-dir=build .
This requires you to have the required python packages manually installed. You
can find a list of these packages and acceptable version in the
:file:`pyproject.toml` file under the :code:`[build-system]` table.

You might also need to re-install the created wheel without bumping the version
every time. Consider adding the flag :option:`--force-reinstall` to the
:command:`pip install` command.
When building a wheel you intend to distribute, you might want to copy the
external shared libraries using the `auditwheel` tool to ensure compatibility
across different Linux distributions. Refer to the `auditwheel` documentation
for more details.

.. code-block:: console
$ python -m auditwheel repair --plat manylinux_2_39_x86_64 dist/*.whl
You can use the most recent platform compatible with all the computers that
will be using the wheel instead of :code:`manylinux_2_39_x86_64`. A better
option is to use `cibuildwheel`_ for building wheels across different platforms.

.. _cibuildwheel: https://cibuildwheel.readthedocs.io/en/stable/

Building C++ library tests
^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion algorithms/assortativity.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Static network reachability" href="static_network_reachability.html" /><link rel="prev" title="Graph properties" href="graph_properties.html" />
<link rel="canonical" href="https://docs.reticula.network/algorithms/assortativity.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Assortativity - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion algorithms/edge_degrees.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Graphicallity" href="graphicallity.html" /><link rel="prev" title="Vertex degrees" href="vertex_degrees.html" />
<link rel="canonical" href="https://docs.reticula.network/algorithms/edge_degrees.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Edge degrees (orders) - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion algorithms/event_graphs.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Examples" href="../examples/index.html" /><link rel="prev" title="Temporal network reachability" href="temporal_network_reachability.html" />
<link rel="canonical" href="https://docs.reticula.network/algorithms/event_graphs.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Event graphs - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion algorithms/graph_properties.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Assortativity" href="assortativity.html" /><link rel="prev" title="Graphicallity" href="graphicallity.html" />
<link rel="canonical" href="https://docs.reticula.network/algorithms/graph_properties.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Graph properties - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion algorithms/graphicallity.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Graph properties" href="graph_properties.html" /><link rel="prev" title="Edge degrees (orders)" href="edge_degrees.html" />
<link rel="canonical" href="https://docs.reticula.network/algorithms/graphicallity.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Graphicallity - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion algorithms/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Vertex degrees" href="vertex_degrees.html" /><link rel="prev" title="Graph union" href="../operations/graph_union.html" />
<link rel="canonical" href="https://docs.reticula.network/algorithms/index.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Algorithms - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion algorithms/static_network_reachability.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Temporal network reachability" href="temporal_network_reachability.html" /><link rel="prev" title="Assortativity" href="assortativity.html" />
<link rel="canonical" href="https://docs.reticula.network/algorithms/static_network_reachability.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Static network reachability - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion algorithms/temporal_network_reachability.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Event graphs" href="event_graphs.html" /><link rel="prev" title="Static network reachability" href="static_network_reachability.html" />
<link rel="canonical" href="https://docs.reticula.network/algorithms/temporal_network_reachability.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Temporal network reachability - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion algorithms/vertex_degrees.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Edge degrees (orders)" href="edge_degrees.html" /><link rel="prev" title="Algorithms" href="index.html" />
<link rel="canonical" href="https://docs.reticula.network/algorithms/vertex_degrees.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Vertex degrees - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion bibliography.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Citing Reticula" href="citing.html" />
<link rel="canonical" href="https://docs.reticula.network/bibliography.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Bibliography - Reticula</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion citing.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Bibliography" href="bibliography.html" /><link rel="prev" title="Isotropic bond-percolation in G(n, p) networks" href="examples/isotropic.html" />
<link rel="canonical" href="https://docs.reticula.network/citing.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Citing Reticula - Reticula</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Isotropic bond-percolation in G(n, p) networks" href="isotropic.html" /><link rel="prev" title="Event graphs" href="../algorithms/event_graphs.html" />
<link rel="canonical" href="https://docs.reticula.network/examples/index.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Examples - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion examples/isotropic.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Citing Reticula" href="../citing.html" /><link rel="prev" title="Examples" href="index.html" />
<link rel="canonical" href="https://docs.reticula.network/examples/isotropic.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Isotropic bond-percolation in G(n, p) networks - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion generation/activation.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Randomising networks" href="../shuffling/index.html" /><link rel="prev" title="Fully-mixed temporal network" href="fully_mixed.html" />
<link rel="canonical" href="https://docs.reticula.network/generation/activation.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Link activation temporal network - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion generation/barabasi.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Random k-regular network" href="regular.html" /><link rel="prev" title="Random Erdős–Rényi network" href="gnp.html" />
<link rel="canonical" href="https://docs.reticula.network/generation/barabasi.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Random Barabási–Albert network - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion generation/complete_graph.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Random Erdős–Rényi network" href="gnp.html" /><link rel="prev" title="Square grid graphs" href="square_grid_graph.html" />
<link rel="canonical" href="https://docs.reticula.network/generation/complete_graph.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Complete graphs - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion generation/cycle.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Regular ring lattice" href="regular_ring_lattice.html" /><link rel="prev" title="Path graphs" href="path.html" />
<link rel="canonical" href="https://docs.reticula.network/generation/cycle.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Cycle graphs - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion generation/degree_seq.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Random expected degree-sequence network" href="expected_degree_seq.html" /><link rel="prev" title="Random k-regular network" href="regular.html" />
<link rel="canonical" href="https://docs.reticula.network/generation/degree_seq.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Random degree-sequence network - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion generation/expected_degree_seq.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Random uniform hypergraphs" href="uniform_hypergraph.html" /><link rel="prev" title="Random degree-sequence network" href="degree_seq.html" />
<link rel="canonical" href="https://docs.reticula.network/generation/expected_degree_seq.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Random expected degree-sequence network - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion generation/fully_mixed.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Link activation temporal network" href="activation.html" /><link rel="prev" title="Random uniform hypergraphs" href="uniform_hypergraph.html" />
<link rel="canonical" href="https://docs.reticula.network/generation/fully_mixed.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Fully-mixed temporal network - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion generation/gnp.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Random Barabási–Albert network" href="barabasi.html" /><link rel="prev" title="Complete graphs" href="complete_graph.html" />
<link rel="canonical" href="https://docs.reticula.network/generation/gnp.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Random Erdős–Rényi network - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
2 changes: 1 addition & 1 deletion generation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Path graphs" href="path.html" /><link rel="prev" title="Randomness" href="../randomness.html" />
<link rel="canonical" href="https://docs.reticula.network/generation/index.html" />

<!-- Generated with Sphinx 8.1.0 and Furo 2024.08.06 -->
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Generating networks - Reticula</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
Expand Down
Loading

0 comments on commit 63d6923

Please sign in to comment.