Skip to content

Commit

Permalink
Improved interfaces table
Browse files Browse the repository at this point in the history
  • Loading branch information
@bstellato
bstellato committed Mar 30, 2018
1 parent 1b45d9e commit 8a94f0c
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 27 deletions.
6 changes: 4 additions & 2 deletions docs/interfaces/cutest.rst
View file
@@ -1,3 +1,5 @@
.. _cutest_interface:

CUTEst
======

Expand All @@ -10,11 +12,11 @@ probname.SIF is
See the man page for runcutest for more details or other options.

The default OSQP settings used in CUTEst appear in the `OSQP.SPC <https://ccpforge.cse.rl.ac.uk/svn/cutest/cutest/trunk/src/osqp/OSQP.SPC>`_ file.
The default OSQP settings used in CUTEst appear in the `OSQP.SPC <https://github.com/ralna/CUTEst/blob/master/src/osqp/OSQP.SPC>`_ file.
Optionally, new parameter values to overwrite the default values can be stored in a file :code:`OSQP.SPC` in the directory where the :code:`runcutest` command is executed.
The format of the file :code:`OSQP.SPC` is the parameter name starting in the first column followed by one or more spaces and then the parameter value.
The parameter names are case sensitive.
If the parameter value is :code:`true` or :code:`false`, then use :code:`1` for true and :code:`0` for :code:`false`.

For more details see the `README.osqp <https://ccpforge.cse.rl.ac.uk/svn/cutest/cutest/trunk/src/osqp/README.osqp>`_ file in the CUTEst repository.
For more details see the `README.osqp <https://github.com/ralna/CUTEst/blob/master/src/osqp/README.osqp>`_ file in the CUTEst repository.

3 changes: 3 additions & 0 deletions docs/interfaces/fortran.rst
View file
@@ -1,3 +1,6 @@
.. _fortran_interface:


Fortran
========

Expand Down
50 changes: 25 additions & 25 deletions docs/interfaces/index.rst
View file
Expand Up @@ -2,37 +2,37 @@ Interfaces
============


+----------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| Language | Maintainers | Repository |
+----------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| C/C++ | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | `github.com/oxfordcontrol/osqp <https://github.com/oxfordcontrol/osqp>`_ |
| | | `Goran Banjac <goran.banjac@eng.ox.ac.uk>`_ | |
| | | `Paul Goulart <paul.goulart@eng.ox.ac.uk>`_ | |
+----------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| Python | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | `github.com/oxfordcontrol/osqp-python <https://github.com/oxfordcontrol/osqp-python>`_ |
| | | `Goran Banjac <goran.banjac@eng.ox.ac.uk>`_ | |
+----------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| Matlab | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | `github.com/oxfordcontrol/osqp-matlab <https://github.com/oxfordcontrol/osqp-matlab>`_ |
| | | `Goran Banjac <goran.banjac@eng.ox.ac.uk>`_ | |
| | | `Paul Goulart <paul.goulart@eng.ox.ac.uk>`_ | |
+----------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| Julia | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | `github.com/oxfordcontrol/OSQP.jl <https://github.com/oxfordcontrol/OSQP.jl>`_ |
+----------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| Rust | | `Ed Barnard <eabarnard@gmail.com>`_ | `github.com/oxfordcontrol/osqp.rs <https://github.com/oxfordcontrol/osqp.rs>`_ |
+----------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| Fortran | | `Nick Gould <nick.gould@stfc.ac.uk>`_ | `github.com/oxfordcontrol/osqp <https://github.com/oxfordcontrol/osqp>`_ |
| (experimental) | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | |
| | | `Paul Goulart <paul.goulart@eng.ox.ac.uk>`_ | |
+----------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| Cutest | | `Nick Gould <nick.gould@stfc.ac.uk>`_ | `github.com/ralna/CUTEst <https://github.com/ralna/CUTEst/tree/master/src/osqp>`_ |
+----------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+

+------------------------------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| Language | Maintainers | Repository |
+------------------------------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`C/C++ <c_cpp_interface>` | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | `github.com/oxfordcontrol/osqp <https://github.com/oxfordcontrol/osqp>`_ |
| | | `Goran Banjac <goran.banjac@eng.ox.ac.uk>`_ | |
| | | `Paul Goulart <paul.goulart@eng.ox.ac.uk>`_ | |
+------------------------------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`Python <python_interface>` | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | `github.com/oxfordcontrol/osqp-python <https://github.com/oxfordcontrol/osqp-python>`_ |
| | | `Goran Banjac <goran.banjac@eng.ox.ac.uk>`_ | |
+------------------------------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`Matlab <matlab_interface>` | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | `github.com/oxfordcontrol/osqp-matlab <https://github.com/oxfordcontrol/osqp-matlab>`_ |
| | | `Goran Banjac <goran.banjac@eng.ox.ac.uk>`_ | |
| | | `Paul Goulart <paul.goulart@eng.ox.ac.uk>`_ | |
+------------------------------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`Julia <julia_interface>` | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | `github.com/oxfordcontrol/OSQP.jl <https://github.com/oxfordcontrol/OSQP.jl>`_ |
+------------------------------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| `Rust <https://docs.rs/osqp/>`_ | | `Ed Barnard <eabarnard@gmail.com>`_ | `github.com/oxfordcontrol/osqp.rs <https://github.com/oxfordcontrol/osqp.rs>`_ |
+------------------------------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`Fortran <fortran_interface>` | | `Nick Gould <nick.gould@stfc.ac.uk>`_ | `github.com/oxfordcontrol/osqp <https://github.com/oxfordcontrol/osqp>`_ |
| (experimental) | | `Bartolomeo Stellato <bartolomeo.stellato@gmail.com>`_ | |
| | | `Paul Goulart <paul.goulart@eng.ox.ac.uk>`_ | |
+------------------------------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`Cutest <cutest_interface>` | | `Nick Gould <nick.gould@stfc.ac.uk>`_ | `github.com/ralna/CUTEst <https://github.com/ralna/CUTEst/tree/master/src/osqp>`_ |
+------------------------------------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+



.. toctree::
:maxdepth: 1
:glob:
:hidden:

CC++.rst
python.rst
Expand Down
2 changes: 2 additions & 0 deletions docs/interfaces/julia.rst
View file
@@ -1,3 +1,5 @@
.. _julia_interface:

Julia
======

Expand Down
2 changes: 2 additions & 0 deletions docs/interfaces/matlab.rst
View file
@@ -1,3 +1,5 @@
.. _matlab_interface:

Matlab
======

Expand Down
2 changes: 2 additions & 0 deletions docs/interfaces/python.rst
View file
@@ -1,3 +1,5 @@
.. _python_interface:

Python
======

Expand Down

0 comments on commit 8a94f0c

Please sign in to comment.