https://github.com/OnSSET/onsset

The code of the Open Source Spatial Electrification Tool (OnSSET)
https://github.com/OnSSET/onsset

Last synced: 3 months ago
JSON representation

The code of the Open Source Spatial Electrification Tool (OnSSET)

• Host: GitHub
• URL: https://github.com/OnSSET/onsset
• Owner: OnSSET
• License: other
• Created: 2019-05-27T15:17:54.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-19T15:04:55.000Z (11 months ago)
• Last Synced: 2024-04-14T16:15:15.821Z (7 months ago)
• Language: Python
• Homepage: http://www.onsset.org
• Size: 41.4 MB
• Stars: 25
• Watchers: 6
• Forks: 29
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• open-sustainable-technology - onsset - A GIS based optimization tool that has been developed to support electrification planning and decision making for the achievement of energy access goals in currently unserved locations. (Energy Systems / Energy System Modeling Frameworks)

README

        
onsset : Open Source Spatial Electrification Tool

=================================================

[![PyPI version](https://badge.fury.io/py/onsset.svg)](https://badge.fury.io/py/onsset)

[![Build Status](https://travis-ci.com/OnSSET/onsset.svg?branch=master)](https://travis-ci.com/OnSSET/onsset)

[![Coverage Status](https://coveralls.io/repos/github/OnSSET/onsset/badge.svg?branch=master)](https://coveralls.io/github/OnSSET/onsset?branch=master)

[![Documentation Status](https://readthedocs.org/projects/onsset/badge/?version=latest)](https://onsset.readthedocs.io/en/latest/?badge=latest)

# Scope

This repository contains the source code of the Open Source Spatial Electrification Tool

([OnSSET](http://www.onsset.org/)).

The repository also includes sample test files available in ```.\test_data```

and sample output files available in ```.\sample_output```.

## Installation

### Requirements

OnSSET requires Python > 3.5 with the following packages installed:

- et-xmlfile

- jdcal

- numpy

- openpyxl

- pandas

- python-dateutil

- pytz

- six

- xlrd

- notebook

- seaborn

- matplotlib

- scipy

### Install with pip

Install onsset from the Python Packaging Index (PyPI):

```

pip install onsset

```

### Install from GitHub

Download or clone the repository and install the package in `develop`

(editable) mode:

```

git clone https://github.com/onsset/onsset.git

cd onsset

python setup.py develop

```

## Contact

For more information regarding the tool, its functionality and implementation

please visit https://www.onsset.org or contact the development team

at [email protected].