Skip to content

Latest commit

 

History

History
103 lines (72 loc) · 3.42 KB

README.md

File metadata and controls

103 lines (72 loc) · 3.42 KB
Raw

🔌 Denki Carbon 🔌

Calculating the current Carbon Intensity of the Japanese Electrical Grid. This is a fully open project aiming to make it easier to access and use the public information grid operators are already providing, we aim to mirror the simplicity and usefulness of the UK project carbonintensity.org.uk

The project includes:

  • A Scraper, to get data from the Japanese electrical operators, both live and historic.
  • A Machine Learning process to create models which make predictions about the future carbon intensity.
  • An API to present the data.
  • A Frontend to visually display the data.

Links

Main Technology Used

  • Bun for the runtime
  • Postgres for the Database
  • Drizzle for the ORM
  • Elysia for the API
  • TensorflowJS for the machine learning and prediction systems
    • Note: Getting TensorflowJS to work in the Bun runtime may require using npm to help sort out depenancy issues. Try npm rebuild @tensorflow/tfjs-node --build-addon-from-source if you see errors during runtime
  • React for the frontend website

Quickstart

Bun is used for the runtime, so please install it here: https://bun.sh/

First off, ensure that you've created .env files in each repo and populated them with the right values. Use the ...example files as a template.

Database and Seeding the data

You need to set up a Postgres Database and create a user (https://www.postgresql.org/download/)

cd denki-carbon
bun install
bun migrate

# Scrape all data and make a prediction for all TSOs
bun seed

Running the API

cd denki-carbon
bun install
bun dev

# Or, in production
bun start

Creating new Models

You must have already seeded data to the database for this to work...

cd denki-carbon
bun install
bun train

New models will be written to the /temp folder. If you want to propose a model for use in the main app, move the whole folder into the /src/forecast/models folder and remove the old folder for that utility.

Docker

First ensure you have docker and docker-compose installed, then:

cd denki-carbon
bun install
bun up

Deployment

Currently I self host everything at denkicarbon.jp using:

  • A Hetzner instance for the server itself
    • I'm able to run everything in this repo and more with their most basic offering
  • Coolify to manage the CICD and Docker containers

Some external services I use are:

  • Cloudflare for DNS wrangling and some other nice features
  • Grafana Cloud I could probably self host this, but the free tier was good enough

How to Contribute

  • Create an Issue to Explain your Problem, Feature or pick up an existing one, do leave a comment and feel free to ask questions 😁
  • Fork the Project
  • Clone Locally and Install Dependancies
  • Ensure you can run the API/Frontend etc. locally
  • Make and commit your changes
  • Open a PR to the master branch of this repo with a detailed explanation of your work (inc. screenshots)
  • Guidelines in CONTRIBUTING.md