Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorisCalkoen authored Nov 11, 2024
1 parent 54e8b28 commit d09673a
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,6 @@ Python tools for cloud-native coastal analytics.
$ pip install coastpy
```

## Usage
More extensive installation and usage instructions will come when we build the
documentation. For now, to run the tutorials, clone the repository, install the environment,
launch jupyter lab and navigate to the tutorials directory.

```bash
git clone https://TUDelft-CITG/coastpy.git
cd coastpy
mamba env create -f environment.yml
jupyter lab
```

## Data

The data that is produced with this software can be directly accessed via the cloud using
Expand Down Expand Up @@ -52,6 +40,18 @@ az storage blob download-batch \
--account-name coclico
```

## Usage
More extensive installation and usage instructions will come when we build the
documentation. For now, to run the tutorials, clone the repository, install the environment,
launch jupyter lab and navigate to the tutorials directory.

```bash
git clone https://TUDelft-CITG/coastpy.git
cd coastpy
mamba env create -f environment.yml
jupyter lab
```

## Citation:

```latex
Expand Down

0 comments on commit d09673a

Please sign in to comment.