Installation

OpenFerro is available on GitHub.

First, create a new conda environment and activate it:

conda create -n openferro python=3.10
conda activate openferro

Then, we will install JAX. OpenFerro requires JAX 0.4.0 or later. See [JAX installation guide](https://jax.readthedocs.io/en/latest/installation.html) for more details.

  • CPU-only (linux, macos, windows):

pip install -U jax

  • GPU (NVIDIA, CUDA 12)

pip install -U "jax[cuda12]"

Last, let us install OpenFerro:

git clone https://github.com/salinelake/OpenFerro.git
cd OpenFerro
pip install .

Try importing OpenFerro in Python command line:

import openferro as of

Congratulations! You have successfully installed OpenFerro.