diff --git a/README.rst b/README.rst index afeceefe4..6c986d8a4 100644 --- a/README.rst +++ b/README.rst @@ -5,12 +5,20 @@ .. list-table:: :stub-columns: 1 + * - package + - | |pypi| |python| + * - tests + - | |build| * - docs - |docs| * - license - | |license| * - support - | |tg| + * - gitlab + - | |gitlab| + * - funding + - | |ITMO| |NCCR| .. end-badges @@ -41,8 +49,9 @@ The dynamics of the optimisation can be visualized as (breakwaters optimisation How to use ========== -All details about first steps with GEFEST might be found in the `quick start guide `__ -and in the `tutorial for novices `__ +All details about first steps with GEFEST might be found in the `quick start guide `__. + +Tutorals for more spicific use cases can be found `tutorial section of docs `__. Project Structure ================= @@ -55,13 +64,21 @@ The repository includes the following directories: * Package `cases `__ includes several *how-to-use-cases* where you can start to discover how GEFEST works; * All *unit and integration tests* can be observed in the `test `__ directory; * The sources of the documentation are in the `docs `__. +* Weights of pretrained DL models can be downloaded from `this repository `__. Cases and examples ================== +**Note**: To run the examples below, the old kernel gefest version, which can be installed on python 3.7 with: + +.. code-block:: bash + + pip install git+https://github.com/aimclub/GEFEST.git@4f9c34c449c0eb65d264476e5145f09b4839cd70 - `Experiments `__ with various real and synthetic cases - `Case `__ devoted to the red blood cell traps design. +Migrated examples can be found in cases folder of the main branch. + Current R&D and future plans ============================ @@ -69,10 +86,8 @@ Currently, we are working on integration of new types of physical objects with c The major ongoing tasks: -* to make the use of GEFEST more accessible and simple for users * to integrate three dimensional physical objects * to implement gradient based approaches for optimization of physical objects -* to improve efficiency of GEFEST's standard sampler Documentation ============= @@ -106,7 +121,6 @@ National Technology Initiative's Projects Support as a part of the roadmap implementation for the development of the high-tech field of Artificial Intelligence for the period up to 2030 (agreement 70-2021-00187). - Citation ======== @@ -117,8 +131,17 @@ Citation volume={119}, pages={105715}, year={2023}, - publisher={Elsevier} -} + publisher={Elsevier}} + +@inproceedings{solovev2023ai, + title={AI Framework for Generative Design of Computational Experiments with Structures in Physical Environment}, + author={Solovev, Gleb Vitalevich and Kalyuzhnaya, Anna and Hvatov, Alexander and Starodubcev, Nikita and Petrov, Oleg and Nikitin, Nikolay}, + booktitle={NeurIPS 2023 AI for Science Workshop}, + year={2023}} + +.. |build| image:: https://github.com/aimclub/GEFEST/workflows/unit%20tests/badge.svg?branch=main + :alt: Build Status + :target: https://github.com/aimclub/GEFEST/actions .. |docs| image:: https://readthedocs.org/projects/gefest/badge/?version=latest :target: https://gefest.readthedocs.io/en/latest/?badge=latest @@ -130,4 +153,24 @@ Citation .. |tg| image:: https://img.shields.io/badge/Telegram-Group-blue.svg :target: https://t.me/gefest_helpdesk - :alt: Telegram Chat \ No newline at end of file + :alt: Telegram Chat + +.. |ITMO| image:: https://github.com/ITMO-NSS-team/open-source-ops/blob/add_badge/badges/ITMO_badge_rus.svg + :alt: Acknowledgement to ITMO + :target: https://itmo.ru + +.. |NCCR| image:: https://github.com/ITMO-NSS-team/open-source-ops/blob/add_badge/badges/NCCR_badge.svg + :alt: Acknowledgement to NCCR + :target: https://actcognitive.org/ + +.. |gitlab| image:: https://img.shields.io/badge/mirror-GitLab-orange + :alt: GitLab mirror for this repository + :target: https://gitlab.actcognitive.org/itmo-nss-team/GEFEST + +.. |pypi| image:: https://img.shields.io/pypi/v/gefest.svg + :alt: PyPI Package Version + :target: https://img.shields.io/pypi/v/gefest + +.. |python| image:: https://img.shields.io/pypi/pyversions/gefest.svg + :alt: Supported Python Versions + :target: https://img.shields.io/pypi/pyversions/gefest