Remove cbc from requirements file (it isn't available on pypi) and update docs

Author: brynpickering

.github/workflows/commit-ci.yml

@@ -33,6 +33,7 @@ jobs:
         create-args: >-
           -f requirements/dev.txt
           python=3.11
+          coin-or-cbc
           gurobi::gurobi
         post-cleanup: all
         cache-environment: true

.github/workflows/pr-ci.yml

@@ -52,6 +52,7 @@ jobs:
           -f requirements/dev.txt
           curl
           python=3.${{ matrix.py3version }}
+          coin-or-cbc
           gurobi::gurobi
         post-cleanup: all
         cache-environment: true

README.md

@@ -37,7 +37,7 @@ Calliope comes with several built-in analysis and visualisation tools. Having so
 
 ## Quick start
 
-Calliope can run on Windows, macOS and Linux. Installing it is quickest with the `mamba` package manager by running a single command: `mamba create -c conda-forge -n calliope calliope`.
+Calliope can run on Windows, macOS and Linux. Installing it is quickest with the `mamba` package manager by running a single command: `mamba create -n calliope -c conda-forge/label/calliope_dev -c conda-forge calliope`.
 
 See the documentation for more [information on installing](https://calliope.readthedocs.io/en/stable/user/installation.html).
 

docs/contributing.md

@@ -36,7 +36,7 @@ To create a development environment for calliope, with all libraries required fo
 1. Open the command line (or the "miniforge prompt" in Windows).
 1. Download (a.k.a., clone) the calliope repository: `git clone git@github.com:calliope-project/calliope.git`
 1. Change into the `calliope` directory: `cd calliope`
-1. Create the calliope mamba environment: `mamba create -n calliope -c conda-forge --file requirements/base.txt --file requirements/dev.txt gurobi::gurobi`
+1. Create the calliope mamba environment: `mamba create -n calliope -c conda-forge --file requirements/base.txt --file requirements/dev.txt coin-or-cbc gurobi::gurobi`
 1. Activate the calliope mamba environment: `mamba activate calliope`
 1. Install the calliope package into the environment, in editable mode and ignoring dependencies (we have dealt with those when creating the mamba environment): `pip install --no-deps -e .`
 1. Install the interactive python shell (necessary when testing our documentation locally): `ipython kernel install --user --name=calliope_docs_build`
@@ -46,7 +46,7 @@ All together:
 ``` shell
 git clone git@github.com:calliope-project/calliope.git
 cd calliope
-mamba create -n calliope -c conda-forge --file requirements/base.txt --file requirements/dev.txt gurobi::gurobi
+mamba create -n calliope -c conda-forge --file requirements/base.txt --file requirements/dev.txt coin-or-cbc gurobi::gurobi
 mamba activate calliope
 pip install --no-deps -e .
 ipython kernel install --user --name=calliope_docs_build

docs/installation.md

@@ -27,7 +27,7 @@ With the package manager installed, you can create a new environment called `cal
 Run the following command in a terminal or command-line window:
 
 ```shell
-mamba create -n calliope -c conda-forge/label/calliope_dev -c conda-forge calliope coin-or-cbc
+mamba create -n calliope -c conda-forge/label/calliope_dev -c conda-forge calliope
 ```
 
 !!! note
@@ -49,11 +49,9 @@ mamba activate calliope
 
 ## Updating an existing installation
 
-If following the recommended installation method above, the following command, assuming the mamba environment is active, will update Calliope to the newest version
-
-```bash
-mamba update -c conda-forge calliope
-```
+We recommend that if you want to update an existing installation, you re-create your environment from scratch.
+This will mitigate any possible unwanted updates to additional dependencies that you may have installed into your environment since you first created it.
+Therefore, run the same command found in the [recommended installation instructions](#recommended-installation-method) and say yes when prompted about whether you want to overwrite the existing environment.
 
 ## Choosing a solver
 
@@ -66,12 +64,12 @@ This list is not exhaustive; any solvers [supported by Pyomo](https://pyomo.read
 ### CBC
 
 [CBC](https://github.com/coin-or/Cbc) is our recommended option if you want a free and open-source solver.
-If you do not have it in your working environment (i.e. there is nothing listed when you call `conda list cbc`) then it can be installed by running `mamba install -c conda-forge coin-or-cbc`.
+If you do not have it in your working environment (i.e. there is nothing listed when you call `conda list cbc`) then it can be installed by running `mamba install conda-forge::coin-or-cbc`.
 
 ### GLPK
 
 [GLPK](https://anaconda.org/conda-forge/glpk) is free and open-source, but can take too much time and/or too much memory on larger problems.
-`GLPK` can be installed from `conda-forge` on all platforms: `mamba install -c conda-forge glpk`.
+`GLPK` can be installed from `conda-forge` on all platforms: `mamba install conda-forge::glpk`.
 Unlike [CBC](#cbc), it is possible to extract [shadow prices](./advanced/shadow_prices.md) from a model solved with GLPK, which is why you may with to use it instead of CBC.
 
 ### Gurobi

requirements/base.txt

@@ -2,7 +2,7 @@ bottleneck >= 1
 click >= 8
 geographiclib >= 2
 ipdb >= 0.13
-ipykernel < 7
+ipykernel >= 6
 jinja2 >= 3
 jsonref >= 1.1
 jsonschema >= 4

requirements/dev.txt

@@ -1,4 +1,3 @@
-coin-or-cbc >= 2.10
 glpk == 5.0
 jsonschema2md >= 1
 mkdocs >= 1.5