Skip to content

Commit e82e669

Browse files
committed
update README
1 parent f91e9ea commit e82e669

1 file changed

Lines changed: 26 additions & 22 deletions

File tree

README.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,58 @@
1-
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4603558.svg?style=flat-square)](https://doi.org/10.5281/zenodo.4603557)
1+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4603558.svg)](https://doi.org/10.5281/zenodo.4603557)
22

33
# AsFem
44

5-
A **simple** finite element method program, which is short for **AsFem**. AsFem is written in C++ and designed for phase-field modeling and multiphysics coupling. The [PETSc](https://www.mcs.anl.gov/petsc/) library is involved in AsFem for the efficient computing.
5+
**AsFem**-**A**dvanced **S**imulation kit based on **F**inite **E**lement **M**ethod. AsFem is written in C++ and designed for phase-field modeling and multiphysics coupling. The [PETSc](https://www.mcs.anl.gov/petsc/) library and [MPI](https://www.open-mpi.org/) package are involved in AsFem for the scalable computing.
66

77

88
# Download
99

1010
```
11-
git clone https://github.com/M3Group/AsFem.git
11+
git clone https://github.com/MatMechLab/AsFem
1212
```
13-
For the detailed usage, one is referred to [AsFem Page](https://m3group.github.io/AsFem/) .
13+
For comprehensive details on usage, please refer to the [AsFem Page](https://matmechlab.github.io/AsFem/).
1414

15-
If one has access issues, the alternative link could be [AsFem-Gitee](https://gitee.com/m3group/AsFem.git), the git clone can be done via:
15+
If you encounter any access issues, an alternative link to explore is [AsFem-Gitee](https://gitee.com/matmechlab/AsFem). Git cloning can be executed using the following command:
1616
```
17-
git clone https://gitee.com/m3group/AsFem.git
17+
git clone https://gitee.com/matmechlab/AsFem.git
1818
```
1919

2020

2121
# Installation
2222

23-
The installation details of AsFem can be found here [AsFem-Installation](https://m3group.github.io/AsFem/install/) .
23+
Detailed installation instructions for AsFem are available at [AsFem-Installation](https://matmechlab.github.io/AsFem/install/).
2424

25-
After you've installed your PETSc (PETSC_DIR) and MPI (MPI_DIR), all you have to do is:
25+
Once you have installed PETSc and MPI (set up your PETSC_DIR and MPI_DIR), the next steps are as follows:
2626
```
2727
cmake CMakeLists.txt -DCMAKE_BUILD_TYPE=Release
2828
make -j4
2929
```
3030

3131
# Demos
32-
AsFem has several demos, you can visit them either on [Bilibili](https://space.bilibili.com/100272198/channel/detail?cid=90241) or on [Youtube](https://www.youtube.com/playlist?list=PLVEpIo_wvYmaLPoLjj5Lg93YvYy9flkN8).
32+
33+
You can explore several AsFem demos on platforms like [Bilibili](https://space.bilibili.com/100272198/channel/collectiondetail?sid=73185) and [Youtube](https://www.youtube.com/playlist?list=PLVEpIo_wvYmaLPoLjj5Lg93YvYy9flkN8).
34+
3335

3436
spinodal-decomposition | double-notch failure
3537
:-------------------------:|:-------------------------:
3638
![](figures/CahnHilliard.gif) | ![](figures/DoubleNotch.gif)
3739

3840
# Tutorial & examples
39-
The tutorial is avialable here https://m3group.github.io/AsFem/Tutorial/step-0/
4041

41-
For Chinese users, the video lecture is available on bilibili, please see [AsFem-Lecture](https://space.bilibili.com/100272198/channel/detail?cid=193605).
42+
The tutorial can be accessed at this link: [AsFem Tutorial](https://matmechlab.github.io/AsFem/Tutorial/step-0/)
4243

43-
Currently, one can find the tested input files in both the `AsFem/examples` folder as well as `AsFem/test_input` folder. For a better understanding of how to use AsFem, please take a look at these input files first.
44+
Chinese users can access the video lecture on Bilibili at [AsFem-Lecture](https://space.bilibili.com/100272198/channel/collectiondetail?sid=73182).
45+
46+
At present, the tested input files for AsFem are located in two directories: `AsFem/examples` and `AsFem/test_input`. For an enhanced understanding of how to utilize AsFem effectively, it is recommended to first examine these input files.
4447

4548
# Document
46-
The code is documented by the [Doxygen](https://www.doxygen.nl/index.html) package, one can generate the pdf file or html files via:
49+
50+
The code is documented using the [Doxygen](https://www.doxygen.nl/index.html) package. You can generate PDF or HTML files using the following commands:
4751
```
4852
doxygen
4953
```
5054

51-
More documents and details can be found in AsFem's [homepage](https://m3group.github.io/AsFem/).
55+
Additional documentation and details about AsFem are available on its [homepage](https://matmechlab.github.io/AsFem/)
5256

5357
# Author
5458
[Yang Bai](https://yangbai90.github.io/)
@@ -58,32 +62,32 @@ More documents and details can be found in AsFem's [homepage](https://m3group.gi
5862
```
5963
@misc{yang_bai_2021_4603558,
6064
author = {Yang Bai},
61-
title = {{AsFem: a simple finite element method program for
62-
phase-field modeling and multiphysics coupling}},
63-
month = feb,
65+
title = {{AsFem: Advanced Simulation kit based on Finite
66+
Element Method}},
67+
month = mar,
6468
year = 2021,
6569
publisher = {Zenodo},
66-
version = {master},
70+
version = {V0.8},
6771
doi = {10.5281/zenodo.4603558},
6872
url = {https://doi.org/10.5281/zenodo.4603558}
6973
}
7074
```
7175

7276
# Contribute
7377

74-
If you discover bugs in the `AsFem` package, please create an issue at the project repository on GitHub at https://github.com/M3Group/AsFem.
78+
If you discover bugs in the `AsFem` package, please create an issue at the project repository on GitHub at https://github.com/MatMechLab/AsFem.
7579

76-
If you find the AsFem package useful, we welcome your code and documentation contributions. To contribute, fork the repository on GitHub, and submit a pull request at https://github.com/M3Group/AsFem.
80+
If you find the AsFem package useful, we welcome your code and documentation contributions. To contribute, fork the repository on GitHub, and submit a pull request at https://github.com/MatMechLab/AsFem.
7781

7882

7983
# Contact
8084

81-
Submit bug reports and feature requests on the [repository issue tracker](https://github.com/M3Group/AsFem/issues).
85+
Submit bug reports and feature requests on the [repository issue tracker](https://github.com/MatMechLab/AsFem/issues).
8286

8387

8488
# Discussion
8589

86-
If you are interested in AsFem or have any questions, just feel free to send me an email [Mail2Me](mailto:yangbai90@outlook.com) or join the QQ group for more discussion .
90+
If you have an interest in AsFem or any questions, please don't hesitate to [Mail2Me](mailto:yangbai90@outlook.com), or join our QQ group for further discussions.
8791
```
8892
QQ group: 879908352
8993
```

0 commit comments

Comments
 (0)