Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add installation instructions to the readme
Browse files Browse the repository at this point in the history
willu47 committed Oct 19, 2023
1 parent 8227222 commit 1605382
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/)

0 comments on commit 1605382

Please sign in to comment.