search

CityScope / cityscope.github.io

Documentation for MIT CityScope Project
https://cityscope.github.io
60 stars 13 forks source link

Mismatch in types documentation #38

Closed RELNO closed 4 months ago

RELNO commented 3 years ago

@LAAP as mention here, https://github.com/CityScope/CS_cityscopeJS/issues/115, there's a slight inconsistency with how we describe "P" here: https://cityscope.media.mit.edu/docs/modules/Types%20System vs here:

Screen Shot 2021-01-23 at 20 35 43
LAAP commented 3 years ago

Hi @RELNO ,

Thanks for Asking. You are right, We could explain "proportion" a bit more in depth in the documentation. "Proportion" is equal to "P" and it is "the percentage (%) of floors are devoted to a use in a "mixed use building/type". A 30% of a uses it is equal to "P": 0.3

However it is explained in "Mixed use building"

Screen Shot 2021-01-25 at 9 37 04 AM
RELNO commented 3 years ago

thanks -- can you update the docs in accordance? in terms of data format "P" and "proportion" are not the same as @takesei pointed out. I can fix the docs myself, but I don't have access to images.

LAAP commented 3 years ago

@RELNO , Sure I will do it ASAP. Pease, can you explain a bit more, the action needed when you say: "in terms of data format "P" and "proportion" are not the same as @takesei pointed out." ?

@takesei says: "This topic isn't covered in the document (https://cityscope.media.mit.edu/docs/modules/Types%20System) (or maybe changing its name to "P" value??), so I'm a little confused."

I think that he maybe using an old version of the code (Maybe Corktown?) before the final "unification", where "proportion" was still as the way of referring to "P". Isn't it?

RELNO commented 3 years ago

I think that he maybe using an old version of the code (Maybe Corktown?) before the final "unification", where "proportion" was still as the way of referring to "P". Isn't it?

Yeah, I think that's the reason. It's basically making sure we're all on the same page in term of the data format we exchange between the modules and the FE/BE. Thanks!

crisjf commented 3 years ago

This is a documentation change alone, right? Or does something need to change in the way we parse the data?

RELNO commented 3 years ago

This is a documentation change alone, right? Or does something need to change in the way we parse the data?

I suspect (hope!) so.

LAAP commented 3 years ago

@crisjf , It is just a clarification at the Documentation. No worries!