From 920e71cdff8dc5c6e58d859bdfdac298dd7e67d8 Mon Sep 17 00:00:00 2001 From: 245623733333 Date: Sat, 21 Mar 2026 19:38:19 +0530 Subject: [PATCH 1/2] Fix stale create_mesh references in README (Fixes #464) --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 46a077b79..0d0a7ef0f 100644 --- a/README.md +++ b/README.md @@ -391,7 +391,7 @@ python -m neural_lam.datastore.npyfilesmeps.compute_standardization_stats --name multiscale` @@ -530,13 +530,13 @@ The structure is shown with examples below: ``` graphs ├── graph1 - Directory with a graph definition -│ ├── m2m_edge_index.pt - Edges in mesh graph (neural_lam.create_mesh) -│ ├── g2m_edge_index.pt - Edges from grid to mesh (neural_lam.create_mesh) -│ ├── m2g_edge_index.pt - Edges from mesh to grid (neural_lam.create_mesh) -│ ├── m2m_features.pt - Static features of mesh edges (neural_lam.create_mesh) -│ ├── g2m_features.pt - Static features of grid to mesh edges (neural_lam.create_mesh) -│ ├── m2g_features.pt - Static features of mesh to grid edges (neural_lam.create_mesh) -│ └── mesh_features.pt - Static features of mesh nodes (neural_lam.create_mesh) +│ ├── m2m_edge_index.pt - Edges in mesh graph (neural_lam.create_graph) +│ ├── g2m_edge_index.pt - Edges from grid to mesh (neural_lam.create_graph) +│ ├── m2g_edge_index.pt - Edges from mesh to grid (neural_lam.create_graph) +│ ├── m2m_features.pt - Static features of mesh edges (neural_lam.create_graph) +│ ├── g2m_features.pt - Static features of grid to mesh edges (neural_lam.create_graph) +│ ├── m2g_features.pt - Static features of mesh to grid edges (neural_lam.create_graph) +│ └── mesh_features.pt - Static features of mesh nodes (neural_lam.create_graph) ├── graph2 ├── ... └── graphN @@ -546,9 +546,9 @@ graphs To keep track of levels in the mesh graph, a list format is used for the files with mesh graph information. In particular, the files ``` -│ ├── m2m_edge_index.pt - Edges in mesh graph (neural_lam.create_mesh) -│ ├── m2m_features.pt - Static features of mesh edges (neural_lam.create_mesh) -│ ├── mesh_features.pt - Static features of mesh nodes (neural_lam.create_mesh) +│ ├── m2m_edge_index.pt - Edges in mesh graph (neural_lam.create_graph) +│ ├── m2m_features.pt - Static features of mesh edges (neural_lam.create_graph) +│ ├── mesh_features.pt - Static features of mesh nodes (neural_lam.create_graph) ``` all contain lists of length `L`, for a hierarchical mesh graph with `L` layers. For non-hierarchical graphs `L == 1` and these are all just singly-entry lists. @@ -559,10 +559,10 @@ In addition, hierarchical mesh graphs (`L > 1`) feature a few additional files w ``` ├── graph1 │ ├── ... -│ ├── mesh_down_edge_index.pt - Downward edges in mesh graph (neural_lam.create_mesh) -│ ├── mesh_up_edge_index.pt - Upward edges in mesh graph (neural_lam.create_mesh) -│ ├── mesh_down_features.pt - Static features of downward mesh edges (neural_lam.create_mesh) -│ ├── mesh_up_features.pt - Static features of upward mesh edges (neural_lam.create_mesh) +│ ├── mesh_down_edge_index.pt - Downward edges in mesh graph (neural_lam.create_graph) +│ ├── mesh_up_edge_index.pt - Upward edges in mesh graph (neural_lam.create_graph) +│ ├── mesh_down_features.pt - Static features of downward mesh edges (neural_lam.create_graph) +│ ├── mesh_up_features.pt - Static features of upward mesh edges (neural_lam.create_graph) │ ├── ... ``` These files have the same list format as the ones above, but each list has length `L-1` (as these edges describe connections between levels). From 16b30e9bb30ad7e7864bcfde513298c2e261f940 Mon Sep 17 00:00:00 2001 From: 245623733333 Date: Sat, 21 Mar 2026 19:48:27 +0530 Subject: [PATCH 2/2] Add CONTRIBUTING.md for new contributors (Fixes #406) --- CONTRIBUTING.md | 115 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 115 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..616add2f3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,115 @@ +# Contributing to Neural-LAM + +Thank you for your interest in contributing to Neural-LAM! 🎉 + +We welcome contributions of all kinds, including bug fixes, documentation improvements, and new features. + +--- + +## 🛠️ Getting Started + +### 1. Fork the repository +Click the "Fork" button on the top right of the repository page. + +### 2. Clone your fork +```bash +git clone https://github.com/YOUR_USERNAME/neural-lam.git +cd neural-lam +3. Create a new branch +git checkout -b your-branch-name +⚙️ Setup the development environment + +We recommend installing in editable mode with development dependencies: + +pip install --group dev -e . + +Or using uv: + +uv pip install --group dev -e . +✅ Before making a PR + +Run pre-commit checks: + +pre-commit run --all-files + +Make sure: + +Code is formatted correctly + +No linting errors + +Tests pass + +🚀 Making a Pull Request + +Commit your changes: + +git add . +git commit -m "Your message" + +Push your branch: + +git push origin your-branch-name + +Open a Pull Request on GitHub + +💡 Guidelines + +Keep PRs small and focused + +Write clear commit messages + +Link related issues (e.g., Fixes #123) + +Be respectful and collaborative + +🙌 Need Help? + +Feel free to open an issue or ask questions in the Slack channel. + +Happy coding! 🚀 + + +--- + +## 💾 Step 3: Commit + +```bash +git add CONTRIBUTING.md +git commit -m "Add CONTRIBUTING.md for new contributors (Fixes #406)" +git push +🚀 Step 4: Create PR +Title: +Add CONTRIBUTING.md to guide new contributors +Description: +Fixes #406 + +Added a CONTRIBUTING.md file to guide new contributors on how to set up the project, run checks, and submit pull requests. + +This improves onboarding and developer experience. +🔥 After this PR + +You will have: + +✅ Docs fix (#465) + +✅ Docs fix (#464) + +✅ New file contribution (#406) + +👉 This is VERY strong for GSoC + +🚀 Next level (after this) + +Then we move to: + +small bug fix OR + +type hints PR + +Say: +👉 “done #406” +or +👉 “error while pushing” + +I’ll help instantly 👍 \ No newline at end of file