Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelburbulla committed Aug 20, 2024
1 parent 70ee1c2 commit 70aa9ec
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ operator learning is particularly useful in scientific machine learning,
**continuiti** also includes physics-informed loss functions and a collection of
relevant benchmarks.


## Installation
Install the package using pip:
```shell
Expand All @@ -28,10 +29,11 @@ Or install the latest development version from the repository:
```
git clone https://github.com/aai-institute/continuiti.git
cd continuiti
pip install -e .[dev]
pip install -e ".[dev]"
```

## Usage

Our [Documentation](https://aai-institute.github.io/continuiti/) contains a
collection of tutorials on how to learn operators using continuiti,
a collection of how-to guides to solve specific problems, more background,
Expand All @@ -43,25 +45,34 @@ v = operator(x, u(x), y)
```
mapping a function `u` (evaluated at `x`) to function `v` (evaluated in `y`).

For more details, see
[Learning Operators](https://aai-institute.github.io/continuiti/operators/index.html).

## Examples

<div style="text-align: center;">
<a href="https://aai-institute.github.io/continuiti/benchmarks/#navierstokes">
<img alt="navierstokes" src="https://aai-institute.github.io/continuiti/img/ns.png" width="80%"><br>
Fourier Neural Operator (FNO) for Navier-Stokes flow
<a href="https://aai-institute.github.io/continuiti/latest/benchmarks/#navierstokes">
Fourier Neural Operator (FNO) for Navier-Stokes flow<br>
<img alt="navierstokes" src="https://aai-institute.github.io/continuiti/latest/img/ns.png" width="60%">
</a>
</div>

<div style="text-align: center;">
<a href="https://aai-institute.github.io/continuiti/latest/how-to-guides/physicsinformed/">
Physics-informed DeepONet<br>
<style>@media (prefers-color-scheme: dark){.invert{filter: invert(1);}}</style>
<img alt="pi-deeponet" src="docs/img/pi-deeponet.png" width="60%" class="invert">
</a>
</div>

## Contributing

Contributions are welcome from anyone in the form of pull requests, bug reports
and feature requests. If you find a bug or have a feature request, please open
an issue on GitHub. If you want to contribute code, please fork the repository
and submit a pull request. See [CONTRIBUTING.md](CONTRIBUTING.md) for details on
local development.


## License

This project is licensed under the GNU LGPLv3 License - see the
[LICENSE](LICENSE) file for details.
Binary file added docs/img/pi-deeponet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/tutorials/firststeps.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,13 @@ Install the latest version of **continuiti** using pip:
pip install continuiti
```

Or install the latest development version from the repository:

```
git clone https://github.com/aai-institute/continuiti.git
cd continuiti
pip install -e ".[dev]"
```

**continuiti** requires Python>=3.9 and is built on top of
[PyTorch](https://pytorch.org/).

0 comments on commit 70aa9ec

Please sign in to comment.