We want to develop an efficient and easy to use finite element software package to support our teach and research work.
We still have lot work to do.
First, clone the FEALPy repository from GitHub
git clone https://github.com/weihuayi/fealpy.git
If you can't acess GitHub, you can clone it from Gitee
git clone https://gitee.com/whymath/fealpy
It is recommended to create a virtual environment to manage dependencies:
python -m venv fealpy_env
source fealpy_env/bin/activate # On Windows, use `fealpy_env\Scripts\activate`
Then change directory to the cloned repository and install FEALPy in editable(-e
) mode:
cd fealpy
pip install -e .
If you want to install optional dependencies, such as pypardiso
, pyamg
, meshpy
and so on, you can do so by specifying the [optional] extra:
pip install -e .[optional]
To install both development and optional dependencies, use:
pip install -e .[dev,optional]
To verify that FEALPy is installed correctly, you can run the following command:
python -c "import fealpy; print(fealpy.__version__)"
To update your FEALPy installation to the latest version from the source repository, navigate to the FEALPy directory and pull the latest changes:
cd fealpy
git pull origin main
To uninstall FEALPy, just run the following command:
pip uninstall fealpy
For FEALPy developers, the first step is to create a fork of the https://github.com/weihuayi/fealpy repository in your own Github account.
Clone the FEALPy repository under your own account to the local repository:
# replace<user name>with your own GitHub username
git clone [email protected]:<user name>/fealpy.git
Note that the following operations need to be operated in the fealpy folder.
Set up the upstream repository:
git remote add upstream [email protected]:weihuayi/fealpy.git
Before local development, need to pull the latest version from the upstream repository and merge it into the local repository:
git fetch upstream
git merge upstream/master
After local development, push the modifications to your own remote repository:
git add modified_files_name
git commit -m"Explanation on modifications"
git push
Finally, in your own Github remote repository, open a pull request to the upstream repository and wait for the modifications to be merged.
The sparse pattern of the matrix A
generated by FEALPy
may not be the same as the theoretical pattern, since there exists nonzero values that are close to machine precision due to rounding. If you care about the sparse pattern of the matrix, you can use the following commands to eliminate them
eps = 10**(-15)
A.data[ np.abs(A.data) < eps ] = 0
A.eliminate_zeros()
To be added.
We thank Dr. Long Chen for the guidance and compiling a systematic documentation for programming finite element methods.
Please cite fealpy
if you use it in your paper
H. Wei and Y. Huang, FEALPy: Finite Element Analysis Library in Python, https://github.com/weihuayi/fealpy, Xiangtan University, 2017-2024.
@misc{fealpy,
title = {FEALPy: Finite Element Analysis Library in Python. https://github.com/weihuayi/fealpy},
url = {https://github.com/weihuayi/fealpy},
author = {Wei, Huayi and Huang, Yunqing},
institution = {Xiangtan University},
year = {Xiangtan University, 2017-2024},
}