安装
=============

:Author: Zhu Dengda
:Email:  zhudengda@mail.iggcas.ac.cn

-----------------------------------------------------------


**PyFMM**  目前在Linux系统上运行，依赖库包括：

:: 

    python >= 3.9
    numpy >= 1.20, < 2.0
    scipy >= 1.10 
    matplotlib >= 3.5 
    jupyter 


C程序的编译链接基于 `gcc` 编译器，编译命令使用 `make`，确保系统已安装相应工具。 

以ubuntu为例，安装 `gcc` 和 `make` :

::

    sudo apt install build-essential 


Makefile位于 *C_extension/Makefile* ，你可以自定义你的编译器和编译命令。 



程序下载
----------

**建议在** `Release <https://github.com/Dengda98/PyFMM/releases>`_ **中下载最新稳定版本**，
不推荐clone，不推荐直接下载主分支。


程序安装
----------


由于以上涉及的库均为常用库，如果你对上述依赖库很熟悉，并且了解Python库的安装以及虚拟环境的使用，\
则可根据自己Python环境的情况快速安装，直接到 :ref:`第2步 <install_step_2>` 。




如果你还不了解Python库的安装以及虚拟环境的搭建，可以先在网上寻找相关教程。这里以 `Anaconda <https://www.anaconda.com>`_\
为例，搭建虚拟环境，完成Python库的安装。


1. 环境创建    

新建虚拟环境，命名为py310，安装python=3.10  
:: 

    conda create -n py310 python=3.10  

激活虚拟环境  
::

    conda activate py310  

.. _install_step_2:

2. 安装 **PyFMM**   

将压缩包解压后，进入目录，直接运行pip安装命令  
::

    pip install -v . 

这将完成以上Python库的安装，以及C程序的编译链接。