-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the FigureForge wiki! This space will host the documentation for FigureForge, once it has been created. In the meantime, considering checking out the FAQ.
The goal is to provide a graphical interface to produce and modify matplotlib figures. In other words, anything that you can do with matplotlib's API via code, you should be able to do via FigureForge's GUI. We're still in the early development of FigureForge, and so most API capabilities have not been implemented yet.
At this point, a majority of the matplotlib API capabilities aren't yet in FigureForge, including, importantly, the ability to add plots, scatters, etc. So for now, the best way to use FigureForge is to construct your basic figure, including its axes layout and plot the data, then open that file in FigureForge to do the fine tuning. FigureForge returns your figure object when it closes so you can make further changes to it. This workflow might look something like:
import pickle
import matplotlib.pyplot as plt
import FigureForge as FF
fig, ax = plt.subplots()
ax.plot([1,2,3,4],[1,4,9,16])
# Do edits with FigureForge...
fig = FF.run(fig)
Alternatively, running the FigureForge
command in a terminal will open the GUI directly. This, in fact, is the intended use of FigureForge.
> FigureForge
Right now, the way I use FigureForge is by writing a script that produces the basic structure of my figure, including all the data ingestion, analysis, and basic plotting, then fine tuning the formatting in FigureForge and exporting it from there. That way, if I decide I want to adjust the position of a label or something, I don't have to re-run my script to reproduce the figure; I can just tweak the value and see it update live. I also use a range of plugins (which are just Python scripts) to automate some of the repetitive formatting tasks.
In the future, my intention is to add functionality to import data and add line and other plots with that data. At that point, the entire figure-making workflow will be entirely within FigureForge.