Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
A669015 committed Sep 17, 2024
1 parent 1bb4ef9 commit 71e984a
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,6 @@ This should be done by
export PY4CAST_ROOTDIR="/my/dir/"
```

If you plan to use micromamba or conda you should also add `py4cast` to your **PYTHONPATH** by expanding it (Export or change your `PYTHONPATH`).



### At Météo-France

When working at Météo-France, you can use either runai + Docker or Conda/Micromamba to setup a working environment. On the AI Lab cluster we recommend using runai, Conda on our HPC.
Expand All @@ -93,11 +89,21 @@ See the [runai repository](https://git.meteo.fr/dsm-labia/monorepo4ai) for insta

### Install with conda

You can install a conda environment using
You can install a conda environment, including `py4cast` in editable mode, using
```sh
conda env create --file env_conda.yaml
```

From an exixting conda environment, you can now install manually `py4cast` in development mode using
```sh
conda install conda-build -n py4cast
conda develop .
```
or
```sh
pip install --editable .
```


### Install with micromamba

Expand All @@ -106,6 +112,11 @@ Please install the environment using :
micromamba create -f env.yaml
```

From an exixting micromamba environment, you can now install manually `py4cast` in editable mode using
```sh
pip install --editable .
```


## Usage

Expand Down
1 change: 1 addition & 0 deletions env_conda.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ dependencies:
- shapely>=2.0.1
- netCDF4==1.6.5
- monai==1.3.1
- conda-build==24.7.1
- pip:
- tensorboard-plugin-profile
- torch-tb-profiler==0.4.1
Expand Down

0 comments on commit 71e984a

Please sign in to comment.