Conda-package (#39)

* Conda installation hints to README.md Also, refer to conda-forge/staged-recipes#28099 --------- Co-authored-by: Sanath Keshav <[email protected]> Co-authored-by: Ishaan Desai <[email protected]>
DataAnalyticsEngineering · Dec 13, 2024 · 62da6de · 62da6de
1 parent a4f8cc3
commit 62da6de
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git 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

diff --git 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
@@ -144,6 +144,21 @@ Install FANS (system-wide) using the following options:
     apt install packages/fans-dev_<version>_<architecture>.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 work.
+It can be installed via
+
+```bash
+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.