fenics team mailing list archive

[Kristian Oelgaard <k.b.oelgaard@xxxxxxxxx>]

On 28 April 2010 18:13, Anders Logg <logg@xxxxxxxxx> wrote:
> Sounds good, I hope Kristian can give you some instructions on what
> you can help out with.

Sure, we're still in the process of figuring out exactly how the format should be, but I think the demos might be the easiest place to start. Do we want to recategorize the demos as suggested in the blueprint, or should we just start adding all the demos that we have in DOLFIN and keep the directory structure?
Either way, it might be a good idea to start looking at the documentation that we have now for the Poisson equation, then we can work on getting that in good shape (both C++ and Python) so we can work out a good framework for documenting the other demos.

You can also have  a look at https://blueprints.launchpad.net/fenics-doc where I put some initial thoughts about what we need, and then of course joining the discussion here on the list is also an important way to help out.

Kristian

> --
> Anders
>
>
> On Wed, Apr 28, 2010 at 11:40:11AM -0400, Nathan Borggren wrote:
> > Hello,
> >      If anybody is interested I'd be willing to help with some documentation
> > efforts.  My background is in math and physics and tend to work exclusively on
> > the python end of things when computers get involved.  I've been working with
> > FEniCS for maybe a month or two so am rather a novice on that end but
> > nonetheless I've been using python and doing functional analysis for a long
> > time and perhaps could contribute.  If some of the demos need transcriptions to
> > a latex readable/physicist readable format like the new Poisson documentation I
> > could be of aid.  I'm currently working with diffusion equations and could help
> > in that direction particularly.  How could I lend a hand?
> >        Nathan Borggren
> >
> > On Tue, Apr 27, 2010 at 5:29 AM, Anders Logg <logg@xxxxxxxxx> wrote:
> >
> >     On Tue, Apr 27, 2010 at 10:15:21AM +0200, Kristian Oelgaard wrote:
> >     >
> >     >
> >     > On 27 April 2010 09:51, Anders Logg <logg@xxxxxxxxx> wrote:
> >     > >I think the new structure looks very good. A couple of suggestions:
> >     > >
> >     > >1. Perhaps "Documenting FEniCS" should be part of "Contributing to
> >     > >FEniCS"? It seems it otherwise gets a too prominent place in the
> >     > >overview. I expect there will be very few people interested in
> >     > >knowing how to write documentation (unfortunately).
> >     >
> >     > Which I why I decided to promote it on the front page! :)
> >     > But I agree that it fits more naturally in the Contributing part.
> >     > I'll move it.
> >     >
> >     > >2. Should "User Manual" be renamed "Programmer's reference?"
> >     >
> >     > Yes, I think that is a better name for what it really is (will be).
> >     >
> >     > Kristian
> >
> >     ok, great.
> >
> >     Now we just need some contents...
> >
> >
> >     -----BEGIN PGP SIGNATURE-----
> >     Version: GnuPG v1.4.9 (GNU/Linux)
> >
> >     iEYEARECAAYFAkvWrnAACgkQTuwUCDsYZdFUpwCfWLuTe+OD6eBST4E7cmv5S4zy
> >     0+UAnR7qBlPy6k7hK+iymNfGagXkQ6Cd
> >     =EN7E
> >     -----END PGP SIGNATURE-----
> >
> >     _______________________________________________
> >     Mailing list: https://launchpad.net/~fenics
> >     Post to     : fenics@xxxxxxxxxxxxxxxxxxx
> >     Unsubscribe : https://launchpad.net/~fenics
> >     More help   : https://help.launchpad.net/ListHelp
>
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.9 (GNU/Linux)
>
> iEYEARECAAYFAkvYXsYACgkQTuwUCDsYZdEm1gCgixVFogSvEHyRvzkxoyIjVVdt
> bKkAn3TrlvL8QYbUeQyAw5Qle+l/zmdE
> =FFok
> -----END PGP SIGNATURE-----

Attachment: signature.asc
Description: OpenPGP digital signature