Skip to content
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
cache
ci
content
data
notebooks
output
raw-data
scripts
webpage
.gitignore
.travis.yml
LICENSE-CC0.md
LICENSE.md
Makefile
README.md
SETUP.md
USAGE.md
datapackage.json
requirements.txt

README.md

Global Emissions (work in progress, unreviewed)

HTML Manuscript PDF Manuscript Build Status

Manuscript description

This manuscript is a work in progress, unreviewed attempt to review currently available greenhouse gas emissions data and combine them into a yearly data source that can e.g. be used in simple climate models.

Manubot

This repository uses the Manubot system for collaborative writing. Manubot is a system for writing scholarly manuscripts via GitHub. Manubot automates citations and references, versions manuscripts using git, and enables collaborative writing via GitHub. See USAGE.md for documentation how to write a manuscript.

Repository directories & files

The directories are as follows:

  • content contains the manuscript source, which includes markdown files as well as inputs for citations and references. See USAGE.md for more information.
  • output contains the outputs (generated files) from the manubot including the resulting manuscripts. You should not edit these files manually, because they will get overwritten.
  • webpage is a directory meant to be rendered as a static webpage for viewing the HTML manuscript.
  • build contains commands and tools for building the manuscript.
  • ci contains files necessary for deployment via continuous integration. For the CI configuration, see .travis.yml.

Local execution

To run the Manubot locally, install the conda environment as described in build. Then, you can build the manuscript on POSIX systems by running the following commands.

# If you haven't already, create the 'manubot' environment
conda env create -f build/environment.yml

# Activate the manubot conda environment (assumes conda version >= 4.4)
conda activate manubot

# Build the manuscript, saving outputs to the output directory
sh build/build.sh

# At this point, the HTML & PDF outputs will have been created. The remaining
# commands are for serving the webpage to view the HTML manuscript locally.

# Configure the webpage directory
python build/webpage.py

# View the manuscript locally at http://localhost:8000/
cd webpage
python -m http.server

Sometimes it's helpful to monitor the content directory and automatically rebuild the manuscript when a change is detected. The following command, while running, will trigger both the build.sh and webpage.py scripts upon content changes:

sh build/autobuild.sh

Continuous Integration

Build Status

Whenever a pull request is opened, Travis CI will test whether the changes break the build process to generate a formatted manuscript. The build process aims to detect common errors, such as invalid citations. If your pull request build fails, see the Travis CI logs for the cause of failure and revise your pull request accordingly.

When a commit to the master branch occurs (for example, when a pull request is merged), Travis CI builds the manuscript and writes the results to the gh-pages and output branches. The gh-pages branch uses GitHub Pages to host the following URLs:

For continuous integration configuration details, see .travis.yml.

License

During development no Creative Commons license is applied. Datasets used for plots are reproduced under their respective licenses.

Once further developed the repository and documents will be released under suitable Creative Commons or similar licenses.

The following files have different licenses:

Files in scripts have the license listed in the respective files or are currently unlicensed.

Please open an issue for any question related to licensing.

You can’t perform that action at this time.