calliope-project / calliope

A multi-scale energy systems modelling framework
https://www.callio.pe
Apache License 2.0
277 stars 89 forks source link

Default installation does not have optional dependencies #579

Closed gnawin closed 2 months ago

gnawin commented 3 months ago

Description

I'm following the documentation to install Calliope using

mamba create -n calliope -c conda-forge/label/calliope_dev -c conda-forge calliope

However, the installation does not come with some dependencies such as plotly or GLPK. It seems to me that they belongs to optional dependencies of the dev version, but using the above command does not install those.

Related links

https://calliope.readthedocs.io/en/v0.7.0.dev3/installation/

Version

Trying to install v0.7.0 dev3

Proposed change

Change the command so Calliope actually comes with the required dependencies.

sjpfenninger commented 3 months ago

Plotly is no longer a dependency because plotting is no longer part of the Calliope core. Stay tuned for a separate visualisation package to come in the next few weeks.

As for GLPK, you are correct - the documentation states that it will be installed, but that doesn't happen, so the documentation needs to be changed.

You can get glpk in the same environment by modifying the installation command like so:

mamba create -n calliope -c conda-forge/label/calliope_dev -c conda-forge calliope glpk

If you want plotly too:

mamba create -n calliope -c conda-forge/label/calliope_dev -c conda-forge calliope glpk plotly

sjpfenninger commented 2 months ago

The (very early stage) visualisation tool is available here now: https://github.com/calliope-project/cview