-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6435ca0
commit 51e9d9e
Showing
1 changed file
with
43 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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) | ||
<!-- [![DOI](https://joss.theoj.org/papers/10.21105/joss.05594/status.svg)](https://doi.org/10.21105/joss.05594) --> | ||
|
||
[**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) | ||
<!-- | [**Paper**](https://doi.org/10.21105/joss.05594) --> | ||
|
||
## 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/) ([email protected]) | ||
## Authorship & Citation | ||
|
||
Current creator and developer: M.P. van der Schelling<sup>[1](#f1)</sup> | ||
|
||
<sup id="f1"> 1 </sup>Doctoral Researcher in Materials Science and Engineering, Delft University of Technology: [ORCID](https://orcid.org/0000-0003-3602-0452), [Website](https://github.com/mpvanderschelling/) | ||
|
||
<!-- If you use `f3dasm` in your research or in a scientific publication, it is appreciated that you cite the paper below: | ||
**Journal of Open Source Software** ([paper](https://doi.org/10.21105/joss.05594)): | ||
``` | ||
@article{Ferreira2023, | ||
title = {CRATE: A Python package to perform fast material simulations}, | ||
author = {Bernardo P. Ferreira and F. M. Andrade Pires and Miguel A. Bessa} | ||
doi = {10.21105/joss.05594}, | ||
url = {https://doi.org/10.21105/joss.05594}, | ||
year = {2023}, | ||
publisher = {The Open Journal}, | ||
volume = {8}, | ||
number = {87}, | ||
pages = {5594}, | ||
journal = {Journal of Open Source Software} | ||
} | ||
``` --> | ||
|
||
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! | ||
|
||
|