From 1605382e9e2ffdeec732afeab30cf7513ef203ac Mon Sep 17 00:00:00 2001 From: Will Usher Date: Thu, 19 Oct 2023 13:16:55 +0200 Subject: [PATCH] Add installation instructions to the readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index abe6d08..56a60d0 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,22 @@ This repository contains a set of scripts to conduct model runs with limited foresight with OSeMOSYS models. +# Installation + +You can use pip to install the package directly from Github: + + pip install git+https://github.com/KTH-dESA/OSeMOSYS_step.git@main#egg=osemosys_step + +While in development phase, you can test this like so: + + pip install --dry-run git+https://github.com/KTH-dESA/OSeMOSYS_step.git@packaging#egg=osemosys_step + +Or you install a development version like so: + + git clone https://github.com/KTH-dESA/OSeMOSYS_step.git osemosys_step + cd osemosys_step + pip install -e . + # Development OSeMOSYS_step is packaged using [hatchling](https://hatch.pypa.io/latest/)