Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conda-package #39

Merged
merged 8 commits into from
Dec 13, 2024
Merged

Conda-package #39

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9a1ed19
Add Conda installation hints
claudiushaag Dec 12, 2024
7fcf88c
Change gitignore to actually allow sphere32
claudiushaag Dec 12, 2024
cd84e3e
Update README.md
sanathkeshav Dec 12, 2024
f10d508
Update README.md
sanathkeshav Dec 12, 2024
b3a10e5
Update README.md
sanathkeshav Dec 12, 2024
90bddcf
Update README.md
sanathkeshav Dec 12, 2024
ef5919c
Update README.md
sanathkeshav Dec 12, 2024
a14b0c0
Fix markdown formatting
IshaanDesai Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ test/input_files/**/*.json
**/scratch/

# Test microstructure files
!sphere.h5
!sphere32.h5

# Test input files
!test_LinearElastic.json
Expand Down
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
- [Dependencies](#dependencies)
- [Building](#building)
- [Installing](#installing)
- [Input file format](#input-file-format)
- [Input File Format](#input-file-format)

Check failure on line 12 in README.md

View workflow job for this annotation

GitHub Actions / Lint markdown files 

Link fragments should be valid [Context: "[Input File Format](#input-file-format)"]
- [Examples](#examples)

## Dependencies
Expand Down Expand Up @@ -144,6 +144,20 @@
apt install packages/fans-dev_<version>_<architecture>.deb
```

### Install using Conda
sanathkeshav marked this conversation as resolved.
Show resolved Hide resolved

[![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.
IshaanDesai marked this conversation as resolved.
Show resolved Hide resolved
It can be installed via

```sh
sanathkeshav marked this conversation as resolved.
Show resolved Hide resolved

conda install fans
exposing the executable `FANS`.

## Input File Format
sanathkeshav marked this conversation as resolved.
Show resolved Hide resolved

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.
Expand Down
Loading