diff --git a/README.md b/README.md index 3243b7b2..943ce90e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@
-Continuity +Continuity + +

Continuity

Learning function operators with neural networks. @@ -15,31 +17,29 @@ Learning function operators with neural networks.
-# 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. diff --git a/docs/index.md b/docs/index.md index 144e8892..c98e3431 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,17 +2,22 @@ title: Home --- -# Continuity +
-**Continuity** is a Python package for *learning function operators with neural -networks*. +Continuity -This package is based on PyTorch and provides a general interface for machine +

Continuity

+ +Learning function operators with neural networks. + +
+ + +**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