InstallationΒΆ
Building from source is required to work on a contribution (bug fix, new feature, code or documentation improvement).
Use Git to check out the latest source from the mfpml repository on Github.:
git clone https://github.com/JiaxiangYi96/mfpml.git cd mfpml
Install a recent version of Python (3.10) for instance using Miniconda3. If you installed Python with conda, we recommend to create a dedicated conda environment with all the build dependencies of f3dasm:
conda create -n mfpml_env python=3.10 conda activate mfpml_env
If you run the development version, it is annoying to reinstall the package each time you update the sources. Therefore it is recommended that you install the package from a local source, allowing you to edit the code in-place. This builds the extension in place and creates a link to the development directory (see the pip docs).
pip install --verbose --no-build-isolation --editable .
Install the development requirements:
pip install -r requirements.txt