Installation

Contents

Installation#

Create a conda environment from the given environment.yml file and activate it:

conda env create -f environment.yml
conda activate jax-fem-env

Several remarks:

  • JAX-FEM depends on JAX. Please follow the official instructions to install JAX according to your hardware.

  • Both CPU or GPU version of JAX will work, while GPU version usually gives better performance.

Then there are two options to continue:

Option 1#

Clone the repository:

git clone https://github.com/deepmodeling/jax-fem.git
cd jax-fem

and install the package locally:

pip install -e .

Option 2#

Install the package from the PyPI release directly:

pip install jax-fem