You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+15-4
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,15 @@
1
1
# Handbook
2
+
## Introduction
3
+
[FLINT Handbook](https://moja-global.github.io/Handbook/) is intended to provide an introduction to FLINT so that its readers, regardless of their knowledge level can understand what FLINT aims to accomplish. The FLINT handbook will go over climate science, the problems it poses to our environment, and the steps we can take to mitigate it's effects.
2
4
3
-
This repository contains FLINT Handbook
5
+
The Handbook covers:
6
+
7
+
- Understanding Climate Science and Organizations championing the cause.
8
+
- Use of carbon models like the Generic Carbon Budget Model (GCBM).
9
+
- Introduction to Full Lands and Integration tools.
10
+
- Role of Data Version Control (DVC) in Land Sector Dataset Repos.
11
+
- Running a GCBM Silmulation.
12
+
- Discussion on Climate Science and Projections.
4
13
5
14
## Installation
6
15
@@ -14,9 +23,11 @@ Here are the steps you can follow while setting up the documentation locally.
14
23
15
24
If you choose to setup the documentation website locally, you need to have Python and the Python package manager `pip` on your local machine. Follow the official [Python installation](https://www.python.org/downloads/) to setup Python on your local machine.
16
25
17
-
First make a fork, and then clone the repo:
26
+
First make a fork, and then clone the repo
27
+
28
+
2. Clone the repository
18
29
19
-
2. Clone the repository. Replace the `<GITHUB_USERNAME>` with your GitHub username. You can find your username by clicking on your profile picture in the top right corner of the GitHub website.
30
+
Replace the `<GITHUB_USERNAME>` with your GitHub username. You can find your username by clicking on your profile picture in the top right corner of the GitHub website.
You can now open the Handbook website on `_build/html/index.html` in your browser. Make corresponding changes on the documentation site and then run `make clean && make html` to update the documentation. You can now create a pull request to get your changes merged into the upstream develop branch.
56
+
You can now open the Handbook website on `_build/html/index.html` in your browser. Make corresponding changes on the documentation site and then run `make clean && make html` to update the documentation. You can now create a pull request to get your changes merged into the upstream develop branch.
0 commit comments