diff --git a/docs/index.md b/docs/index.md index f148aa8..4cb6281 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,7 +18,7 @@ for reproducing and extending results from our paper, archived re-forecasts for 2020, can be found in the [WeatherBench2](https://github.com/google-research/weatherbench2) project. -The documentation here focuses mostly on our API for **inference** (i.e., running +The documentation here focuses mostly on our API for *inference* (i.e., running trained NeuralGCM atmospheric models), which we believe is the most immediately useful part of the NeuralGCM code for third parties. It is also a part of our code that we can commit to supporting in roughly its current form. diff --git a/docs/inference_demo.ipynb b/docs/inference_demo.ipynb index 5209a69..c2e0d75 100644 --- a/docs/inference_demo.ipynb +++ b/docs/inference_demo.ipynb @@ -30,8 +30,8 @@ } ], "source": [ - "# if necessary, install NeuralGCM from source\n", - "! pip install -q -U gcsfs git+https://github.com/google-research/neuralgcm" + "# if necessary, install NeuralGCM and dependencies\n", + "! pip install -q -U neuralgcm dinosaur-dycore gcsfs" ] }, { @@ -245,7 +245,9 @@ "id": "W7lhecHtbo82" }, "source": [ - "## Compare forecast to ERA5" + "## Compare forecast to ERA5\n", + "\n", + "See [WeatherBench2](https://sites.research.google/weatherbench/) for more comprehensive evaluations and archived NeuralGCM forecasts." ] }, { diff --git a/docs/installation.md b/docs/installation.md index db72860..9d123b5 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -4,11 +4,8 @@ For best performance, we recommend running NeuralGCM models on a computer with an attached GPU or TPU. Otherwise, performance will be very slow. You can install NeuralGCM from source using pip, which should automatically -install its dependencies, including [JAX](https://github.com/google/jax): +install its dependencies, including [JAX](https://github.com/google/jax) and +[Dinosaur](https://github.com/google-research/dinosaur): ``` -pip install git+https://github.com/google-research/neuralgcm +pip install neuralgcm ``` - -Note that NeuralGCM requires the development version of -[Dinosaur](https://github.com/google-research/dinosaur), so if you update -NeuralGCM you will probably need to update Dinosaur, too. diff --git a/neuralgcm/__init__.py b/neuralgcm/__init__.py index cc71d49..05f4bb6 100644 --- a/neuralgcm/__init__.py +++ b/neuralgcm/__init__.py @@ -44,4 +44,4 @@ from neuralgcm.api import PressureLevelModel -__version__ = "0.1.0" +__version__ = "1.0.0" diff --git a/pyproject.toml b/pyproject.toml index 20cb049..17b99c1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta" [project] name = "neuralgcm" -version = "0.1.0" +version = "1.0.0" authors = [ {name = "Google LLC", email = "noreply@google.com"}, ] @@ -15,7 +15,7 @@ readme = "README.md" license = {file = "LICENSE"} requires-python = ">=3.10" dependencies = [ - "dinosaur@git+https://github.com/google-research/dinosaur", + "dinosaur-dycore", "dm-haiku", "gin-config", "jax",