Skip to content

Commit

Permalink
Align README and docs/index.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelburbulla committed Dec 6, 2023
1 parent 3f9bcc4 commit 2f4fcc6
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 19 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
<div align="center">

<img alt="Continuity" src="https://aai-institute.github.io/Continuity/img/logo.png" width="200">
<img alt="Continuity" src="https://aai-institute.github.io/Continuity/img/icon.png" width="100">

<h1>Continuity</h1>

Learning function operators with neural networks.

Expand All @@ -15,31 +17,29 @@ Learning function operators with neural networks.
</a>
</div>

# Description
Continuity provides a python package for learning function operators with neural
networks.
**Continuity** is a Python package with a general interface for machine
learning on functions operators. It implements various neural network
architectures, including DeepONets or neural operators, physics-informed loss
functions to train the networks based on PDEs, and a variety of benchmarks.

# Quickstart

## Installation
Before using this module, you need to install the project.
Create a virtual environment and install the project as editable package.
Clone the repository and install the package using pip.
```
python -m venv venv
source venv/bin/activate
git clone https://github.com/aai-institute/Continuity.git
cd Continuity
pip install -e .
```

## Usage
Up to now, some examples can be found in the `tests` directory.
See the [documentation](https://aai-institute.github.io/Continuity/) for more
details.
Some examples can be found in the `notebooks` and `tests` directories. See the
[documentation](https://aai-institute.github.io/Continuity/) for more details.

# Contributing
## Contributing
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.

# License
## License
This project is licensed under the GNU GPLv3 License - see the
[LICENSE](LICENSE) file for details.
15 changes: 10 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,22 @@
title: Home
---

# Continuity
<div align="center">

**Continuity** is a Python package for *learning function operators with neural
networks*.
<img alt="Continuity" src="https://aai-institute.github.io/Continuity/img/icon.png" width="100">

This package is based on PyTorch and provides a general interface for machine
<h1>Continuity</h1>

Learning function operators with neural networks.

</div>


**Continuity** is a Python package for machine
learning on functions operators. It implements various neural network
architectures, including DeepONets or neural operators, physics-informed loss
functions to train the networks based on PDEs, and a variety of benchmarks.


::cards:: cols=2

- title: Installation
Expand Down

0 comments on commit 2f4fcc6

Please sign in to comment.