Merge pull request #266 from bessagroup/pr/1.5

Pr/1.5

.coveragerc

@@ -3,11 +3,8 @@
 branch = True
 source = src
 omit =
-    src/f3dasm/simulation/abaqus_script/*
-    src/f3dasm/experiment/files/*
     tests/*
     **/__init__.py
-    src/f3dasm/machinelearning/*
 
 [report]
 # Regexes for lines to exclude from consideration

.github/workflows/draft-pdf.yml

@@ -3,7 +3,12 @@ name: Build JOSS paper
 on:
   pull_request:
     branches:
+      - "pr/**"
       - "main"
+  push:
+    branches:
+      - "pr/**"
+
 
 jobs:
   paper:

README.md

@@ -1,6 +1,7 @@
 f3dasm
 ------
-*Framework for data-driven design \& analysis of structures and materials*
+
+<div align="center"><img src="https://raw.githubusercontent.com/bessagroup/f3dasm/pr/1.5/paper/f3dasm_logo_long.png" width="800"/></div>
 
 ***
 
@@ -41,31 +42,17 @@ The best way to get started is to follow the [installation instructions](https:/
 
 ## Illustrative benchmarks
 
-This package includes a collection of illustrative benchmark studies that demonstrate the capabilities of the framework. These studies are available in the `/studies` folder, and include the following studies:
+This package includes a collection of illustrative benchmark studies that demonstrate the capabilities of the framework. These studies are available in the `/studies/` folder, and include the following studies:
 
 - 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 created and developer: [M.P. van der Schelling](https://github.com/mpvanderschelling/) (M.P.vanderSchelling@tudelft.nl)
+* Current creator and developer: [M.P. van der Schelling](https://github.com/mpvanderschelling/) (M.P.vanderSchelling@tudelft.nl)
 
 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!
 
-
-
-## Referencing
-
-If you use or edit our work, please cite at least one of the appropriate references:
-
-[1] Bessa, M. A., Bostanabad, R., Liu, Z., Hu, A., Apley, D. W., Brinson, C., Chen, W., & Liu, W. K. (2017). A framework for data-driven analysis of materials under uncertainty: Countering the curse of dimensionality. Computer Methods in Applied Mechanics and Engineering, 320, 633-667.
-
-[2] Bessa, M. A., & Pellegrino, S. (2018). Design of ultra-thin shell structures in the stochastic post-buckling range using Bayesian machine learning and optimization. International Journal of Solids and Structures, 139, 174-188.
-
-[3] Bessa, M. A., Glowacki, P., & Houlder, M. (2019). Bayesian machine learning in metamaterial design: fragile becomes super-compressible. Advanced Materials, 31(48), 1904845.
-
-[4] Mojtaba, M., Bostanabad, R., Chen, W., Ehmann, K., Cao, J., & Bessa, M. A. (2019). Deep learning predicts path-dependent plasticity. Proceedings of the National Academy of Sciences, 116(52), 26414-26420.
-
 ## Community Support
 
 If you find any **issues, bugs or problems** with this template, please use the [GitHub issue tracker](https://github.com/bessagroup/f3dasm/issues) to report them.

VERSION

@@ -1 +1 @@
-1.4.8
+1.5.0

docs/source/conf.py

@@ -27,8 +27,8 @@
 project = 'f3dasm'
 author = 'Martin van der Schelling'
 copyright = '2024, Martin van der Schelling'
-version = '1.4.8'
-release = '1.4.8'
+version = '1.5.0'
+release = '1.5.0'
 
 
 # -- General configuration ----------------------------------------------------
@@ -138,4 +138,4 @@
 html_css_files = ['readthedocs-custom.css', 'theme_overrides.css', ]
 
 # Source: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_show_sourcelink
-html_show_sourcelink = True
+html_show_sourcelink = False