Skip to content

Commit

Permalink
Updated README.md file
Browse files Browse the repository at this point in the history
Updated README.md file to add table of contents but still some content is - - - missing from the author's side such as  Troubleshooting and FAQ missing for common problems faced during project setup and also missing acknowledgment.
- CONTRIBUTING.md file missing
- Code of Conduct added
- Citation file missing
  • Loading branch information
Moiz101-ch committed Jan 19, 2025
1 parent 3369515 commit 9db5c82
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
# Table of Contents

- [Table of Contents](#table-of-contents)
- [Publications](#publications)
- [Graph-based Neural Weather Prediction for Limited Area Modeling](#graph-based-neural-weather-prediction-for-limited-area-modeling)
- [Probabilistic Weather Forecasting with Hierarchical Graph Neural Networks](#probabilistic-weather-forecasting-with-hierarchical-graph-neural-networks)
- [Modularity](#modularity)
- [Installing Neural-LAM](#installing-neural-lam)
- [Using `pdm`](#using-pdm)
- [Using `pip`](#using-pip)
- [Using Neural-LAM](#using-neural-lam)
- [Data (the `DataStore` and `WeatherDataset` classes)](#data-the-datastore-and-weatherdataset-classes)
- [MDP (mllam-data-prep) Datastore - `MDPDatastore`](#mdp-mllam-data-prep-datastore---mdpdatastore)
- [NpyFiles MEPS Datastore - `NpyFilesDatastoreMEPS`](#npyfiles-meps-datastore---npyfilesdatastoremeps)
- [Graph creation](#graph-creation)
- [Weights \& Biases Integration](#weights--biases-integration)
- [Train Models](#train-models)
- [Graph-LAM](#graph-lam)
- [Hi-LAM](#hi-lam)
- [Hi-LAM-Parallel](#hi-lam-parallel)
- [Evaluate Models](#evaluate-models)
- [Repository Structure](#repository-structure)
- [Format of graph directory](#format-of-graph-directory)
- [Mesh hierarchy format](#mesh-hierarchy-format)
- [Development and Contributing](#development-and-contributing)
- [Contact](#contact)

[![slack](https://img.shields.io/badge/slack-join-brightgreen.svg?logo=slack)](https://join.slack.com/t/ml-lam/shared_invite/zt-2t112zvm8-Vt6aBvhX7nYa6Kbj_LkCBQ)
![Linting](https://github.com/mllam/neural-lam/actions/workflows/pre-commit.yml/badge.svg?branch=main)
[![test (pdm install, gpu)](https://github.com/mllam/neural-lam/actions/workflows/ci-pdm-install-and-test-gpu.yml/badge.svg)](https://github.com/mllam/neural-lam/actions/workflows/ci-pdm-install-and-test-gpu.yml)
Expand Down

0 comments on commit 9db5c82

Please sign in to comment.