Skip to content

Commit 6655b54

Browse files
fix: update HiGHS URLs and naming (#585)
Replace dead maths.ed.ac.uk links with highs.dev and correct options URL. Use "HiGHS" consistently in docstrings.
1 parent 16d6f32 commit 6655b54

5 files changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Fri 0 4
143143

144144
* [Cbc](https://projects.coin-or.org/Cbc)
145145
* [GLPK](https://www.gnu.org/software/glpk/)
146-
* [HiGHS](https://www.maths.ed.ac.uk/hall/HiGHS/)
146+
* [HiGHS](https://highs.dev/)
147147
* [Gurobi](https://www.gurobi.com/)
148148
* [Xpress](https://www.fico.com/en/products/fico-xpress-solver)
149149
* [Cplex](https://www.ibm.com/de-de/analytics/cplex-optimizer)

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ flexible data-handling features:
4242
- Support of various solvers
4343
- `Cbc <https://projects.coin-or.org/Cbc>`__
4444
- `GLPK <https://www.gnu.org/software/glpk/>`__
45-
- `HiGHS <https://www.maths.ed.ac.uk/hall/HiGHS/>`__
45+
- `HiGHS <https://highs.dev/>`__
4646
- `MindOpt <https://solver.damo.alibaba.com/doc/en/html/index.html>`__
4747
- `Gurobi <https://www.gurobi.com/>`__
4848
- `Xpress <https://www.fico.com/en/fico-xpress-trial-and-licensing-options>`__

doc/prerequisites.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ CPU-based solvers
3535

3636
- `Cbc <https://projects.coin-or.org/Cbc>`__ - open source, free, fast
3737
- `GLPK <https://www.gnu.org/software/glpk/>`__ - open source, free, not very fast
38-
- `HiGHS <https://www.maths.ed.ac.uk/hall/HiGHS/>`__ - open source, free, fast
38+
- `HiGHS <https://highs.dev/>`__ - open source, free, fast
3939
- `Gurobi <https://www.gurobi.com/>`__ - closed source, commercial, very fast
4040
- `Xpress <https://www.fico.com/en/fico-xpress-trial-and-licensing-options>`__ - closed source, commercial, very fast (GPU acceleration available in v9.8+)
4141
- `Cplex <https://www.ibm.com/de-de/analytics/cplex-optimizer>`__ - closed source, commercial, very fast

doc/release_notes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -678,7 +678,7 @@ Version 0.0.5
678678
* The `Variable` class now has a `lower` and `upper` accessor, which allows to inspect and modify the lower and upper bounds of a assigned variable.
679679
* The `Constraint` class now has a `lhs`, `vars`, `coeffs`, `rhs` and `sign` accessor, which allows to inspect and modify the left-hand-side, the signs and right-hand-side of a assigned constraint.
680680
* Constraints can now be build combining linear expressions with right-hand-side via a `>=`, `<=` or a `==` operator. This creates an `AnonymousConstraint` which can be passed to `Model.add_constraints`.
681-
* Add support of the HiGHS open source solver https://www.maths.ed.ac.uk/hall/HiGHS/ (https://github.com/PyPSA/linopy/pull/8, https://github.com/PyPSA/linopy/pull/17).
681+
* Add support of the HiGHS open source solver https://highs.dev/ (https://github.com/PyPSA/linopy/pull/8, https://github.com/PyPSA/linopy/pull/17).
682682

683683

684684
**Breaking changes**

linopy/solvers.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -773,10 +773,10 @@ def get_solver_solution() -> Solution:
773773

774774
class Highs(Solver[None]):
775775
"""
776-
Solver subclass for the Highs solver. Highs must be installed
777-
for usage. Find the documentation at https://www.maths.ed.ac.uk/hall/HiGHS/.
776+
Solver subclass for the HiGHS solver. HiGHS must be installed
777+
for usage. Find the documentation at https://highs.dev/.
778778
779-
The full list of solver options is documented at https://www.maths.ed.ac.uk/hall/HiGHS/HighsOptions.set.
779+
The full list of solver options is documented at https://ergo-code.github.io/HiGHS/stable/options/definitions/.
780780
781781
Some exemplary options are:
782782
@@ -808,8 +808,8 @@ def solve_problem_from_model(
808808
explicit_coordinate_names: bool = False,
809809
) -> Result:
810810
"""
811-
Solve a linear problem directly from a linopy model using the Highs solver.
812-
Reads a linear problem file and passes it to the highs solver.
811+
Solve a linear problem directly from a linopy model using the HiGHS solver.
812+
Reads a linear problem file and passes it to the HiGHS solver.
813813
If the solution is feasible the function returns the
814814
objective, solution and dual constraint variables.
815815
@@ -834,7 +834,7 @@ def solve_problem_from_model(
834834
-------
835835
Result
836836
"""
837-
# check for Highs solver compatibility
837+
# check for HiGHS solver compatibility
838838
if self.solver_options.get("solver") in [
839839
"simplex",
840840
"ipm",
@@ -871,8 +871,8 @@ def solve_problem_from_file(
871871
env: None = None,
872872
) -> Result:
873873
"""
874-
Solve a linear problem from a problem file using the Highs solver.
875-
Reads a linear problem file and passes it to the highs solver.
874+
Solve a linear problem from a problem file using the HiGHS solver.
875+
Reads a linear problem file and passes it to the HiGHS solver.
876876
If the solution is feasible the function returns the
877877
objective, solution and dual constraint variables.
878878
@@ -934,13 +934,13 @@ def _solve(
934934
sense: str | None = None,
935935
) -> Result:
936936
"""
937-
Solve a linear problem from a Highs object.
937+
Solve a linear problem from a HiGHS object.
938938
939939
940940
Parameters
941941
----------
942942
h : highspy.Highs
943-
Highs object.
943+
HiGHS object.
944944
solution_fn : Path, optional
945945
Path to the solution file.
946946
log_fn : Path, optional

0 commit comments

Comments
 (0)