GCBMx

🚧🚧🚧🚧

A FLINT client, written in Vue, to provide an awesome user interface for configuring simulations using the FLINT.Cloud APIs

This is experimental and incomplete. The framework may be a useful starting point for new users who wish to create their own interface

🚧🚧🚧🚧

GCBMx - Greenhouse Gas Accounting Automation Tool

Project Overview

The GCBMx project is focused on developing and deploying a comprehensive tool that automates various tasks related to Greenhouse Gas (GHG) accounting using the Generic Carbon Budget Model (GCBM). The tool integrates multiple functionalities, including:

• Configuration Management
• Data Management
• Simulation Configuration
• Data Preprocessing
• Visualization of Results
• Data Export

By streamlining these processes, GCBMx aims to facilitate efficient GHG accounting and help users analyze environmental data more effectively.

Key Features

• Automated Data Fetching: GCBMx automates the process of fetching relevant datasets.
• Data Preprocessing: Provides preprocessing functionality for both vector and raster datasets.
• Simulation Configuration: Automates the configuration of simulation models using GCBM, simplifying the setup process.
• Visualization Tools: Supports visualizing results through intuitive plots and dashboards.
• Data Export: Enables easy export of results for further analysis or reporting purposes.

Project Phases

The project follows a phased approach to ensure proper planning, development, and deployment:

1. Design and Planning In this phase, the project scope, features, and technical requirements are defined. It includes:

   • Identifying project goals and target users.
   • Drafting a technical plan for integrating GCBM with data management and visualization tools.

2. Development The core functionalities of GCBMx are implemented in this phase, including:

   • Creating APIs for fetching and processing data.
   • Building interfaces for managing configurations and visualizing results.

3. Testing During this phase, the tool is rigorously tested to ensure all functionalities work as expected, including:

   • Unit and integration tests for APIs and components.
   • End-to-end testing of the GHG accounting workflow.

4. Deployment The final phase involves deploying the tool into a production environment using Docker Compose. The deployed tool will be publicly accessible and ready for use by end users.

System Requirements

• Docker and Docker Compose are required to build and run the services.
• Basic knowledge of GHG accounting and the GCBM model is recommended for users.

Setup and Installation

Prerequisites

1. Install Docker and Docker Compose.
2. At least 4GB RAM
3. 10GB free disk space
4. Internet connection

Installation Options

Option 1: Building from Source (Typical developer option)

1. Clone the project repository:

   git clone https://github.com/yourusername/GCBMx.git
   cd gcbmx
   

2. Build and run using docker-compose

   docker-compose up -d --build
   

Option 2: Using Pre-built Images from Docker Hub (Typical user option)

1. Copy the docker-compose.yml from the repo GCBMx docker compose

   docker-compose -f docker-compose.yml up -d
   

Verification and usage

• Check if containers are running

  docker-compose ps
  

Common commands

• Start the application

  docker-compose up -d
  

• Stop the application

  docker-compose down
  

Updating the Application

• For source-built version

  git pull
  docker-compose down
  docker-compose up -d --build
  

• For Docker Hub version

  docker-compose -f docker-compose.yml down
  docker-compose -f docker-compose.yml pull
  docker-compose -f docker-compose.yml up -d
  

Read More

Find more comprehensive details about Moja Global Contributing Guidelines here..

How to Get Involved?

moja global welcomes a wide range of contributions as explained in Contributing document and the About moja-global Wiki.

FAQ and Other Questions

• You can find FAQs on the Wiki.
• If you have a question about the code, submit user feedback in the relevant repository
• If you have a general question about a project or repository or moja global, join moja global and
  • submit a discussion to the project, repository or moja global team
  • submit a message to the relevant channel on moja global's Slack workspace.
• If you have other questions, please write to [email protected]

Contributors

Thanks go to these wonderful people (emoji key):

moja global 📆

This project follows the all-contributors specification. Contributions of any kind are welcome!

Maintainers Reviewers Ambassadors Coaches

The following people are Maintainers, Reviewers, Ambassadors, or Coaches.

moja global 📆

• Maintainers review and accept proposed changes
• Reviewers check proposed changes before they go to the Maintainers
• Ambassadors are available to provide training related to this repository
• Coaches are available to provide information to new contributors to this repository

License

This project is released under the Mozilla Public License Version 2.0.