honeybee icon indicating copy to clipboard operation
honeybee copied to clipboard

Break-down this repository

Open mostaphaRoudsari opened this issue 6 years ago • 7 comments

This will most likely break your code! so read it!

All,

We have been working on breaking down this repository in 3 different repositories:

  • honeybee-core
  • honeybee-radiance
  • honeybee-energyplus

There are several technical reasons to do so including separation of concerns and easier maintenance of the libraries. This repository will be renamed to honeybee-radiance and two new repositories for honeybee-core and honeybee-energyplus will be created.

This change will break all your current scripts if you are importing from radiance folder. There are also changes in honeybee surface and a number of other objects. It will also break the current plugins.

If are using honeybee from command line you need to:

  1. Install honeybee-radiance from pip. It is not there yet but it will be!
  2. Change import honeybee.radiance to import honeybee_radiance.
  3. The recipes are now working differently and are designed to take a folder input which is generated from a Radiance model. I will provide enough sample codes so you can update your code.

If you are using honeybee from one of the plugins then look for the new release. We will update them accordingly so you shouldn't be worried.

To ensure we will have a smooth transition we will keep the new changes in the development branch before pushing it to master closer to the end of February. Please reply to this issue if you have any questions or concerns.

Thanks!

mostaphaRoudsari avatar Feb 16 '19 16:02 mostaphaRoudsari

Can we make sure we merge whichever PR changes this into master with commits indicating BREAKING CHANGES so semantic-release knows to bump the package to v1.0.0 from v0.x.y. That's my only concern at this stage

AntoineDao avatar Feb 16 '19 17:02 AntoineDao

@AntoineDao, thank you for the comment. I will make sure not to include that in the commit.

mostaphaRoudsari avatar Feb 16 '19 18:02 mostaphaRoudsari

  1. The recipes are now working differently and are designed to take a folder input which is generated from a Radiance model. I will provide enough sample codes so you can update your code.

Is this what's being written at https://github.com/ladybug-tools/honeybee-resources/tree/master/sample_folder_structure/project_folder?

Will there be a feature branch implementing the changes before master is merged to?

abbaad avatar Mar 01 '19 17:03 abbaad

Is this what's being written at https://github.com/ladybug-tools/honeybee-resources/tree/master/sample_folder_structure/project_folder?

Yes. That is the folder.

Will there be a feature branch implementing the changes before master is merged?

Yes. It's currently a fork. Once ready will push it in a different branch before merging it in.

mostaphaRoudsari avatar Mar 01 '19 17:03 mostaphaRoudsari

Hi! I'm new to Honeybee scripting (but long time Grasshopper user), and I find myself a bit confused here. The sample in this rep works fine, but when using honeybee-core and honeybee-radiance, I get nowhere. Where do I for example find daylight recipes (previously honeybee.radiance.recipe)?

Thanks for making great tools!

nildan avatar Feb 07 '20 08:02 nildan

@nildan, honeybee-radiance and honeybee-core are using recipes / workflows very differently. For now just use this library until the newer version is ready to use.

mostaphaRoudsari avatar Feb 08 '20 03:02 mostaphaRoudsari

@mostaphaRoudsari I see. thanks!

nildan avatar Feb 08 '20 11:02 nildan