From a0d07d605919b469a27482678962b9440db2ee80 Mon Sep 17 00:00:00 2001 From: Ishaan Desai Date: Thu, 22 Aug 2024 17:16:34 +0200 Subject: [PATCH 1/2] Add details of the reference paper in the CITATION.cff file --- CITATION.cff | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..44524b1 --- /dev/null +++ b/CITATION.cff @@ -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" From 6a9edd712f00f9380e63b3ba659da875f85709ec Mon Sep 17 00:00:00 2001 From: Ishaan Desai Date: Thu, 22 Aug 2024 17:26:01 +0200 Subject: [PATCH 2/2] Format README --- README.md | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ce608b1..1197506 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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: @@ -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).