gboone / doi-extractives-data

Information on the extractive industries in the U.S. from Federal data.

U.S. Extractive Industries Data and Information

What

The U.S. earns revenue on natural resources extracted from its Federal lands, both onshore and offshore. This is a major source of revenue for both the country and local municipalities, and includes revenue from resources such as oil, gas, coal and geothermals.

This repository contains the code for useiti.doi.gov, which is a website that includes both curated content and raw data that will inform the national and international conversation around extractive industries revenue. It will provide a valuable resource for data and information analysis and visualizations that can be readily understood and accessed by the public for re-use through other media and applications.

Why

This effort is part of the President’s Open Government Partnership National Action Plan, which commits the U.S. to ensuring that taxpayers are receiving every dollar due for extraction of the U.S.’s natural resources.

The U.S. also recently became a part of an international standard called the Extractive Industries Transparency Initiative (EITI). EITI is a global coalition of governments, companies and civil society working together to improve openness and accountable management of revenues from natural resources. For more information on the U.S. process of implementing the EITI standard, see the USEITI homepage. The U.S. will be the first developed country to sign on to and follow the standard.

About this website

This is the development branch of the v2 US EITI site.

Data

The data catalog explains what most of the data is and where it came from. See the data directory for more detailed info and instructions on updating the data.

Running the Site

This site is made with Jekyll. To run it locally, clone this repository then:

1. Get Jekyll and the necessary dependencies: bundle install
2. Run the web server: bundle exec jekyll serve (or just jekyll serve if you have Jekyll installed globally)
3. Visit the local site at http://localhost:4000

Deployment

This site is deployed on Federalist, and will one day be deployed automatically whenever commits are pushed to the master branch. For now, see the preview URLs wiki page for more information.

Styleguide

npm install --dev
npm run init-styleguide
npm run watch

Tests

The JavaScript tests currently only cover a small portion of data processing utilities. You can run them with Node:

npm install --dev
npm test

Code Style

We use Hound CI to enforce SCSS and JavaScript formatting conventions on new commits. You can run both of the linters with:

npm run lint

This runs both of the linters below in series.

JavaScript Linting

Hound uses jshint, which you can install as part of the npm package's devDependencies with:

npm install --dev

Or you can install it globally with npm i -g jshint. Then, to lint the JavaScript, run:

npm run lint-js

SCSS Linting

Hound uses scss-lint, which you can install with gem install scss_lint if you haven't already run bundle install to get Jekyll and its dependencies. To lint the SCSS files, run:

bundle exec scss-lint -c .scss-lint.yml

or simply:

npm run lint-scss

Roadmap

Broadly, we are working now on:

• Exploring how lease contract information and data can be integrated into the site in a way that meets user needs
• Exploring how production data can be added to the site in a way that meets user needs
• Develop site information architecture so that it is clear that it is a part of USEITI, can accomodate new datasets and has a stronger 'why you're here and why you should care' message
• Reaching out to users to see how we did with the Beta, and learn from them where to head next

For a more detailed roadmap, please see our repository's wiki.

Contributing

Content and feature suggestions are welcome via GitHub Issues. Code contributions are welcome via pull request, although of course we cannot guarantee your changes will be included in the site.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.