Repository Structure

The repository has the following structure:

Folder	Subfolder	Subfolder	Subfolder	Contents
example				Example scripts using the code
R				R code (.R files)
	Data Import			Scripts and functions for importing data
	Demand			Scripts and functions for generating finnal demand for a model
	General Functions			Files with general purpose functions
	IO			Scripts and functions for generating econonmic subcomponents and direct requirements
	Model Build Scripts			Scripts for building model components. Note this does not assemble the model components (done in Python)
	Model Tests			Scripts and functions for testing model results that are written to a useeiopy/Model Builds//results folder
	Unit Tests			Scripts and functions for testing model components
SI				Supporting information using to build model components including data files, mapping files, etc.
	BEA			Data from the Bureau of Economic Analysis
	Census			Data from the Census Bureau
	Crosswalk			Various mapping files (e.g. NAICS to BEA to USEEIO for sectors)
	IOMB			Standard data formats from the IO Model Builder used to export model components
	USEEIO			Indicator lists, factors, and other data used specifically for USEEIO
useeiopy				Python package (.py files)
	Model Builds			Container for models built, with each folder representing a model name
		modelname		Final model components as specified by the IO Model Builder 'make_model' function. The files must used standard names that used the modelname followed by a component name. See files in an existing folder for an example. Manually created by user
			results	Created automatically when writing out results from model.
			satellite_files	For writing individual satellite tables (e.g. GHG emissions) in standard IOMB satellite table format. Manually created by user