Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
Update NEMO ocean model restart files with machine learning predictions.

## Installation

Start by installing a virtual environment and then:

```bash
Expand All @@ -13,11 +12,22 @@ pip install .
## Usage

```bash
nemo-spinup-restart --restart_path /path/to/restarts \
--radical RESTART_NAME \
--mask_file /path/to/mask.nc \
--prediction_path /path/to/predictions \
--ocean_terms ocean_terms.yaml
nemo-restart
--restart_path /path/to/restarts \
--radical RESTART_NAME \
--mask_file /path/to/mask.nc \
--prediction_path /path/to/predictions \
--ocean_terms ocean_terms.yaml

nemo-upscale upscale \\
--predictions-dir ./predictions \
--coarse-template ./1deg/restart_template.nc \
--coarse-mask ./1deg/mesh_mask.nc \
--coarse-namelist ./1deg/namelist_cfg \
--fine-template ./025deg/restart_template.nc \
--fine-mask ./025deg/mesh_mask.nc \
--output-dir ./generated \
--name C2
```

### Required Arguments
Expand Down
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ dependencies = [
"matplotlib",
"netcdf4",
"pyyaml",
"xesmf",
"f90nml",
]

[project.optional-dependencies]
Expand All @@ -41,7 +43,8 @@ dev = [
]

[project.scripts]
nemo-spinup-restart = "nemo_spinup_restart.cli:main"
nemo-restart = "nemo_spinup_restart.cli:main"
nemo-upscale = "nemo_spinup_restart.regrid_cli:main"

[tool.setuptools.packages.find]
where = ["src"]
Expand Down
Loading