AOS Designer specs

[Ariel Ouziel]

Re hello :)

I'm coming back bothering you :) I'd like to start contributing a bit on AOS Designer, but I don't see any documentation or specifications about it on the wiki nor the repo. Do you have anything describing your vision for the software ? Like wireframes, uml diagrams, or functional specs ?

Thank you !

Ariel

[Klaim - Joël Lamotte]

Hi, and thank you for your interest!

So far I've been working on my own board and paper to design AOSD but I could make some documentation if I can find the time (not much these days).

Can you tell me exactly what kind of documentation you need? I'm thinking about:

 - a diagram showing the overall code organisation/architecture of AOSD 

 - a document explaining the design principles to follow when working on AOSD

Would it be enough?

Also, are you able to compile and run the current last repo version?

Getting there would be a first big step already. 

BTW I didn't have the time to test it on other OS than Windows so if you're using linux or mac and want to give a try it would be helpful!

(I think that the missing lambda feature in MacOS compilers is a problem but maybe you can get the last GCC there in some ways).

Joël Lamotte

[Ariel Ouziel]

Hey,

I'm on a PC/Win7 x64 so I won't be helpful for other versions, sorry ;)

So I've been able to compile and run the project, but only in Release mode. It was some time ago so I don't remember exactly what was the problem. I'll send a msg about that later. I just had a few problems that are worth noting:

• XSDDIR env variable has to be set for CMAKE to run
• boost includes have to be added in VS Property Manager (include directories) as it is not included in vcproj by CMAKE
• I didn't have any "python3" command in my python installation, thus I had to change the command in postbuild events

About the documentation, what your suggesting would be good, but additionally, I think a document describing functional requirements (in user point of view) would be useful.

Thanks,

Ariel

[Klaim - Joël Lamotte]

On Tue, Feb 21, 2012 at 11:21, Ariel Ouziel <ariel...@gmail.com> wrote:

I'm on a PC/Win7 x64 so I won't be helpful for other versions, sorry ;)

No problem, we can concentrate on features instead. 

 

So I've been able to compile and run the project, but only in Release mode. It was some time ago so I don't remember exactly what was the problem. I'll send a msg about that later.

Strange! Ok I'm waiting for it.

 

• XSDDIR env variable has to be set for CMAKE to run

I think the find xsd for cmake isn't ideal, it's a tweaked version of some scripts I found somewhere else but I'm not happy with it. It works fine on my environment when I install CodeSynthesis XSD in the default directory (Win7x64) though, so if you didn't install it in the default directory it's "normal" I guess. Otherwise it's that script that is buggy. You can file an issue if you still got problems with it with the last revision.

 

• boost includes have to be added in VS Property Manager (include directories) as it is not included in vcproj by CMAKE

I wanted to add FindBoost but it wasn't working correctly with my setup, so it's noted as an issue to be fixed : http://code.google.com/p/art-of-sequence/issues/detail?id=5

 

• I didn't have any "python3" command in my python installation, thus I had to change the command in postbuild events

Sorry, that's because I renamed the python 3 executable to allow me to have both python 2 and 3 on windows. I don't know how to fix this correctly... Thanks for making me remember about this, and again, sorry v__v;

About the documentation, what your suggesting would be good, but additionally, I think a document describing functional requirements (in user point of view) would be useful.

Ok, I've not been clear, but it was in fact what I was thinking to put in the "design principles" doc. It's not a good idea to be too precise about what should happen when, but there are basic global functional requirements for the user that I'll write there.

I'll file tickets for these later.

Joël Lamotte 

[Klaim - Joël Lamotte]

Hi,

I didn't found the time to file the tickets so if you find some time to do it for me, please be my guest!

I've managed to begin an overview diagram of the AOS Designer code architecture, but it's not finished at all.

You can see it there: https://docs.google.com/drawings/d/1pFCURHLqD9MnlGr7y1JYB1j7ap9sz01OQrLl09_30AA/edit

It still lacks a lot of informations, obviously.

I'm thinking about how to write the "design guideline and objectives" doc but I'm still putting my stuffs in boxes so I guess

You'll have to wait a bit longer to get it :/ 

Joël Lamotte

[Klaim - Joël Lamotte]

Hi,

On Tue, Feb 21, 2012 at 19:21, Ariel Ouziel <ariel...@gmail.com> wrote:

• boost includes have to be added in VS Property Manager (include directories) as it is not included in vcproj by CMAKE
• I didn't have any "python3" command in my python installation, thus I had to change the command in postbuild events

I fixed those in the last commit.

Now I'm working on the docs until this evening so I hope to have some useful documentations done soon.

Klaim / Joël Lamotte 

[Klaim - Joël Lamotte]

I've just finished to write a first version of the description of the vision of AOS Designer.

It should only allow to have a broad idea of the goals to achieve, but that's a start I guess.

It should be used as a reference for taking design decisions concering AOSD.

http://code.google.com/p/art-of-sequence/wiki/AOSDesigner_VisionDesign_v1 

Feedbacks are welcome.

As noted in my last aos blog post, I will now focus on describing the global (technical) architecture of the project.

I wanted to write use-cases, but I think maybe it will limit the design possibilites to write these use cases first? Not sure yet.

Klaim / Joel Lamotte

[Klaim - Joël Lamotte]

I just finished working on the diagram explaining the AOS Designer code architecture (or the target architecture, to be more correct).

It needs an associated text and some details that I planned to write tomorrow.

https://docs.google.com/drawings/d/1pFCURHLqD9MnlGr7y1JYB1j7ap9sz01OQrLl09_30AA/edit

As for the other documents, any feedback is welcome.

Klaim / Joël Lamotte

[Klaim - Joël Lamotte]

On Fri, May 11, 2012 at 1:30 AM, Klaim - Joël Lamotte <mjk...@gmail.com> wrote:

I've just finished to write a first version of the description of the vision of AOS Designer.

It should only allow to have a broad idea of the goals to achieve, but that's a start I guess.

It should be used as a reference for taking design decisions concering AOSD.

http://code.google.com/p/art-of-sequence/wiki/AOSDesigner_VisionDesign_v1 

Feedbacks are welcome.

I've renamed this document:

http://code.google.com/p/art-of-sequence/wiki/AOSDesigner_Vision_v1

It will only contain the vision and objectives of AOSD. Two other documents are in my list:

 - code architecture of AOSD (base on this diagram: https://docs.google.com/drawings/d/1pFCURHLqD9MnlGr7y1JYB1j7ap9sz01OQrLl09_30AA/edit )

 - a "design" document to describe what kind of interface is needed to achieve the objectives (design that can obviously be discussed)

[Klaim - Joël Lamotte]

I found some time to write a document explaining the design decisions
taken for AOSL: http://code.google.com/p/art-of-sequence/wiki/AOSL_Design

I'll wait for feedbacks before upgrading this one.

I'm still working on the documents explaining how an AOSL file works
and how is AOS Designer architectured.