Making Magnipy User-FRIENDly

[emsimons]

The One Where... We Explain How to Use Magnipy

Update the README

• Create Usage section
• Add overview figure (?)
• Potentially add graphics
• Introduce 2 classes, Magnipy and Diversipy
• Direct user towards tutorials

Create a Jupyter notebook tutorial for the Magnipy class, including

• Overview of magnitude and its relevance
• How to choose distance metric
• Demonstrate scaling (maybe one manual, one automatic?)
• Computing similarity matrix
• Computing magnitude weights (optional)
• Computing magnitude
• Plotting magnitude function
• Allude to other functionalities of Magnipy

Create a Jupyter notebook tutorial for the Diversipy class, including

• Description of why magnitude is a good metric for diversity (nod to axioms)
• Show three datasets (3D plot them)
• Compute magnitude for each and plot magnitude functions
• Compute MagArea for each
• Compute MagDiff -> heat map
• Compute MagDiff with reference space (optional)