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
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
So far **linopy** is available on the PyPI repository

```bash
pip install linopy
uv pip install linopy
```

or on conda-forge
Expand Down Expand Up @@ -159,10 +159,8 @@ Note that these do have to be installed by the user separately.
To set up a local development environment for linopy and to run the same tests that are run in the CI, you can run:

```sh
python -m venv venv
source venv/bin/activate
pip install uv
uv pip install -e .[dev,solvers]
uv sync --extra dev --extra solvers
source .venv/bin/activate
pytest
```

Expand Down
10 changes: 4 additions & 6 deletions doc/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,8 @@ Development Setup
For linting and formatting, we use `ruff <https://docs.astral.sh/ruff/>`_
and run it via `pre-commit <https://pre-commit.com/index.html>`_:

1. Installation ``conda install -c conda-forge pre-commit`` or ``pip install pre-commit``
2. Usage:
* To automatically activate ``pre-commit`` on every ``git commit``: Run ``pre-commit install``
* To manually run it: ``pre-commit run --all-files``
* Install the git hook (once): ``pre-commit install``
* Run manually: ``pre-commit run --all-files``

Running Tests
=============
Expand All @@ -34,7 +32,7 @@ To run the test suite:
.. code-block:: bash

# Install development dependencies
pip install -e .[dev,solvers]
uv sync --extra dev --extra solvers

# Run all tests
pytest
Expand Down Expand Up @@ -75,7 +73,7 @@ When working on performance-sensitive code, use the internal benchmark suite in
.. code-block:: bash

# Install benchmark dependencies
pip install -e ".[benchmarks]"
uv sync --extra benchmarks

# Quick timing benchmarks
pytest benchmarks/ --quick
Expand Down
2 changes: 1 addition & 1 deletion doc/gpu-acceleration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To install it, you have to have the `CUDA Toolkit <https://developer.nvidia.com/
# Follow instructions at: https://developer.nvidia.com/cuda-downloads
# Install cuPDLPx
pip install cupdlpx>=0.1.2
uv pip install "cupdlpx>=0.1.2"
**Features:**

Expand Down
17 changes: 7 additions & 10 deletions doc/prerequisites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ Before you start, make sure you have the following:
Install Linopy
--------------

You can install Linopy using pip or conda. Here are the commands for each method:
You can install Linopy using uv or conda. Here are the commands for each method:

.. code-block:: bash

pip install linopy
uv pip install linopy

or

Expand Down Expand Up @@ -51,15 +51,12 @@ required:

.. code:: bash

pip install linopy[solvers]
uv pip install "linopy[solvers]"


We recommend installing the HiGHS solver, which is free, open source, and
fast across a wide range of problem sizes:

.. code:: bash

pip install highspy
We recommend the HiGHS solver, which is free, open source, and fast
across a wide range of problem sizes. It is included in both the
``solvers`` and ``dev`` extras.


GPU-accelerated solvers
Expand All @@ -73,7 +70,7 @@ For large-scale optimization problems, GPU-accelerated solvers can provide signi

.. code:: bash

pip install cupdlpx
uv pip install cupdlpx


For most of the other solvers, please click on the links to get further installation information.
Expand Down
2 changes: 1 addition & 1 deletion examples/solve-on-remote.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"\n",
"## What you need for SSH remote solving\n",
"\n",
"* A running installation of paramiko on your local machine (`pip install paramiko`)\n",
"* The `remote` extra installed on your local machine (`uv pip install \"linopy[remote]\"`), which pulls in `paramiko`\n",
"* A remote server with a working installation of linopy (e.g., in a conda environment)\n",
"* SSH access to that machine\n",
"\n",
Expand Down
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ oetc = [
"google-cloud-storage",
"requests",
]
remote = [
"paramiko",
]
docs = [
"ipython==8.26.0",
"numpydoc==1.7.0",
Expand Down
Loading