Add MigrationGraph Renderable

[hmlli]

This PR is to address issue #254 .

TO DO:

• Addition of a new file, crystal_toolkit.renderables.migration_graph
• Aaddition of a new MPComponent, to crystal_toolkit.components.migration_graph
• A small example app in crystal_toolkit.apps.examples so that this can be added to the test suite and documentation
• Corresponding tests

[mkhorton]

Hi @hmlli, let me know if there's been any progress on this or if you'd like to meet to discuss?

[hmlli]

@mkhorton sure! I'm still trying to figure out the scheme but I would like to meet to talk about it. I'll ping you in slack

[lgtm-com]

This pull request introduces 1 alert when merging 7e251c4 into b56f413 - view on LGTM.com

new alerts:

• 1 for Syntax error

[hmlli]

@mkhorton Hi Matt! I think this PR is ready as a first iteration for the MigrationGraph related contents. Feel free to run the example app to check out how it looks. Please lmk if anything else is needed : )

[janosh]

Not Matt here but left a few quick comments to save @mkhorton some time.

[janosh]

The files in crystal_toolkit.egg-info/* should be .gitignored.

[janosh]

Same with dist/crystal_toolkit-2021.4.29-py3.9.egg and anything else in dist/*.

[janosh]

Tried to run the example from the root dir with

python crystal_toolkit/apps/examples/migrationgraph.py

and got the error

FileNotFoundError: [Errno 2] No such file or directory: 'LiMnP2O7_mg.json'

To make the example robust w.r.t. cwd, you might want to change

- mg = loadfn("LiMnP2O7_mg.json")

+ import os

+ module_dir = os.path.dirname(os.path.abspath(__file__))

+ mg = loadfn(f"{module_dir}/LiMnP2O7_mg.json")

[janosh]

Files in build/* should also be ignored, not committed. Might be worth purging these files from git history since they're quite large.

[hmlli]

thanks @janosh for your help! All issues in the above conversations should be resolved. @mkhorton please let me know if anything else needs to be changed :)

[mkhorton]

Thanks both, reviewing now :)

[mkhorton]

Removed the [WIP] from this PR title, forgot this is in the review queue! Apologies for letting it sit.