search

iiasa / message_ix

The integrated assessment and energy systems model MESSAGEix
https://docs.messageix.org
Apache License 2.0
112 stars 149 forks source link

Updating install instructions #771

Closed glatterf42 closed 1 month ago

glatterf42 commented 5 months ago 
@glatterf42 since we discussed (in Dec) having both quick-start install instructions and a full install guide, I think it should be mentioned in the latter.

_Originally posted by @khaeru in https://github.com/iiasa/message_ix/issues/769#issuecomment-1883065810_

This issue keeps track of the work to update the install instructions. The main idea is hinted at above: we could create a quick start guide with several assumptions (like GAMS being installed or pip being used etc) and provide more details in another "full installation" guide. This way, people who already have a working system close to what we require might be faster in completing the installation while others don't lose information and might adapt their expectations as to the time needed.

glatterf42 commented 5 months ago

As mentioned by mabudz, our full installation guide would benefit from a colorful note in the "from source" section stating something along the following lines:

Please note that installing message_ix from source usually requires installing ixmp from source as well. If you don't want to do that, be sure to use the same combination of major and minor version, i.e. if message_ix has 3.8.x, ixmp should also have 3.8.x.

glatterf42 commented 5 months ago

Update the release procedure as well: the link in step 8 is broken, it should be https://github.com/iiasa/message_ix/releases. Also in step 8, correct the example for the description or introduce a note that this example is only valid for message_ix.