rjhanes/bioluc

#NEW BIOLUC USERS, PLEASE READ

##Development

####Project Team (alphabetical order): Daniel Inman (National Renewable Energy Laboratory [NREL]), Brian Bush (NREL), Steve Peterson (The Peterson Group), Laura Vimmerstedt (NREL), Ethan Warner (NREL)

####Special Thanks (alphabetical order): Eric Bryant (NREL), Virginia Dale (Oak Ridge National Laboratory [ORNL]), Keith Kline (ORNL), Ben Kuntsman (NREL), Jordan Macknick (NREL) Gbadebo Oladosu (ORNL), John Sheehan (University of Minnesota), Campbell Skinner (Bangor University), Trisha Troop (Aberystwyth University)

####Project Location and Funding Built in Golden, CO within NREL's Strategic Energy Analysis Center. This work was funded by the United States Department of Energy’s Bioenergy Technologies Office under agreement #: DE-AC36-08GO28308

##Licensing

Summary: You are free to copy, adapt, distribute, and transmit the work provided you attribute. You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work).

Please go here for details ##User Guidance

####Github For directions on using Github, please see the Github guide available on the front page of your user profile.

####Software Running simulations requires STELLA 10.0.3. See [ISEE Systems] (http://www.iseesystems.com) for documentation and training related to the STELLA (TM) model.

#####Trial Version Will Allow:

• Running the BioLUC model
• Changing assumptions in the user interface

#####Trial Version Will Not Allow:

• Importing data
• Saving changes to the model

#####Full Version Will Allow:

• Allow access to all the features of the BioLUC model.

####Wiki and Frequently Asked Questions (FAQ) The wiki and FAQ are under development here.

The wiki will include an overview of the BioLUC model, additional guidance for using the BioLUC model, documentation of known modeling limitations and data issues, and a FAQ. The wiki and FAQ that are updated resources permitting.

####Interacting with the BioLUC Development Team We are open to certain questions and to documentation of model bugs. We are not open to questions un related to troubleshooting Github and Stella or , the raising of theoritical land use issues associated with the model or the general topic of land use change.

Options for interactions with the project team:

1. Our prefered method is submission of an issue tickets to Ethan Warner here. Tickets will prevent duplicatation of issues and will allow for public tracking of the project teams response.

2. Email [email protected] or [email protected] directly.

Ethan can direct questions and issues to the appropriate project team member.

##File Structure and Description

####Downloading Users can download a zip file of all the folders by going here: https://github.com/NREL/bioluc/releases

####Models and Data Located within this folder are versions of the BioLUC model. The latest version of the BioLUC model is here.

Two data files associated with latest version of model are located here.

The first file is “Outputs Visualizations.xlsx” which automatically visualizes results exported from BioLUC using the tables in the interface. When exporting data from BioLUC using the interface, the Excel file should already be open. See the “readme” spreadsheet in the “Outputs Visualizations.xlsx” file and directions in the user interface of the BioLUC model for additional directions.

The second file is “BioLUC Data Processing and Model Inputs_2013-10-01.xlsx“ which includes data, data processing, and data documentation associated with BioLUC. This file can be used to understand the sources of data, how data was processed, and multiple alternative scenarios that can be used as input into BioLUC. See the “readme” spreadsheet for details.

An older 2-region version of the model is available here. The 2-region version of the model corresponds to our concept paper in Environmental Research Letters. The 2-region version of the model is only available in version 9.1.4 of STELLA (TM).

####Model Testing This folder includes a presentation that documents the general testing the BioLUC model underwent prior to release. Please note that the presentation is not completely current as it was created prior to testing over the summer 2013. The Sensitivity Analysis folder includes a report and sensitivity analysis completed by Eric Bryant using a semi-final version of the model.

####Workshop at Oak Ridge National Laboratory (ORNL) May 7-8th, 2013 This folder contains documents and presentations used in the land use workshop at ORNL on May 7-8th, 2013. Please note that these documents may not be up to-date.