Installation

The package was developed in Windows and the exact package versions for the environment in Windows are available for Anaconda.

  1. If you don’t already have Anaconda installed: Download and install Anaconda from https://www.anaconda.com/.

  2. If you don’t already have git installed: Download and install git from https://git-scm.com/downloads

  3. Open a terminal, navigate to the folder where you want to put FigureFlow and clone the FigureFlow repository:

git clone https://github.com/maxschelski/figureflow.git

  1. Navigate into the folder of the repository (figureflow):

cd figureflow

  1. Create environment for FigureFlow with Anaconda:

conda env create -f environment.yml

  1. Activate environment with Anaconda:

conda activate figureflow

  1. Install FigureFlow locally using pip:

pip install -e .

  1. Optional: If needed, install spyder to create, edit and run scripts:

conda install spyder

  1. Optional: start spyder

spyder

  1. You can now import FigureFlow and use it to build figures and generate movies as figure objects

from figureflow.figure import Figure

  1. Open and execute example scripts from repository in the folders figureflowscriptsfigures and figureflowscriptsmovies