camirmas / albatross

A wind resource data retrieval, visualization, and analysis toolkit.
MIT License
0 stars 1 forks source link
resource-assessment wind wind-energy wind-turbine

albatross 🐦

example workflow

A wind resource data retrieval, visualization, and analysis toolkit.

albatross is a Python package designed for wind energy analysis and visualization. It utilizes NREL's Wind Integration National Dataset (WIND) Toolkit and REsource eXtraction (rex) package, and is inspired in part by a similar package aimed instead at Marine Renewable Energy, MHKiT.

Features

albatross consists of two primary modules:

Future enhancements:

Documentation

Documentation is hosted at Read the Docs.

To build the documentation locally, run the following after installing development dependencies:

cd docs
make html

Afterwards, open _build/index.html in a browser.

Installation

albatross has not yet been hosted on PyPI, so for now, install from Github:

pip install git+https://github.com/camirmas/albatross

If you'll be using the requests module, you'll also need to configure HSDS.

Usage

After installation, run Jupyter notebook Usage.ipynb for fully detailed examples.

Development

For development, simply clone the repository, install dependencies, and run tests.

git clone git@github.com:camirmas/albatross.git
pip install -r requirements.txt
pytest