Skip to content

Commit

Permalink
start work on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
leifdenby committed Jul 16, 2024
1 parent b481929 commit bcec472
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,13 @@ See the issues https://github.com/joeloskarsson/neural-lam/issues/2, https://git
Below follows instructions on how to use Neural-LAM to train and evaluate models.

## Installation

The dependencies in `neural-lam` is handled with [pdm](https://pdm.fming.dev/), but you can still install `neural-lam` directly with pip if you prefer. The benefits of using `pdm` are that [pyproject.toml](pyproject.toml) is automatically updated when you add/remove dependencies (with `pdm add <package_name>` or `pdm remove <package_name`).

### Installing with pdm

### Installing with pip

Follow the steps below to create the necessary python environment.

1. Install GEOS for your system. For example with `sudo apt-get install libgeos-dev`. This is necessary for the Cartopy requirement.
Expand Down

0 comments on commit bcec472

Please sign in to comment.