Python structure setup with new repo name (#26)

* update toml file

* rename to climanet

* rename module dir

* reconstruct dependencies

* update notebook with cell output and new import

* add a logo

* Apply suggestions from code review

Co-authored-by: SarahAlidoost <55081872+SarahAlidoost@users.noreply.github.com>

* remove logo file

* update readme

* fix GH action

* add build tools to toml file to support installing the python package itself

---------

Co-authored-by: SarahAlidoost <55081872+SarahAlidoost@users.noreply.github.com>

Author: rogerkuou

.github/workflows/build.yml

@@ -19,9 +19,9 @@ jobs:
         python-version: ["3.11", "3.12", "3.13"]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Install uv
-      uses: astral-sh/setup-uv@v4
+      uses: astral-sh/setup-uv@v7
       with:
         enable-cache: true
     - name: Set up Python ${{ matrix.python-version }}
@@ -31,6 +31,4 @@ jobs:
     - name: Build the package
       run: uv build
     - name: Test with pytest
-      env:
-        PYTHONPATH: ${{ github.workspace }}/src
-      run: uv run pytest
+      run: uv run pytest tests

CITATION.cff

@@ -2,7 +2,7 @@
 # Visit https://bit.ly/cffinit to generate yours today!
 
 cff-version: 1.2.0
-title: eso4clima-wp1-prototype
+title: ClimaNet
 message: >-
   If you use this software, please cite it using the
   metadata from this file.

README.md

@@ -1,6 +1,6 @@
-# eso4clima-wp1-prototype
+# ClimaNet: A Climate Aware Spatio Temporal Encoder Decoder
 
-[![License](https://img.shields.io/github/license/ESMValGroup/eso4clima-wp1-prototype)](https://opensource.org/licenses/Apache-2.0)
+[![License](https://img.shields.io/github/license/ESMValGroup/ClimaNet)](https://opensource.org/licenses/Apache-2.0)
 
 ## Installation
 

climanet/__init__.py

@@ -0,0 +1,9 @@
+from climanet import st_encoder_decoder
+from climanet.dataset import STDataset
+from climanet.utils import regrid_to_boundary_centered_grid
+
+__all__ = [
+    "STDataset",
+    "st_encoder_decoder",
+    "regrid_to_boundary_centered_grid"
+]

src/dataset.py climanet/dataset.pysrc/dataset.py renamed to climanet/dataset.py

@@ -1,6 +1,6 @@
-site_name: "eso4clima-wp1-prototype"
-repo_url: https://github.com/ESMValGroup/eso4clima-wp1-prototype/
-repo_name: eso4clima-wp1-prototype
+site_name: "ClimaNet"
+repo_url: https://github.com/ESMValGroup/ClimaNet/
+repo_name: ClimaNet
 
 nav:
   - Introduction: index.md