No public description

PiperOrigin-RevId: 610838657

.github/workflows/ci-build.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: "python ${{ matrix.python-version }}"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11"]
+    steps:
+    - name: Cancel previous
+      uses: styfle/cancel-workflow-action@0.7.0
+      with:
+        access_token: ${{ github.token }}
+      if: ${{github.ref != 'refs/head/main'}}
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Get pip cache dir
+      id: pip-cache
+      run: |
+        python -m pip install --upgrade pip wheel
+        echo "::set-output name=dir::$(pip cache dir)"
+    - name: pip cache
+      uses: actions/cache@v2
+      with:
+        path: ${{ steps.pip-cache.outputs.dir }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}
+    - name: Install NeuralGCM
+      run: |
+        pip install -e .[tests]
+    - name: Run unit tests
+      run: |
+        pytest -v neuralgcm

.gitignore

@@ -0,0 +1,8 @@
+*.egg-info
+.DS_Store
+build
+dist
+docs/.ipynb_checkpoints
+docs/_build
+docs/_autosummary
+__pycache__

CONTRIBUTING.md

@@ -27,6 +27,4 @@ Guidelines](https://opensource.google/conduct/).
 
 ### Code Reviews
 
-All submissions, including submissions by project members, require review. We
-use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests)
-for this purpose.
+All submissions, including submissions by project members, require review.

README.md

@@ -6,17 +6,3 @@ weather and climate simulations.
 
 For details see [Neural General Circulation Models](https://arxiv.org/abs/2311.07222)
 publication (arxiv 2023).
-
-## Contributing
-
-See [`CONTRIBUTING.md`](CONTRIBUTING.md) for details.
-
-## License
-
-Apache 2.0; see [`LICENSE`](LICENSE) for details.
-
-## Disclaimer
-
-This project is not an official Google project. It is not supported by
-Google and Google specifically disclaims all warranties as to its quality,
-merchantability, or fitness for a particular purpose.

conftest.py

@@ -0,0 +1,20 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Configure FLAGS with default values for absltest."""
+from absl import app
+
+try:
+  app.run(lambda argv: None)
+except SystemExit:
+  pass

neuralgcm/__init__.py

@@ -0,0 +1,41 @@
+# Copyright 2024 Google LLC
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Defines the neuralgcm module."""
+
+import neuralgcm.correctors
+import neuralgcm.decoders
+import neuralgcm.diagnostics
+import neuralgcm.embeddings
+import neuralgcm.encoders
+import neuralgcm.equations
+import neuralgcm.features
+import neuralgcm.filters
+import neuralgcm.forcings
+import neuralgcm.gin_utils
+import neuralgcm.initializers
+import neuralgcm.integrators
+import neuralgcm.layers
+import neuralgcm.mappings
+import neuralgcm.model_builder
+import neuralgcm.model_utils
+import neuralgcm.optimization
+import neuralgcm.orographies
+import neuralgcm.parameterizations
+import neuralgcm.perturbations
+import neuralgcm.stochastic
+import neuralgcm.towers
+
+__version__ = "0.1.0"
+