Welcome!

Welcome to documentation section for the Open Climate Collabathon. This is your user's manual for participating in the event. 📕

This GitBook compiles most of the important information needed to participate in the 2019 Collabathon and contribute to the Open Climate Project. For specific event details and registration, go to the event's main website.👈

The 2019 Collabathon is officially launched!

Watch the kick off speech at the Yale launch event at Yale School of Forestry & Environmental Studies:

Martin Wainstein from Yale Open Lab

​Access more launch event videos including a Climate 101 bootcamp >​

Quick start guide

Here is a video explaining how to get started as a collabathon participant so that you may navigate this GitBook and other relevant digital environments for the event:

Navigating this Site and Its Content

This documentation will enable you to: Find all relevant information to getting started on the Collabathon

​ Select prompts

​ Learn how to submit your hacks

​ Understand the Open Climate project.

The following will give you an outline of the main sections covered in this GitBook:

Getting Started—

Please read this overview section first. It sets the baseline for this Collabathon and introduces you to the event's values and principles as well as guidelines on team collaboration, nodes and prompt hosts.

The Collabathon's Digital Environment—

This section introduces you to all tools used for team assembly, communication, code management, video broadcasting and judging. Please make sure to download and register on all platforms prior to the Collabathon.

Contributing—

Review this section to understand how to submit and contribute your work, deliverables and contribution expectations, collaboration rules, awards and judging guidelines.

About the Open Climate System, Project and Open Source Platform—

This section will explain the difference between the proposed open climate system (the concept of an integrated accounting mechanism), the Open Climate platform (the open source software effort in its initial phase), and the underlying project to further develop, improve and consolidate these in an open innovation process. We use lower case 'open climate' to talk about the system and project, and caps 'Open Climate' to talk about the software product.

The Open Climate platform has been incubated at the Yale Open Lab for the past couple of months, establishing a core foundation of thoughtware and some initial prototype code for you to build on. It has mostly laid out the map of how different part should eventually integrate, and out of that map identified parts come the prompts you will be able to hack on throughout the event. You will find in this section documentation that outlines the proposed architecture of the platform, and general logic. You will also find links to the GitHub repositories of the demo version and the current 'minimum viable product' effort, with an initial database and documentation. .

Prompts—

Prompts are the challenges you will be working on. In this section, you will find the prompts, contribution opportunities and tasks, organized in different categories. We suggest you take a look at 'Navigating Prompts' in the 'Getting Started' section first, or read through Prompt Categories before diving in a choosing a prompt.

FAQ—

The FAQ will be a repository of answers to general questions that come up before and during the Collabathon.

Contributing to this GitBook

This site is a living document that ideally gets enriched throughout the Collabathon. Anyone can contribute! If you have suggested edits to this guideline and participant manual section, be thoughtful and consult with and organising member; if you have contributions to the framing of a prompt, be thoughtful and reach out to the prompt host. Otherwise, feel free to push suggestions and wait for them to get approved.

The aim of this Collabathon is to integrate the contributions from all teams into this platform. Ideally, no code or contribution gets lost. To facilitate this, all teams are expected to document their work in a way that makes their contribution clear and comprehensible, easy to integrate and to be further developed by others. Make sure to document your code in the GitHub repo and to document all other contributions in this GitBook, such as prompt our bounty ideas, strategic assets and thoughtware.

__

Open Source

The spirit of this project is based on an open source culture with a spirit of radical collaboration around a common planetary challenge. Read more to understand the open source definition. Whilst we encourage open source work for dissemination, you can contribute hacks in whatever license you prefer, granted it's a unique and original work that does not use existing software with a different license.

Any work contributed directly to the Open Climate platform has to respect its current license. Back end software code is primarily published under a Lesser General Public License version 3 (LGPL3) in order for its libraries to be compatible within proprietary software— yet ensuring the core platform layer remains open source. Front-end software code of the Open Climate portal is published under an MIT License. Integrated platforms are encouraged to contribute API integration code under respective licenses, as well as define mechanisms by which their existing proprietary software (if any) would interact with the common Open Climate protocol layer via their existing APIs.

Licenses

This GitBook is published under: Creative Commons Attribution 4.0 International Open Climate Platform Core: LGPL-3 Open Climate Front End: MIT License​

------------------------

​​Creative Commons License​ This work is licensed under a Creative Commons Attribution 4.0 International License.