Skip to content

Commit

Permalink
Merge pull request #23 from NOAA-PSL/chiaweh2-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
chiaweh2 authored Apr 18, 2024
2 parents 5e4aeae + 026b465 commit c3d818c
Showing 1 changed file with 31 additions and 16 deletions.
47 changes: 31 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,37 @@ We welcome external contribution to the package. Please feel free to submit issu
To use the module in the package at this stage
1. Create a conda/mamba env based on the region_mom.yml

```conda env create -f region_mom.yml```
2. Activate the conda env `regional_mom`

```conda activate regional_mom```
3. change your location to the top level of cloned repo

```cd <dir_path_to_regional_mom6>/regional_mom6/```
4. pip install the package in develop mode

```pip install -e .```
5. setup config file (data path for local data directory)

```cp config.json.template config.json```
and open the `config.json` and input the absolute path to the top level of the regional mom6 data

```"data_path": "<your-mom6data-path-here>"```
```
conda env create -f region_mom.yml
```
3. Activate the conda env `regional_mom`

```
conda activate regional_mom
```
4. change your location to the top level of cloned repo

```
cd <dir_path_to_regional_mom6>/regional_mom6/
```
5. pip install the package in develop mode

```
pip install -e .
```
6. setup config file (data path for local data directory)

```
cp config.json.template config.json
```
open the `config.json` and input the absolute path to the top level of the regional mom6 data
```
{
"data_path": "<your-mom6data-path-here>"
}
```
current setup assuming the data directory structure is fixed (flexibility need to be considered)

0 comments on commit c3d818c

Please sign in to comment.