FDS needs a WIKI

21 views
Skip to first unread message

daserra

unread,
Jan 3, 2009, 6:42:42 AM1/3/09
to FDS and Smokeview Discussions
I think that FDS has reached a stage that it needs a WIKI to keep
users informed. Just look whar those people from MIT have done for the
code MEEP (google MEEP). This could be also done for FDS and users
could share their experience with others. I dont think that the NIST
team should do all the work, maybe somebody else has a good access to
computers.

dr_jfloyd

unread,
Jan 3, 2009, 9:47:09 AM1/3/09
to FDS and Smokeview Discussions
There is a wiki at code.google.com/p/fds-smv

Any user of the group can create a page on this forum site.

daserra

unread,
Jan 3, 2009, 2:39:39 PM1/3/09
to FDS and Smokeview Discussions
This WIKI looks very strange to me. I was thinking of something
looking like this:
http://ab-initio.mit.edu/wiki/index.php/Meep
I have some experience with a version of Mediawiki, which we use as
knowledge base and user support and everybody in the group can add
some experience

dr_jfloyd

unread,
Jan 3, 2009, 5:26:33 PM1/3/09
to FDS and Smokeview Discussions
Looked at meep the page. What does it have that we are missing? The
FDS home page at NIST links to the executable code, the source, the
documentation, and the issue tracker and this discussion forum. The
tracker and the forum point to the other locations as well. The meep
wiki doesn't seem to have much of anything different in terms of
content that isn't present in one of the existing FDS web pages.
Speaking as a developer, the fewer places we have to monitor to
interact with users the better.

Alexander Ramlow

unread,
Jan 3, 2009, 5:51:18 PM1/3/09
to fds...@googlegroups.com
I agree that FDS needs a Wiki and maybe a better forum than there is currently in place. considering the number of people using FDS it got a fairly poor quality forum and no wiki that could have tutorials that specifically target problems and don't get of the topic half way through it.
I like FDS alot, but it's sometimes a pain to get things working and having a very thorough knowledge base would be extremely helpful.

Having a wiki and a froum are not many places and are not really hard to look after! I think the current forum in the form of google groups is far harder to maintain than a proper forum!

dr_jfloyd

unread,
Jan 3, 2009, 8:02:06 PM1/3/09
to FDS and Smokeview Discussions
Amount of effort we spend maintaining the forum and the code site is
zero. That is done by the good folks at Google, we don't spend any
resources keeping the site up and running only the time spent
answering questions in the forum or responding to issues in the
tracker. Each minute we would spend maintaining something on our own
would be minutes we wouldn't spending developing FDS, fixing bugs, or
answering questions. Keep in mind FDS development is a small group
of people and none of us have FDS development activities as our full
time jobs.

Alexander Ramlow

unread,
Jan 4, 2009, 12:51:58 AM1/4/09
to fds...@googlegroups.com
Fair enough, but considering the wide userbase of FDS one would think there would be a justfication for a dedicated development team. Having a more userfriendly "interface" between developers and users/customers would improve the software from both ends. I sometimes feel not to answer questions or put problems onto the site due it's unprofessional and cumbersome layout.
Having said that, I have to admit it is hard to put something in place if the software is free.

One thing I would be interested in is some more detailed documentation about the actual Fortran core and what happens where. This could be beneficial for people who would be interested in writing like add-ons for FDS. Considering FDS is an open-source solution one would be incline to publish add-ons on the FDS site/forum.

Please don't take this as criticism, rather a comment ...

dr_jfloyd

unread,
Jan 4, 2009, 9:59:08 AM1/4/09
to FDS and Smokeview Discussions
It would be great to have an order of magnitude or more of funding,
but FDS is not a commercial program supported by sales it is funded by
taxpayer dollars.

I agree that some form of brief programmer's manual would be useful.

Hostikka Simo

unread,
Jan 4, 2009, 3:30:37 PM1/4/09
to fds...@googlegroups.com
I would also love to have a programmer's guide for FDS. Two questions:
1) What would be a good way of implementing such a guide. Somehow, it should link to the actual svn repository to reflect the current state of the code. (Actually, this is something that a good programming editor should have). And it should be of 'wiki' nature to allow anyone (group members) to contribute.
2) My main responsibilities are in radi.f90 and some parts of wall.f90 and read.f90. In my current way of working, I have very little time for this stuff, and documentation would only be written for possible new things. Would someone be willing to go through relatively large pieces of the code and write the guide?

My fear is that the guide would not be deep enough to help the actual developers, but those being FDS beginners. Such as students having an assignment to change some part of FDS.

Simo


________________________________

Lähettäjä: fds...@googlegroups.com puolesta: Alexander Ramlow
Lähetetty: su 4.1.2009 7:51
Vastaanottaja: fds...@googlegroups.com
Aihe: [fds-smv post:6050] Re: FDS needs a WIKI


Fair enough, but considering the wide userbase of FDS one would think there would be a justfication for a dedicated development team. Having a more userfriendly "interface" between developers and users/customers would improve the software from both ends. I sometimes feel not to answer questions or put problems onto the site due it's unprofessional and cumbersome layout.
Having said that, I have to admit it is hard to put something in place if the software is free.

One thing I would be interested in is some more detailed documentation about the actual Fortran core and what happens where. This could be beneficial for people who would be interested in writing like add-ons for FDS. Considering FDS is an open-source solution one would be incline to publish add-ons on the FDS site/forum.

Please don't take this as criticism, rather a comment ...

dr_jfloyd wrote:

Amount of effort we spend maintaining the forum and the code site is
zero. That is done by the good folks at Google, we don't spend any
resources keeping the site up and running only the time spent
answering questions in the forum or responding to issues in the
tracker. Each minute we would spend maintaining something on our own
would be minutes we wouldn't spending developing FDS, fixing bugs, or
answering questions. Keep in mind FDS development is a small group
of people and none of us have FDS development activities as our full
time jobs.

On Jan 3, 5:51 pm, Alexander Ramlow <a...@ramlow.com.au> <mailto:a...@ramlow.com.au> wrote:


I agree that FDS needs a Wiki and maybe a better forum than there is
currently in place. considering the number of people using FDS it got a
fairly poor quality forum and no wiki that could have tutorials that
specifically target problems and don't get of the topic half way through it.
I like FDS alot, but it's sometimes a pain to get things working and
having a very thorough knowledge base would be extremely helpful.

Having a wiki and a froum are not many places and are not really hard to
look after! I think the current forum in the form of google groups is
far harder to maintain than a proper forum!

dr_jfloyd wrote:


Looked at meep the page. What does it have that we are missing? The
FDS home page at NIST links to the executable code, the source, the
documentation, and the issue tracker and this discussion forum. The
tracker and the forum point to the other locations as well. The meep
wiki doesn't seem to have much of anything different in terms of
content that isn't present in one of the existing FDS web pages.
Speaking as a developer, the fewer places we have to monitor to
interact with users the better.


On Jan 3, 2:39 pm, daserra <m...@grs.de> <mailto:m...@grs.de> wrote:


This WIKI looks very strange to me. I was thinking of something
looking like this:http://ab-initio.mit.edu/wiki/index.php/Meep
I have some experience with a version of Mediawiki, which we use as
knowledge base and user support and everybody in the group can add
some experience


On 3 Jan., 15:47, dr_jfloyd <drjfl...@gmail.com> <mailto:drjfl...@gmail.com> wrote:


There is a wiki at code.google.com/p/fds-smv


Any user of the group can create a page on this forum site.


winmail.dat

Kevin

unread,
Jan 4, 2009, 3:58:40 PM1/4/09
to FDS and Smokeview Discussions
Bryan Klein has suggested the use of "Robodoc" to document the source
code.

http://www.xs4all.nl/~rfsber/Robo/robodoc.html

The idea is that we embed hooks in the source code that robodoc reads
and creates an HTML or PDF document from it. From what I have seen, it
requires that we add component and variable definitions to the
beginning of subroutines, much like one normally does in a program.
Even so, it's a big undertaking to go back and document everything. I
would guess to get started that we just add a description to each
subroutine that robodoc can then use to at least outline the code.
Later, we add detail as we go along.

It might be a good job for a summer student (assuming we can get one)
to set up the "boilerplate", and then we add info as we have time.
>  winmail.dat
> 10KViewDownload

Bryan Klein

unread,
Jan 4, 2009, 9:39:31 PM1/4/09
to FDS and Smokeview Discussions
I understand what you are asking for and there are a few options that
we might be able to pursue. But, first a little background and
explanatory information.

Jason is right that we have a 'Wiki' on the Google Code site, but that
is only editable by the development team members. He then also
correctly points out that we already have community editable pages
here within the forum that very few people have taken advantage of.
These are the same as a Wiki by definition. Only it has a GUI or HTML
Markup for content editing instead of typical Wiki markup (which I
know how to use, but find the markup to be a bit of a hassle). The
Pages on the Group also keep information at an already visited
location on the web. This has some advantage as there is not another
place on the web to get FDS-SMV related information. But, I do see
the limitations inherent to the Pages system and would rather disable
them in the Group altogether, and narrow the focus of the Group to the
discussions.

In addition to those two resources, we have a blog that is open for
community members to become regular posters on. But nobody has
requested to become a contributor yet (in almost 2 years).
http://blog.fds-smv.net

Recently I have also added a Twitter channel for anyone to send fds-
smv related twitter updates to. (using @fds_smv in their twitter
post) http://twitter.com/fds_smv

So now we come down to the issue at hand...
Should we add another service to the collection? Will members of the
FDS-SMV community step up and take responsibility for creating
valuable content and maintaining the new service if it is put in
place?

I recognize that Group Pages are not exactly what you have in mind
when you use the MEEP site for comparison. So in good faith that if I
build it, they will contribute. I put together a Google Site, which
is based on the old JotSpot Wiki service. This is a very flexible and
capable platform that allows all of us in the Group who already have
Google Accounts (thank goodness not another account to sign up for) to
become contributors to the content there. Please recognize that this
site is by the community for the community... it is not another site
for the FDS-SMV Development Team to keep track of and add content to.
We already have a website, the group, wikis on the code hosting site,
official PDF documentation, the blog, twitter, etc. to keep up with
and we don't need another one. So this is for you... and by 'you' I
mean everyone else in the world but us. :)

So here is the challenge, I set it up and it is a blank canvas ready
for you. All you have to do is ask me to add you to the collaborators
list and you are able to get to work. I will monitor the site and be
available to help to some extent, but I really want to see what the
community can do on their own. Eventually I will happily add some
lucky collaborator to the owners list and remove myself even further
from management of the service, but in the beginning I want to offer
some time to help a bit and get this thing off the ground.

Here is the link: http://sites.google.com/site/fdssmvsite/
If people want me to, I can map the URL http://site.fds-smv.net to the
site so the longer URL is not necessary.
I suggest as a first step to go through the following links and
understand how the system works.
http://sites.google.com/support/?hl=en
http://www.google.com/sites/help/intl/en/program_policy.html

Once someone starts adding content, I will add links to the site from
the other FDS sites and services.

I am very excited to see what comes of this.
-Bryan

Bryan Klein

unread,
Jan 4, 2009, 9:54:32 PM1/4/09
to FDS and Smokeview Discussions
The best part about Robodoc is that the documentation for the source
code is in the source code as comments, robodoc extracts the parts it
needs and can build the documentation into many different formats like
HTML, LaTeX, RTF, etc. Another nice thing about having the
documentation embedded in the source, is that it also acts as internal
documentation while you are working on the code. You would not really
need to look outside of the source to know how things work.

Anyway, checkout the link that Kevin posted and let me know what you
think. http://www.xs4all.nl/~rfsber/Robo/robodoc.html

-Bryan

Kristopher Overholt

unread,
Jan 4, 2009, 10:21:44 PM1/4/09
to fds...@googlegroups.com
I didn't know the blog was still up and running, can you add me as a poster on the blog and as a collaborator on the Google Site? kove...@gmail.com

This is a better and more centralized option than putting more redundant FDS-SMV stuff on my own site like many others have done.

Thanks, Bryan!
--
Kristopher James Overholt
Worcester Polytechnic Institute
Fire Protection Engineering Graduate Student
Secretary, SFPE WPI Student Chapter
Mobile: 832.247.7507

Bryan Klein

unread,
Jan 5, 2009, 9:14:00 AM1/5/09
to fds...@googlegroups.com
I agree about consolidation, it makes sense with such a small online
community.
Most people don't know about the blog, because the blog was never
embraced by members of the community who needed to be authors, which in
return meant that I was the only one posting content and I must admit
that I have not been super active in that regard. Thank you for
stepping forward to help create a valuable information resource for
FDS-SMV community, and I hope that others who have good information to
share will also consider becoming authors also.
On that note if you have a list of email addresses of people who would
be good authors please email me directly.

Thanks again,
-Bryan

Kristopher Overholt wrote:
> I didn't know the blog was still up and running, can you add me as a
> poster on the blog and as a collaborator on the Google Site?
> kove...@gmail.com <mailto:kove...@gmail.com>

Bryan Klein

unread,
Feb 22, 2009, 5:29:38 PM2/22/09
to FDS and Smokeview Discussions
As an update to the Wiki topic... I was reminded today to mention to
the group that ownership of the Community Wiki at http://sites.google.com/site/fdssmvsite/
was turned over to Kris Overholt. It was never my intention to own
and manage the community built Wiki site. I set it up with my
personal Google account just as an example, to get things started.
Kris was the first to volunteer to be the Point of Contact for and
become Owner of the site, and all email requesting access and
authorship rights should be directed to him.

In addition, anyone is free to setup their own Wiki and manage it
however they see fit. We do not endorse any particular community
built Wiki or Website as the 'Official' one.
I will say that Kris has the ball rolling now and it might be a good
place to start if you are interested in contributing.

As a final note to follow up on my post below, the FDS-SMV Blog has
replaced the old mailing list, and is only for members of the
Development Team to broadcast information to interested members of the
community. For more information see http://blog.fds-smv.net

-Bryan Klein



On Jan 5, 9:14 am, Bryan Klein <bryan.kl...@nist.gov> wrote:
> I agree about consolidation, it makes sense with such a small online
> community.
> Most people don't know about the blog, because the blog was never
> embraced by members of the community who needed to be authors, which in
> return meant that I was the only one posting content and I must admit
> that I have not been super active in that regard.  Thank you for
> stepping forward to help create a valuable information resource for
> FDS-SMV community, and I hope that others who have good information to
> share will also consider becoming authors also.
> On that note if you have a list of email addresses of people who would
> be good authors please email me directly.
>
> Thanks again,
> -Bryan
>
> Kristopher Overholt wrote:
> > I didn't know the blog was still up and running, can you add me as a
> > poster on the blog and as a collaborator on the Google Site?
> > koverh...@gmail.com <mailto:koverh...@gmail.com>
>
> > This is a better and more centralized option than putting more
> > redundant FDS-SMV stuff on my own site like many others have done.
>
> > Thanks, Bryan!
>
> > On Sun, Jan 4, 2009 at 20:39, Bryan Klein <bryanwkl...@gmail.com
> > <mailto:bryanwkl...@gmail.com>> wrote:
>
> >     I understand what you are asking for and there are a few options that
> >     we might be able to pursue. But, first a little background and
> >     explanatory information.
>
> >     Jason is right that we have a 'Wiki' on the Google Code site, but that
> >     is only editable by the development team members.  He then also
> >     correctly points out that we already have community editable pages
> >     here within the forum that very few people have taken advantage of.
> >     These are the same as aWikiby definition. Only it has a GUI or HTML
> >     Markup for content editing instead of typicalWikimarkup (which I
> >     know how to use, but find the markup to be a bit of a hassle).  The
> >     Pages on the Group also keep information at an already visited
> >     location on the web.  This has some advantage as there is not another
> >     place on the web to get FDS-SMV related information.  But, I do see
> >     the limitations inherent to the Pages system and would rather disable
> >     them in the Group altogether, and narrow the focus of the Group to the
> >     discussions.
>
> >     In addition to those two resources, we have a blog that is open for
> >     community members to become regular posters on.  But nobody has
> >     requested to become a contributor yet (in almost 2 years).
> >    http://blog.fds-smv.net
>
> >     Recently I have also added a Twitter channel for anyone to send fds-
> >     smv related twitter updates to. (using @fds_smv in their twitter
> >     post)  http://twitter.com/fds_smv
>
> >     So now we come down to the issue at hand...
> >     Should we add another service to the collection? Will members of the
> >     FDS-SMV community step up and take responsibility for creating
> >     valuable content and maintaining the new service if it is put in
> >     place?
>
> >     I recognize that Group Pages are not exactly what you have in mind
> >     when you use the MEEP site for comparison.  So in good faith that if I
> >     build it, they will contribute.  I put together a Google Site, which
> >     is based on the old JotSpotWikiservice.  This is a very flexible and
> >     capable platform that allows all of us in the Group who already have
> >     Google Accounts (thank goodness not another account to sign up for) to
> >     become contributors to the content there.  Please recognize that this
> >     site is by the community for the community... it is not another site
> >     for the FDS-SMV Development Team to keep track of and add content to.
> >     We already have a website, the group, wikis on the code hosting site,
> >     official PDF documentation, the blog, twitter, etc. to keep up with
> >     and we don't need another one. So this is for you... and by 'you' I
> >     mean everyone else in the world but us. :)
>
> >     So here is the challenge, I set it up and it is a blank canvas ready
> >     for you.  All you have to do is ask me to add you to the collaborators
> >     list and you are able to get to work.  I will monitor the site and be
> >     available to help to some extent, but I really want to see what the
> >     community can do on their own.  Eventually I will happily add some
> >     lucky collaborator to the owners list and remove myself even further
> >     from management of the service, but in the beginning I want to offer
> >     some time to help a bit and get this thing off the ground.
>
> >     Here is the link:http://sites.google.com/site/fdssmvsite/
> >     If people want me to, I can map the URLhttp://site.fds-smv.netto the
Reply all
Reply to author
Forward
0 new messages