Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #353

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Update README.md #353

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
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
Loading