← Back to team overview

fenics team mailing list archive

Re: FEniCS Demo documentation

 

On Wed, Jun 16, 2010 at 10:09 PM, Anders Logg <logg@xxxxxxxxx> wrote:
> Looks good. I noticed a couple of things:
>
> 1. It would be good if class names were in another font (like courier
> style), \texttt{VariationalProblem} etc
>
> 2. Would it be better with another variable name instead of h since
> that will be used as mesh size in other demos. Why not g?
>
> 3. Is the normal flux + or - grad(u).n? I think of it as -grad(u).n.
>
> 4. Typo in "The implemented in a single Python file"
>
> 5. g is used in (f, g) instead of h (but maybe h should be changed to g)
>
> The documentation seems to be coming along pretty well. It may be time
> for you to ask people to contribute specific parts. For example,
> Johannes and Harish could contribute with some documentation of how to
> get Debian/Ubuntu packages and building with Dorsal. Others can
> contribute with writing specific pages for the programmer's
> reference, and Hans Petter can contribute with preparing his tutorial
> in reST (and split it in Python and C++ versions).

Here is a patch (attached) for installation instructions on Debian and Ubuntu.

BTW, it seems like sections '=', subsections '-', and subsubsetions
'^' looks the same. Why is that?

Johannes

PS: I updated Sphinx to 0.6.7 on fenics.org.

> --
> Anders
>
>
> On Wed, Jun 16, 2010 at 06:31:42PM +0200, Kristian Oelgaard wrote:
>> Hello,
>>
>> I've finished a first iteration on documenting the Poisson demo (from
>> dolfin/demo/pde/poisson).
>>
>> Check it out and let me know what you think.
>>
>> The Python version is here:
>>
>>  http://www.fenics.org/newdoc/demos/python/pde/poisson/poisson.html
>>
>> and the C++ version is here:
>>
>> http://www.fenics.org/newdoc/demos/cpp/pde/poisson/poisson.html
>>
>> Note that I need to finish the Programmer's reference part of the
>> documentation before I can insert links to the relevant classes used
>> in the demos.
>>
>> http://www.fenics.org/newdoc/programmers-reference/index.html
>>
>> Kristian
>>
>> _______________________________________________
>> 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.10 (GNU/Linux)
>
> iEYEARECAAYFAkwZL2IACgkQTuwUCDsYZdHZ5QCfa7fC+zyjjYtWG2HncJVdtl/4
> UskAn0LZx1DNof5lIRs9/+TzPhNbaErU
> =esYb
> -----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
>
>
# Bazaar merge directive format 2 (Bazaar 0.90)
# revision_id: johannr@xxxxxxxxx-20100623131443-1lkoculoe7p716va
# target_branch: bzr+ssh://bazaar.launchpad.net/~fenics-core/fenics-\
#   doc/main/
# testament_sha1: 8395c67a8ae31034e90fa90c7acd6d4b3e3c3720
# timestamp: 2010-06-23 15:16:14 +0200
# base_revision_id: k.b.oelgaard@xxxxxxxxx-20100618161210-\
#   e6gs3qlkbn811owa
# 
# Begin patch
=== modified file 'source/installation.rst'
--- source/installation.rst	2010-06-18 11:23:21 +0000
+++ source/installation.rst	2010-06-23 13:14:43 +0000
@@ -13,7 +13,55 @@
 Installation for Debian/Ubuntu users
 ************************************
 
-Explain how to install the packages.
+Debian
+======
+
+The latest stable FEniCS releases are available in Debian sid. To
+install, simply click `here <apt://fenics>`_ (requires ``aptlinex``) or
+run the following command as root::
+
+    aptitude install fenics
+
+Ubuntu
+======
+
+FEniCS is available in the official Ubuntu repositores as of Ubuntu
+10.04 (Lucid). Simply click `here <apt://fenics>`_ to install
+(requires ``apturl``) or install from the Ubuntu Software
+Center. FEniCS can also be installed by running the following
+command::
+
+    sudo apt-get install fenics
+
+The FEniCS PPA
+--------------
+
+The official Ubuntu repositories may not always contain the latest
+stable FEniCS releases. To stay current with the latest releases, add
+the `FEniCS Personal Package Archive
+<https://launchpad.net/~fenics/+archive/ppa>`_ (PPA) to your Ubuntu
+system. You can do this by going to **System > Administration >
+Software Sources > Third-Party Software** and click on **Add**. Then
+type in ``ppa:fenics/ppa`` and click on **Add Source** and then
+**Close**. A dialog box should appear, asking whether you'd like to
+update the list of repositories. Select **Reload** to update the
+list. You can then install FEniCS from the Software Center.
+
+Here is a list of commands for installing FEniCS from the FEniCS PPA
+for those preferring the command line:
+
+.. code-block:: sh
+
+    sudo add-apt-repository ppa:fenics/ppa
+    sudo apt-get update
+    sudo apt-get install fenics
+
+.. note::
+
+    The ``add-apt-repository`` command is not available on older (pre
+    9.10) Ubuntu systems. Please see the `FEniCS PPA page
+    <https://launchpad.net/~fenics/+archive/ppa>`_ for instructions on
+    these systems.
 
 *************************
 Installation using Dorsal

# Begin bundle
IyBCYXphYXIgcmV2aXNpb24gYnVuZGxlIHY0CiMKQlpoOTFBWSZTWQcmC5IAAjxfgFAQUP//939U
XiD////xYAZnfc5mhLlOiNrQHa1DhkQmmk0p7EzVPU9Tap4Eyajyninqeo0HqaZABkSYptMI0TKY
mmo/UmjQ0AANAADmjJiYAJiMCNMCDEYJkwCMEppBNJP1NJsp6k/U0hptTGmiAD1GCAAOaMmJgAmI
wI0wIMRgmTAIwSRAmiYTFNMmmpPKbCR7U1GhoAZqGjRhAuE/aOiD8PoVYLVe5OuTkHX9BAojev2T
U0el70V2a7NJplFCAD6IBon0sTVW6DnefpR9aYZSQZSBV41zK8TS6O7UkiXgTjajjdPHCt5jb9uT
k4pl83I2eSB82dRojKX+8Hjcx8NkbTspMirS/0H8+qO9vh5lslQelYWS0hPTQ0DBN0YVtfrSpcWj
oq+Ycsnmlt4Zk1VsRdlilB1LHlBapANEGSDMxG+EGygmQq4XPf1/yel2LroBd5TmGweJixSWpslt
1mF7lezXtbp0ZF3FUIx7CNkr849ddJxhUSUSoGk8hfVo3l7dwM2MdwEQXDCXWMpLzcndMVGbE+lX
OMNkMKdxkX822d4ah1XHWl6BosDuDq6icujfEo42ZyyqLgJvY6F2CTaE9X3WL6mES0lVWA457Yav
XbIjl1079FPC0g7uHAYT8eMewVLntO043TkzcGHMFhyUj3kFEX93dPBNeqNkLTdkHr2GB0argKK7
8C4ihbZKEVjcKMGvUnzvugEOfauiopLPeb9fsKCmJtnLO+cztWUc98kQTIfETilquMXykahIs4FJ
dknVE/EInK6QX0kytEbL6RnWxG4JShYXKaiLW80z4g047ZYYyjdGVDcHA84fWrWdJQvsQZhzHWNt
uy8C+ieiCO/AZWQ2Io0OKd4cBY6Yc2/V0cH1SYyySLUA5mCbpqNEqFKNvPWbmfyMttzbeDEgocvC
qz6GbvsDtTfQmjbqUC6qZHbrGIwknJdww56hNFCpuzBFnXOi1dowgsTQfJEGEgLQ3uHJww6IEgmf
EN3lz8JBNMN8jyg5FJrQ8+8t8SxEf+/AMS1S4djl5dh/TrWnp9hT05cwe8LG3+PmZ2GWghCHrSSs
lYhCRqAcNZ3nLwHjx7xwxaiwYygTBVNramfQ40WvbDn8AJYcU0BOPMXidppIiLy3dIf0AGD2Aax0
wvcYjd0Pr1uzjkUaE0nmxiCaqtUxjTQoNHEzalNCg/gilY50QgPXn3yU2c6ijI+VjX4EijUDzNSv
YyHwwzXywoUsCHFWuavXy7YdKIpy4ToEnQs64b5OBbEwtS+Ta5IPnHjZ2al3U2HdWDGnf4V6g1aJ
gI2sAox0eRaLI7O/M9HXY24vBF5KHHr2AfmwCsxBEh6DKVBFjpAtysHnZDhdXXgEialREhfgKXl4
a8BXF1RiL9ozkVkeC5/MY/Y69pQoe/21yZDsVZTB4p2R3Bilsb8BZpbxcGXUoBvAR/aYSYSFnd0b
heiD2NsekDMzUTo0ESOP0+afpOkJpE7t3omoXWlm9K1RLPYxNpcnAB4or2sWei1+eAME8sqKB1ty
SVClChQf49/MVHbmGi26VRlbYoTyMhsMeKHBlJd3WFlYgb0yJB6gkEPcoBw1SmtVMMCPD6CbJjyq
FGDEKmkXOGPBYidKDC2F9t7ij52jtF+Z4qliTcw6karGzfqeudRSkSKjJReLOQZiChAfGI8EXplW
EhkpAw0eXuICPiI8LREo0sZKiVVJKpNJUTsh2VAHXh7OBkHJ4QcqLvbpi0BdfRAWIYremPEI/L5p
dUsiqtEQW0Zktv3ORkpTZltSZXuh0yYRUZon+H3claJqbRx5fMGINIBO4iHnLhF02DIsvI1w4Kc0
2908Q4EW8TzOAYkSZDIjFQjtJYBXCQ/F4w6ioFUgEKItDNhClovDxG/wuEOxohJTPoL3YfnSp3pq
5Wmy3lJHaqBkwxx3eMY3RaHSqdZAcO5ZhRTVsrVWmlhXcwZsPrJvAeRY+Bw13+eQtCBhW7TahShu
DEJyPiEKTM9MdpcRBqutU7DwHIyl6Ex2SUFGMAiZyVTbg6NjILsHJ3ZYkEYmJNGAXLBmGwIQYq6j
3DgPT1BLGwLxkzZa/OZHYHuOKVluQqbRusDMwtsC6z7RVW1ZrcFFQM79kRLCYTmW2XO7ogyoSltu
Z6luw/4u5IpwoSAOTBck

Follow ups

References