From 9a1ed19e9184c54fd98b87a997bdcaa533e86a69 Mon Sep 17 00:00:00 2001 From: Claudius Haag Date: Thu, 12 Dec 2024 15:49:38 +0100 Subject: [PATCH 1/8] Add Conda installation hints --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index d218b27..3c1ed07 100644 --- a/README.md +++ b/README.md @@ -144,6 +144,18 @@ Install FANS (system-wide) using the following options: apt install packages/fans-dev__.deb ``` +### Install using Conda +[![Anaconda-Server Badge](https://anaconda.org/conda-forge/fans/badges/version.svg)](https://anaconda.org/conda-forge/fans) +[![Anaconda-Server Badge](https://anaconda.org/conda-forge/fans/badges/platforms.svg)](https://anaconda.org/conda-forge/fans) +[![Anaconda-Server Badge](https://anaconda.org/conda-forge/fans/badges/downloads.svg)](https://anaconda.org/conda-forge/fans) + +FANS is also available as a conda-package on [conda-forge](https://anaconda.org/conda-forge/fans). No dependencies have to be manually installed for it to workl. +It can be installed via +```sh +conda install fans +``` +exposing the executable `FANS`. + ## Input File Format FANS requires a JSON input file specifying the problem parameters. Example input files can be found in the [`test/input_files`](test/input_files) directory. It is recommended to use these files as a reference to create your own input file. From 7fcf88c4c32100d984de805f8a7efec439d15f88 Mon Sep 17 00:00:00 2001 From: Claudius Haag Date: Thu, 12 Dec 2024 15:50:59 +0100 Subject: [PATCH 2/8] Change gitignore to actually allow sphere32 --- .gitignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 2bc948f..c713336 100644 --- a/.gitignore +++ b/.gitignore @@ -198,7 +198,7 @@ test/input_files/**/*.json **/scratch/ # Test microstructure files -!sphere.h5 +!sphere32.h5 # Test input files !test_LinearElastic.json From cd84e3eb6caf358a39bbd366fa01f5c220a6d8b2 Mon Sep 17 00:00:00 2001 From: Sanath Keshav Date: Thu, 12 Dec 2024 16:44:52 +0100 Subject: [PATCH 3/8] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 3c1ed07..e63a43c 100644 --- a/README.md +++ b/README.md @@ -145,6 +145,7 @@ Install FANS (system-wide) using the following options: ``` ### Install using Conda + [![Anaconda-Server Badge](https://anaconda.org/conda-forge/fans/badges/version.svg)](https://anaconda.org/conda-forge/fans) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/fans/badges/platforms.svg)](https://anaconda.org/conda-forge/fans) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/fans/badges/downloads.svg)](https://anaconda.org/conda-forge/fans) From f10d508a5757b37cbdc1ce38296410c10af43c63 Mon Sep 17 00:00:00 2001 From: Sanath Keshav Date: Thu, 12 Dec 2024 16:53:39 +0100 Subject: [PATCH 4/8] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index e63a43c..925c120 100644 --- a/README.md +++ b/README.md @@ -152,7 +152,9 @@ Install FANS (system-wide) using the following options: FANS is also available as a conda-package on [conda-forge](https://anaconda.org/conda-forge/fans). No dependencies have to be manually installed for it to workl. It can be installed via + ```sh + conda install fans ``` exposing the executable `FANS`. From b3a10e541f4ef67ef448b8a8a5ac5654426236c5 Mon Sep 17 00:00:00 2001 From: Sanath Keshav Date: Thu, 12 Dec 2024 16:53:45 +0100 Subject: [PATCH 5/8] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 925c120..faf76cc 100644 --- a/README.md +++ b/README.md @@ -156,7 +156,6 @@ It can be installed via ```sh conda install fans -``` exposing the executable `FANS`. ## Input File Format From 90bddcf4750dff992193bbb7af1eb60783e37919 Mon Sep 17 00:00:00 2001 From: Sanath Keshav Date: Thu, 12 Dec 2024 17:07:13 +0100 Subject: [PATCH 6/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index faf76cc..51e443a 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Fourier Accelerated Nodal Solvers (FANS) is an FFT-based homogenization solver d - [Dependencies](#dependencies) - [Building](#building) - [Installing](#installing) -- [Input file format](#input-file-format) +- [Input File Format](#input-file-format) - [Examples](#examples) ## Dependencies From ef5919c2106e00566b677c220aaafaa62c537ebb Mon Sep 17 00:00:00 2001 From: Sanath Keshav Date: Thu, 12 Dec 2024 17:11:00 +0100 Subject: [PATCH 7/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 51e443a..4cbdf18 100644 --- a/README.md +++ b/README.md @@ -158,7 +158,7 @@ It can be installed via conda install fans exposing the executable `FANS`. -## Input File Format +## Input File Format {#input-file-format} FANS requires a JSON input file specifying the problem parameters. Example input files can be found in the [`test/input_files`](test/input_files) directory. It is recommended to use these files as a reference to create your own input file. From a14b0c06bc123e13a121a7e9d4c7d9033ba1b444 Mon Sep 17 00:00:00 2001 From: Ishaan Desai Date: Fri, 13 Dec 2024 10:33:36 +0100 Subject: [PATCH 8/8] Fix markdown formatting --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4cbdf18..c698ba9 100644 --- a/README.md +++ b/README.md @@ -150,15 +150,16 @@ Install FANS (system-wide) using the following options: [![Anaconda-Server Badge](https://anaconda.org/conda-forge/fans/badges/platforms.svg)](https://anaconda.org/conda-forge/fans) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/fans/badges/downloads.svg)](https://anaconda.org/conda-forge/fans) -FANS is also available as a conda-package on [conda-forge](https://anaconda.org/conda-forge/fans). No dependencies have to be manually installed for it to workl. +FANS is also available as a conda-package on [conda-forge](https://anaconda.org/conda-forge/fans). No dependencies have to be manually installed for it to work. It can be installed via -```sh - +```bash conda install fans +``` + exposing the executable `FANS`. -## Input File Format {#input-file-format} +## Input File Format FANS requires a JSON input file specifying the problem parameters. Example input files can be found in the [`test/input_files`](test/input_files) directory. It is recommended to use these files as a reference to create your own input file.