diff --git a/README.md b/README.md index 77008ff4..4c8e9bb5 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,17 @@ f3dasm [![Python](https://img.shields.io/pypi/pyversions/f3dasm)](https://www.python.org) [![pypi](https://img.shields.io/pypi/v/f3dasm.svg)](https://pypi.org/project/f3dasm/) +[![Conda Version](https://img.shields.io/conda/vn/conda-forge/f3dasm.svg)](https://anaconda.org/conda-forge/f3dasm) [![GitHub license](https://img.shields.io/badge/license-BSD-blue)](https://github.com/bessagroup/f3dasm) [![Documentation Status](https://readthedocs.org/projects/f3dasm/badge/?version=latest)](https://f3dasm.readthedocs.io/en/latest/?badge=latest) + [**Docs**](https://f3dasm.readthedocs.io/) | [**Installation**](https://f3dasm.readthedocs.io/en/latest/rst_doc_files/general/installation.html) | [**GitHub**](https://github.com/bessagroup/f3dasm) | [**PyPI**](https://pypi.org/project/f3dasm/) +| [**Conda**](https://anaconda.org/conda-forge/f3dasm) + ## Summary @@ -36,10 +40,25 @@ Welcome to `f3dasm`, a **f**ramework for **d**ata-**d**riven **d**esign and **a* - **Hydra integration** - The framework is supports the [hydra](https://hydra.cc/) configuration manager, to easily manage and run experiments. + ## Getting started +`f3dasm` is available at [the Python Package Index]() and on [Anaconda Cloud](https://anaconda.org/conda-forge/f3dasm). To get started: + +```bash +# PyPI +$ pip install f3dasm +``` + +or + +```bash +# PyPI +$ conda install f3dasm +``` + +* Follow the complete [installation instructions](https://f3dasm.readthedocs.io/en/latest/rst_doc_files/general/installation.html) to get going! * Read the [overview](https://f3dasm.readthedocs.io/en/latest/rst_doc_files/general/installation.html) section, containing a brief introduction to the framework and a statement of need. -* Follow the [installation instructions](https://f3dasm.readthedocs.io/en/latest/rst_doc_files/general/installation.html) to get going! * Check out the [tutorials](https://f3dasm.readthedocs.io/en/latest/auto_examples/index.html) section, containing a collection of examples to get you familiar with the framework. ## Illustrative benchmarks @@ -49,9 +68,29 @@ This package includes a collection of illustrative benchmark studies that demons - Benchmarking optimization algorithms against well-known benchmark functions - 'Fragile Becomes Supercompressible' ([Bessa et al. (2019)](https://onlinelibrary.wiley.com/doi/full/10.1002/adma.201904845)) -## Authorship - -* Current creator and developer: [M.P. van der Schelling](https://github.com/mpvanderschelling/) (M.P.vanderSchelling@tudelft.nl) +## Authorship & Citation + +Current creator and developer: M.P. van der Schelling[1](#f1) + + 1 Doctoral Researcher in Materials Science and Engineering, Delft University of Technology: [ORCID](https://orcid.org/0000-0003-3602-0452), [Website](https://github.com/mpvanderschelling/) + + The Bessa research group at TU Delft is small... At the moment, we have limited availability to help future users/developers adapting the code to new problems, but we will do our best to help!