Creation of Suffering Index Engine Method

[kayleighhoude]

Description:

Creation of Suffering Index Engine Method, per the prototype shown here:

Test script here: https://burohappold.sharepoint.com/sites/BHoM/02_Current/Forms/AllItems.aspx?newTargetListUrl=%2Fsites%2FBHoM%2F02%5FCurrent&viewpath=%2Fsites%2FBHoM%2F02%5FCurrent%2FForms%2FAllItems%2Easpx&id=%2Fsites%2FBHoM%2F02%5FCurrent%2F12%5FScripts%2F01%5FIssue%2FBHoM%2FEmbodiedSuffering%5FToolkit&viewid=a5a93cba%2Dfcca%2D46cc%2Da31a%2D80b8d5cbfd7b

[michaelhoehn]

@kayleighhoude can you please add a written summary of the requested method for posterity?

I'm aware of what you'd like to see here, but it's unclear by simply looking at the issue itself. Thank you! 🚀

[michaelhoehn]

@kayleighhoude questions/notes that have come up during the development process that should be addressed here as part of the issue documentation:

• The way in which you are using the Library match method is grasshopper biased, meaning that it's not possible to do what you're doing in any other BHoM-ready UI. Passing lists of values to search is not something this method is created to do natively. The method as it stands uses a single string as input rather than a list. Therefore for this exact implementation to be functional a new issue + PR would need to be raised in the BHoM Engine repo. However, in my branch, I've bypassed this and required the user to provide this data so we can move forward for now.
• List length issues. As noted in your example script, you need to replace missing values with zeros. It would be good to make sure you document that necessity here so people know the intention/functionality. I am currently requiring the lists to be the same lengths, or the calc will fail.
• Is the desired result from this calculation really one number for the whole world? I'm speaking about the mass addition at the end of the example script. Or do you prefer to leave things as a list output?

Thanks!

[kayleighhoude]

Thanks for the prompt to elaborate (so much of this has lived on the Grasshopper canvas and in conversation, good to get it down in the public realm!) @michaelhoehn

1. Re: library queries not being available, we may need to bypass them by encoding the Global Slavery Index "lookup" data in the method (this is the only dataset that will be utilised in the near term)- not ideal, but may be necessary at this point.
2. The null/zero values should be created as an additional output (understanding your missing data is valuable)
3. As shown in the revised prototype above, there are (4) desired outputs: an amalgam Slavery Index, a list of "red list" countries, the percentage deriving from "red list" countries and the countries that did not have a matching slavery value (the GSI did not include several globally recognized countries in their 2018 data.)