Add ring pattern generator

[AgBorrelli]

Add ring pattern calculator to address #88

[pc494]

Hi @AgBorrelli, great that you've got going on this. When you want some feedback feel free to request a review from me.

[dnjohnstone]

Thanks for chipping in @pc494 - I think the plan now is to use get_profile_data to create a ProfileSimulation (which is all in the code) and then add a method to ProfileSimulation like get_ring_pattern using the code introduced so far in this PR to get a numpy array of the ring pattern.

Does that make sense?

I think it highlights also that we might want to consider the name Profile in general... but I'm not sure if 1D or whatever would be better?

[pc494]

Sounds great, given the potential rename I think 0.4 is the correct label.

[dnjohnstone]

Is this still active @AgBorrelli - do you need any input here?

[AgBorrelli]

Is this still active @AgBorrelli - do you need any input here?

Yes still active, I had a few corrections needed to MPhil thesis and DC was very slow. Haven’t been back on to this until I will start again on Monday. Got a lot of reading to do and this is also definitely on upcoming list. I had been doing tutorials to understand what a class is first, etc. Thanks

[dnjohnstone]

@pc494 - how would you feel about a merge-as-is on this for diffsims-0.4.0 given it doesn't seem to be moving much and I think that would allow the corresponding code to be removed from pyxem at least tidying that part up?

[pc494]

I had thought about this, but then felt like I had too many pyxem bits on my plate to want to do it right away, that load seems to have eased since then, so I'm in favour.

I will merge this PR into master, and then merge master into #143 (which is yet to go in) and then update the Changelog + API import there if that sounds good to you?

[dnjohnstone]

yep sounds good