ladybug-tools / honeybee-radiance / 79

81%

Pull #31

travis-ci

feat(modifier): Refactor modifier modules

This is an initial refactor of the whole library in preparation to make it an extension of honeybee-core. There are a number of edits included in it:

* Completed the ModifierSet object, including the from_dict method
* Fixed some places where native python operators (like type) were being overwritten with variable names
* Filled in a number of incorrect docstrings that were copy/pasted from other classes but never edited
* Added the term "primitive dictionary" to differentiate the generic schema of Radiance Primitives from dictionaries following a schema specific to a given primitive. I used this throughout several docstrings that I added and this should help clarify what's going on to new users.
* The use of the Point3D class in geometry primitives was unnecessary since the only purpose these primitives serve now is translation to/from Radiance. They have no need for any geometry computation and any of that should probably happen on Rooms, Faces, Apertures, Doors, Shades where we use real 3D objects like Face3D or Sphere (not just points). So I think we should leave these geometry primitive classes as something used only in the writer/reader modules for serialization. And the use of Point3D objects was actually interfering with this primary purpose by introducing an in-elegant schema for serializing points to a dictionary that's not even used within ladybug_geometry.  So we should just  keep points and vectors simple using arrays to represent them.
* Switched to using iterables for primitive values (list instead of dictionary). This uses much less memory, it's cleaner for hashing + copying, and it avoids the possibility of the user getting a KeyError when they go the check the values by index (what seems to be one of the major use cases of the property). Using lists also simplified a lot of the code but, if you are attached to the dictionaries, Mostapha, we can put them back and I'll need to add some extra ... (continued)

862 of 862 new or added lines in 67 files covered. (100.0%)

2357 of 2833 relevant lines covered (83.2%)

2.49 hits per line