Installation

Step 1: Create a Python Environment

If you’re not sure how to create a suitable Python environment, the easiest way is using Miniconda following their instructions. Then you can create and activate a new Python environment by running:

conda create -n my-package python=3.9
conda activate my-package

Step 2: Install FGEM

To install the stable version of FGEM, run the following:

pip install git+https://github.com/aljubrmj/FGEM

To install a different branch, append the above command with @branch. For instance, you can install the develop branch as follows:

pip install git+https://github.com/aljubrmj/FGEM@develop

Step 3: Clone GitHub Repository [OPTIONAL]

Our Github repo comes with examples, which can be useful to users. To access those examples locally, users can clone our Github repo using HTTPS, SSH, or GitHub CLI. See GitHub docs for information on the different cloning methods. If you run into issues, follow GitHub troubleshooting suggestions here.

Using HTTPS

To clone the master branch:

$ git clone https://github.com/aljubrmj/FGEM.git

To clone

$ git clone https://github.com/aljubrmj/FGEM.git

Using SSH-Key

If it your first time cloning a repository through ssh, you will need to set up your git with an ssh-key by following these directions.

$ git clone git@github.com:aljubrmj/FGEM.git

After cloning the repo, you can change directory to access the examples:

$ cd FGEM/examples