Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/source/api_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ This section provides a detailed overview of all modules, classes, and functions
modules/core
modules/data
modules/generators
modules/invariants
modules/invariants/index
modules/polytopes
modules/viz

.. Modules
.. -------
Expand Down
29 changes: 0 additions & 29 deletions docs/source/modules/invariants.rst

This file was deleted.

7 changes: 7 additions & 0 deletions docs/source/modules/invariants/classics.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Classics
========

.. automodule:: graphcalc.invariants.classics
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/modules/invariants/coloring_predicates.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Coloring Predicates
===================

.. automodule:: graphcalc.invariants.coloring_predicates
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/modules/invariants/core_invariants.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Core Invariants
===============

.. automodule:: graphcalc.invariants.core_invariants
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/modules/invariants/critical_invariants.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Critical Invariants
===================

.. automodule:: graphcalc.invariants.critical_invariants
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/modules/invariants/cycle_invariants.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Cycle Invariants
================

.. automodule:: graphcalc.invariants.cycle_invariants
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/modules/invariants/degree.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Degree
======

.. automodule:: graphcalc.invariants.degree
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/modules/invariants/domination.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Domination
==========

.. automodule:: graphcalc.invariants.domination
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/modules/invariants/graph_indices.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Graph Indices
=============

.. automodule:: graphcalc.invariants.graph_indices
:members:
:undoc-members:
:show-inheritance:
18 changes: 18 additions & 0 deletions docs/source/modules/invariants/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Invariants
==========

.. toctree::
:maxdepth: 2

classics
degree
domination
spectral
zero_forcing
graph_indices
cycle_invariants
local_invariants
transversal_invariants
coloring_predicates
core_invariants
critical_invariants
7 changes: 7 additions & 0 deletions docs/source/modules/invariants/local_invariants.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Local Invariants
================

.. automodule:: graphcalc.invariants.local_invariants
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/modules/invariants/spectral.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Spectral
========

.. automodule:: graphcalc.invariants.spectral
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/modules/invariants/transversal_invariants.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Transversal Invariants
======================

.. automodule:: graphcalc.invariants.transversal_invariants
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/modules/invariants/zero_forcing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Zero Forcing
============

.. automodule:: graphcalc.invariants.zero_forcing
:members:
:undoc-members:
:show-inheritance:
17 changes: 17 additions & 0 deletions docs/source/modules/viz.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Visualization
=============

.. automodule:: graphcalc.viz
:members:
:undoc-members:
:show-inheritance:

.. automodule:: graphcalc.viz.edges
:members:
:undoc-members:
:show-inheritance:

.. automodule:: graphcalc.viz.vertices
:members:
:undoc-members:
:show-inheritance:
8 changes: 5 additions & 3 deletions docs/source/solvers.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _using-custom-solvers:

Using Custom Solvers
====================

Expand Down Expand Up @@ -205,7 +207,7 @@ Troubleshooting
**“PuLP: cannot execute highs.”**

- You selected ``HiGHS_CMD`` but the ``highs`` executable is not on ``PATH``.
Install it (see :doc:`Installation`) or use the Python package
Install it (see :doc:`installation`) or use the Python package
``highspy`` and set ``GRAPHCALC_SOLVER=highs``. As a quick fix,
force CBC: ``GRAPHCALC_SOLVER=cbc``.

Expand All @@ -223,11 +225,11 @@ Troubleshooting

- On Ubuntu 22.04 GitHub runners, install ``coinor-cbc`` and set
``GRAPHCALC_SOLVER=cbc``. Or install ``highspy`` and set
``GRAPHCALC_SOLVER=highs``. See :doc:`Installation` for ready-to-use YAML.
``GRAPHCALC_SOLVER=highs``. See :doc:`installation` for ready-to-use YAML.


See Also
--------

- :doc:`Installation` — how to install solvers on your platform.
- :doc:`installation` — how to install solvers on your platform.
- PuLP solver docs for detailed option names/behavior.
16 changes: 8 additions & 8 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ choose a solver, and build reusable analysis tables with pandas.

All functions accept either a ``networkx.Graph`` or ``graphcalc.SimpleGraph``.
Many invariants are NP-hard and use a MILP solver under the hood—see
:doc:`Installation` and :doc:`Using-Custom-Solvers`.
:doc:`installation` and :ref:`using-custom-solvers`.

.. contents::
:local:
Expand Down Expand Up @@ -43,7 +43,7 @@ Quick Start
Choosing a Solver (optional)
----------------------------

GraphCalc auto-detects a solver (see :doc:`Installation`). You can override per-call:
GraphCalc auto-detects a solver (see :doc:`installation`). You can override per-call:

.. code-block:: python

Expand All @@ -61,7 +61,7 @@ Or set an environment variable globally:
export GRAPHCALC_SOLVER=cbc # or: highs, glpk, auto

For all supported forms (string / dict / class / instance / callable), see
:doc:`Using-Custom-Solvers`.
:ref:`using-custom-solvers`.


Core Recipes
Expand Down Expand Up @@ -184,7 +184,7 @@ Compute a few selected properties for one graph

Solver-backed invariants in this call use the **auto-detected** solver.
To force a solver for batch runs, set ``GRAPHCALC_SOLVER`` (see
:doc:`Installation`) or call those functions directly with ``solver=...``.
:doc:`installation`) or call those functions directly with ``solver=...``.


Compute a table for multiple graphs
Expand Down Expand Up @@ -273,12 +273,12 @@ Troubleshooting

- **“No LP/MIP solver found.”**
Install one solver (CBC / HiGHS / GLPK) or set ``GRAPHCALC_SOLVER``.
See :doc:`Installation`.
See :doc:`installation`.

- **“PuLP: cannot execute highs.”**
You selected ``HiGHS_CMD`` but the ``highs`` executable isn’t on ``PATH``.
Install it, or install the Python package ``highspy`` and use ``solver="highs"``.
Or force CBC: ``solver="cbc"``. See :doc:`Installation`.
Or force CBC: ``solver="cbc"``. See :doc:`installation`.

- **Long runtimes.**
Use time limits (``solver_options={"timeLimit": ...}``) or switch to a faster solver.
Expand All @@ -287,5 +287,5 @@ Troubleshooting
See Also
--------

- :doc:`Installation` — installing solvers and verifying detection.
- :doc:`Using-Custom-Solvers` — every way to select/configure a solver.
- :doc:`installation` — installing solvers and verifying detection.
- :ref:`using-custom-solvers` — every way to select/configure a solver.
Loading
Loading