Skip to content

Commit

Permalink
Merge branch 'main' into develop
Browse files Browse the repository at this point in the history
readme changes fro main
  • Loading branch information
sanathkeshav1 committed Aug 22, 2024
2 parents eb3e78e + 6a9edd7 commit 16c8f98
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 12 deletions.
28 changes: 28 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
cff-version: "1.2.0"
authors:
- family-names: Leuschner
given-names: Matthias
orcid: "https://orcid.org/0000-0003-0477-3441"
- family-names: Fritzen
given-names: Felix
orcid: "https://orcid.org/0000-0003-4926-0068"
preferred-citation:
authors:
- family-names: Leuschner
given-names: Matthias
orcid: "https://orcid.org/0000-0003-0477-3441"
- family-names: Fritzen
given-names: Felix
orcid: "https://orcid.org/0000-0003-4926-0068"
date-published: 2017-11-30
doi: 10.1007/s00466-017-1501-5
issn: 1432-0924
issue: 3
journal: Computational Mechanics
publisher:
name: Springer
title: "Fourier-Accelerated Nodal Solvers (FANS) for homogenization problems"
type: article
url: "https://link.springer.com/article/10.1007/s00466-017-1501-5"
volume: 62
title: "Fourier-Accelerated Nodal Solvers (FANS) for homogenization problems"
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Fourier Accelerated Nodal Solvers (FANS) is an FFT-based homogenization solver d

Before proceeding with the installation, ensure that your system has the necessary dependencies. The prerequisites of FANS can be installed using Spack for a streamlined setup on high-performance computing systems, or through traditional package management for personal use.

#### Spack Installation (Recommended for Clusters/Supercomputers)
### Spack Installation (Recommended for Clusters/Supercomputers)

Spack is a package manager designed for high-performance computing environments. It simplifies the installation of complex software stacks, making it ideal for setting up FANS on large clusters or supercomputers.

Expand Down Expand Up @@ -47,7 +47,7 @@ Spack is a package manager designed for high-performance computing environments.
spack load cmake mpi hdf5 eigen fftw
```
#### Traditional Installation
### Traditional Installation
If you're setting up FANS on a personal computer or in a non-HPC environment, follow these instructions:

Expand Down Expand Up @@ -158,16 +158,6 @@ To run a linear elastic mechanical homogenization problem for a single load case
mpiexec -n 1 ./FANS input_files/sphere_mech.json
```

### Code of Conduct

Please review our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a respectful and inclusive community.

### Contributor License Agreement (CLA)

By contributing, you agree that your contributions will be licensed under the project's license. You may be asked to sign a Contributor License Agreement (CLA).
Thank you for contributing to FANS! Your efforts help make this project better for everyone.
## Acknowledgements

Funded by Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) under Germany’s Excellence Strategy - EXC 2075 – 390740016. Contributions by Felix Fritzen are funded by Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) within the Heisenberg program - DFG-FR2702/8 - 406068690; DFG-FR2702/10 - 517847245 and through NFDI-MatWerk - NFDI 38/1 - 460247524. We acknowledge the support by the Stuttgart Center for Simulation Science (SimTech).

0 comments on commit 16c8f98

Please sign in to comment.