moja-global / moja_global_docs

Repository to host the moja global technical documentation
https://docs.moja.global/en/master/
Mozilla Public License 2.0
35 stars 69 forks source link

Documentationđź“„: 'Understanding FLINT' needs to be more structured #210

Open anushatomar13 opened 1 year ago

anushatomar13 commented 1 year ago

What is the current documentation state?

Understanding FLINT

Countries recognise the importance of improving decision making and supporting land sector policies to reduce greenhouse gas (GHG) emissions and increase removals. At the same time, there is heightened attention globally on transparency in climate action to support the goals of the Paris Agreement and in supporting transitions to achieve the Sustainable Development Goals. The Full Lands Integration Tool (FLINT) is an open-source platform to estimate emissions and removals of greenhouse gases from the land sector using modules that perform specific analyses of carbon flows.

The FLINT is a second-generation tool aimed to facilitate the implementation and operation of land sector emissions estimation systems worldwide. It was developed through cooperation between Kenya, Australia and Canada and incorporates lessons learned from the development of the CBM-CFS3 (Canada) and FullCAM (Australia). Some core features are:

The FLINT provides a framework to progressively develop MRV-related systems, data and capacities. By this means, countries can start with simple implementations using existing global data sets (Tier 1) and then gradually move to more complex calculation approaches, using national and regional information (Tier 2 or 3).

The basic role of the FLINT is to coordinate the interaction of data (e.g. spatial data, non-spatial data, carbon pools, variables, fluxes) and modules. It also manages computational outputs. FLINT-compatible modules are discreet software packages that can be attached to the FLINT. It is possible to differentiate between calculation modules and functionality modules. Calculation modules can change the state of variables and pools for pixels over a sequence of steps. Functionality modules do not apply changes to variables or pools but affect the utility of the FLINT by e.g. aggregating data or generating outputs.

A unique configuration of modules attached to the FLINT is referred to as implementation (described in the picture below). Existing FLINT implementations are SLEEK-FLINT, GCBM and FLINTpro. SLEEK-FLINT uses the Chapman-Richards function as the basis of one of it’s forest growth models. GCBM uses growth-and-yield curves that describe the relationship between stand age and stand volume.

Where is this stated?

I copied the above statement/content from 'Understanding FLINT' section under the 'FLINT' section of the documentation of Moja Global. I have provided the link to the particular section of documentation for reference.

https://docs.moja.global/en/master/FLINT/UnderstandingFLINT/index.html

Why do you want to improve the statement?

This part of the documentation is plainly written as it has no structure or sub-headings. When a reader would glance at the documentation, chances are it might not interest them very much. To resolve this, the documentation could be structured, improvised, and important points could be highlighted so that readers of all age groups could understand it and find it interesting and appealing.

Proposed Statement

I am convinced that well-organized documentation holds greater appeal and comprehension for readers. Hence, I wish to structure the features, to present them in a coherent and easy-to-follow manner. I wish to give titles to each feature and explain each one of them in a simple language. To enhance clarity, I believe explanations should be re-written into simplified terms, ensuring accessibility for all readers.

Furthermore, key terms that I believe are important, should be highlighted. This emphasis will draw immediate attention to essential concepts, thereby encouraging readers to delve into the complete documentation. I aim to enhance the engagement and thorough understanding of the material for all readers.

Additional context.

No response