Minor improvements (#190)

Author: staadecker

.gitignore

@@ -13,4 +13,4 @@ site
 .idea
 src/pyoframe/_version.py
 htmlcov/
-.snakemake
+.snakemake/

pyproject.toml

@@ -1,5 +1,8 @@
 [build-system]
-requires = ["setuptools>=61.0", "setuptools-scm>=8"]
+requires = [
+    "setuptools>=61.0",
+    "setuptools-scm>=8", # Sets the package version based on git tags
+]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -18,10 +21,9 @@ classifiers = [
 ]
 dependencies = [
     "polars~=1.0",
-    "numpy",
     "pyarrow",
     "pandas",
-    "pyoptinterface>=0.4.1,<1",
+    "pyoptinterface==0.5.1", # pinned to avoid broken versions
 ]
 
 [project.optional-dependencies]
@@ -44,7 +46,7 @@ dev = [
     # (we don't pin since we want to test against the latest)
     "highsbox",
     "pyoptinterface[nlp]",
-    "llvmlite<=0.44.0",    # Remove once issue is fixed: https://github.com/metab0t/PyOptInterface/issues/56
+    "numpy",               # for testing with np.nan, don't pin so that two versions of Python are possible
 ]
 # We split out docs because mkdocs-awesome-nav is not compatible with Python 3.9
 docs = [
@@ -82,7 +84,7 @@ ignore = [
 ]
 
 [tool.ruff.lint.per-file-ignores]
-"{docs,tests,scripts}/**" = ["D101", "D102", "D103", "D104"]
+"{docs,tests,scripts,benchmarks}/**" = ["D101", "D102", "D103", "D104"]
 "conftest.py" = ["D"]
 
 [tool.ruff.lint.pydocstyle]
@@ -95,15 +97,18 @@ docstring-code-format = true
 include = ["src/pyoframe/*"]
 
 [tool.pytest.ini_options]
-pythonpath = "src"
-addopts = "--doctest-modules --ignore=scripts"
-filterwarnings = ["error"]                     # treat all warnings as errors
+pythonpath = "src"                                                 # https://stackoverflow.com/a/50156706/5864903
+addopts = "--doctest-modules --ignore=scripts --ignore=benchmarks"
+filterwarnings = ["error"]                                         # treat all warnings as errors
 doctest_optionflags = "NORMALIZE_WHITESPACE"
 
 [tool.setuptools_scm]
 version_file = "src/pyoframe/_version.py"
 local_scheme = "no-local-version"
 
+[tool.setuptools.package-dir]
+pyoframe = "src/pyoframe"
+
 [project.urls]
 Homepage = "https://bravos-power.github.io/pyoframe/latest"
 documentation = "https://bravos-power.github.io/pyoframe/latest"

tests/examples/facility_location/model.py

@@ -3,15 +3,12 @@
 Inspired from the original JuMP paper.
 """
 
-import os
-from pathlib import Path
-
 import polars as pl
 
 import pyoframe as pf
 
 
-def solve_model(use_var_names, G=4, F=3):
+def solve_model(use_var_names=False, G=4, F=3):
     model = pf.Model(solver_uses_variable_names=use_var_names, sense="min")
 
     g_range = range(G)
@@ -103,13 +100,5 @@ def draw_results(model, G, F):
 
 if __name__ == "__main__":
     G, F = 4, 3
-    working_dir = Path(os.path.dirname(os.path.realpath(__file__)))
-    model = solve_model(
-        G,
-        F,
-        solver="gurobi",
-        directory=working_dir / "results",
-        use_var_names=True,
-        solution_file=working_dir / "results" / "pyoframe-problem.sol",
-    )
+    model = solve_model(G=G, F=F)
     draw_results(model, G, F)

tests/test_objective.py

@@ -6,10 +6,6 @@
 
 
 def test_get_obj_value(solver):
-    if solver.name == "ipopt":
-        pytest.skip(
-            "See issue: https://github.com/metab0t/PyOptInterface/issues/51 for details."
-        )
     m = pf.Model(solver=solver)
     m.X = pf.Variable(ub=5)