Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added logo and made other few minor changes.
  • Loading branch information
biancazadrozny authored Jan 7, 2025
1 parent fa2ed4e commit 8ee0bfa
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# TerraTorch

:book: [Documentation](https://IBM.github.io/terratorch/)
<img src="https://github.com/user-attachments/assets/f8c9586f-6220-4a53-9669-2aee3300b492" alt="TerraTorch" width="400"/>

## Overview
TerraTorch is a library based on [PyTorch Lightning](https://lightning.ai/docs/pytorch/stable/) and the [TorchGeo](https://github.com/microsoft/torchgeo) domain library
Expand Down Expand Up @@ -51,15 +50,17 @@ pip install -e .

To install terratorch with partial (work in development) support for Weather Foundation Models, `pip install -e .[wxc]`, which currently works just for `Python >= 3.11`.

## Quick start
## Documentation

To get started, check out the [quick start guide](https://ibm.github.io/terratorch/quick_start)

## For developers
Developers, check out the [architecture overview](https://ibm.github.io/terratorch/architecture).

Check out the [architecture overview](https://ibm.github.io/terratorch/architecture).
## Contributing

A simple hint for any contributor. If you want to met the GitHub DCO checks, just do your commits as below:
This project welcomes contributions and suggestions.

A simple hint for any contributor. If you want to meet the GitHub DCO checks, just do your commits as below:
```
git commit -s -m <message>
```
Expand Down

0 comments on commit 8ee0bfa

Please sign in to comment.