honeybee documentation

Replies to This Discussion

Permalink Reply by Chris Mackey on April 9, 2014 at 8:47pm

Hi Claudio,

This sounds like a good idea.  I just finished re-writing all of the descriptions for the components, inputs and outputs of Ladybug and I was going to compile them all into a word document to check my spelling.  I will be sure to publish this document when I finish it so that you can search for keywords, etc.

I was going to do something similar for honeybee eventually but I am not sure when I will be able to get around to it.  I will see if I can get to it sometime in the next few weeks.  In the meantime, if you want to search for keywords in Honeybee, the best I can think of is searching through the github repository here: https://github.com/mostaphaRoudsari/honeybee

At the top is a search bar that you can use to search for keywords in the code and the descriptions.  Mostapha may have something better than this.

-Chris

Permalink Reply by Mostapha Sadeghipour Roudsari on April 10, 2014 at 5:58am

Hi Claudio and Chris,

This is such a fair request and we are getting this more and more these days. Unfortunately we don't have a documentation eight now.

I think a better solution is to start a wiki page for Ladybug and Honeybee so you can find not only the list but also an explanation and some example files. This should be a collaborative work which all the community can contribute and generate contents for the wiki page. We already have a number of volunteers to help with the contents of wiki page, so I think it is doable.

We need to find the right platform first. Do you have any suggestions for that?

Mostapha

Permalink Reply by Claudio on April 10, 2014 at 2:00pm

Mostapha

I think the wiki page idea is great. But I'm a complete newbe in regards to wiki things, also what do you mean by right platform. This being said, I will love to contribute to the documentation process, count me in if you need help to build this wiki page.

 

Stand by

 

cheers

Permalink Reply by Chris Mackey on April 12, 2014 at 8:50am

Hi Mostapha and Clauudio,

I agree that an online wiki would probably be the best way to document Ladybug and Honeybee as we could wrap all of the descriptions, example files, tutorial videos, and teaching materials into a single online location.  However, I will admit that I don't have too much experience setting these types of things up.  The only example that I know of is what the makers of the CBE Comfort Tool (http://smap.cbe.berkeley.edu/comforttool) set up to make their code accessible to open source developers (https://code.google.com/p/cbe-comfort-tool/w/list).

I guess they were using "Google Project" as their platform (https://code.google.com/p/support/).  Knowing Google's awesomeness in the realm of coding, developing, and free services, I would expect their platform to be one of the best.  Do you know of any other platforms, Mostapha?

-Chris

Permalink Reply by Mostapha Sadeghipour Roudsari on April 12, 2014 at 5:35pm

Hi Claudio and Chris,

Thank you Claudio for the support.

Chris, I like Google projects however I would suggest to use github wiki page if we want to have a wiki next to the code. Github also offers wiki page. Check Dynamo's wiki page as an example (https://github.com/DynamoDS/Dynamo/wiki).

Google projects and github are both nice but not graphically the best. It is also not the most user-friendly environment if we are looking for everyone's contribution.

There was a similar discussion in Radiance community and someone suggested Blender wiki page as a good example: http://wiki.blender.org/. I think it looks pretty good. They are using mediawiki which is a free and opensource Wiki package: http://www.mediawiki.org/wiki/MediaWiki

I have done no real research on this so take it as me thinking loud!

Mostapha

PS: Chris, If you haven't already copy-pasted the help information manually I can put a script together that does it for you. Thanks again for revising the descriptions. People loved it. :)

Permalink Reply by Chris Mackey on April 14, 2014 at 12:34am

Hi Mostapha,

I agree that the blender wiki is the best that I have seen and I think you are likely the most knowledgeable out of us in the discussion so far.  Also agree that a github or google wiki would not be giving us anything much better than what we already have.  I would just go with a MediaWiki if no other suggestions pop up here in the near future.

I have not yet copy-pasted the descriptions info.  A script or component to do this would be immensely helpful and would probably help a lot with updating the future wiki.  Please let me know if you get around to it.

-Chris

Permalink Reply by Mostapha Sadeghipour Roudsari on April 14, 2014 at 5:13pm

Hi Chris and Claudio,

I used the attached script to export all the descriptions to a text file and then copied them into google docs.

Ladybug_Help: https://docs.google.com/document/d/1w8Bj_y9S73g1-em384FTAo5epv4bupr...

Honeybee_Help: https://docs.google.com/document/d/1sCHs6SrC2XmU-u6qoXE6ukPR8Vipy6r...

Claudio, this is definitely NOT a well formatted help file but should work as a temporary solution until we start the wiki page.

Mostapha

Attachments:

• exportHelp.gh, 4 KB

Permalink Reply by Claudio on April 15, 2014 at 11:38am

This is a great start. I'm in to it right now. We have a Huge new project starting this week and I really like to use LadyBug and HoneyBee as a design tool. This Google doc wiil be very helpfull.

It could be nice to have an image of the component right beside the title. I guess this will be for the upcomming wikipage

Thak you Mostapha. Keep me informed as I still like to cooperatre in any developpement of this plugin

cheers