← Back to team overview

dolfin team mailing list archive

Re: description of DOLFIN package

 

Hi,

At least in the extended desciption b) I think it should be mentioned that
the methods for solving the equations are various forms of "Finite Element
Methods". This is important information for users.

For example, you could add "using Finite Element Methods." to the last
sentence.

/Johan

>
> Hi,
>
> Please comment on the following as a description of DOLFIN.
>
> I need
>
> a) A short description (under 80 chars). How about
>
> -------------------------------------------------------------------- C++
library for solving ordinary and partial differential equations.
--------------------------------------------------------------------
>
> b) An extended description. The short and extended description are
independent. How about
>
> --------------------------------------------------------------------
DOLFIN is the C++ interface of the FEniCS project in Computational
Mathematical Modeling, providing a consistent PSE (Problem Solving
Environment) for solving ordinary and partial differential equations.
-------------------------------------------------------------------
>
> The extended description does not have a length limit. Here are the
guidelines for the extended description.
>
> ******************************************************************* The
description should describe the package (the program) to a user (system
administrator) who has never met it before so that they have enough
information to decide whether they want to install it. This description
should not just be copied verbatim from the program's documentation.
>
> Put important information first, both in the synopsis and extended
description. Sometimes only the first part of the synopsis or of the
description will be displayed. You can assume that there will usually be
a
> way to see the whole extended description.
>
> The description should also give information about the significant
dependencies and conflicts between this package and others, so that the
user knows why these dependencies and conflicts have been declared.
>
> Instructions for configuring or using the package should not be included
(that is what installation scripts, manual pages, info files, etc., are
for). Copyright statements and other administrivia should not be
included
> either (that is what the copyright file is for).
> ************************************************************************
>
> I don't think that my attempts are satisfactory, so I'm going to be lazy
and ask the developers for suggestions. Bear in mind this description is
intended for a non-specialist audience.
>
> Thanks.                                                   Faheem.
>
> _______________________________________________
> DOLFIN-dev mailing list
> DOLFIN-dev@xxxxxxxxxx
> http://www.fenics.org/cgi-bin/mailman/listinfo/dolfin-dev
>







References