← Back to team overview

fenics team mailing list archive

Re: FEniCS Demo documentation

 

On 6/16/10 10:09 PM, Anders Logg 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).

Attached is an initial version of the installation-with-Dorsal page.
More refinements to come.

Harish
# Bazaar merge directive format 2 (Bazaar 0.90)
# revision_id: hnarayanan@xxxxxxxxx-20100617111811-jedkgimv02qrp29z
# target_branch: bzr+ssh://bazaar.launchpad.net/~fenics-core/fenics-\
#   doc/main/
# testament_sha1: 43d59f44e12ab7935b3467cffc0786f6294f1c6f
# timestamp: 2010-06-17 13:19:15 +0200
# base_revision_id: k.b.oelgaard@xxxxxxxxx-20100616161354-\
#   3axpfdj6si3naqpt
# 
# Begin patch
=== modified file 'source/installation.rst'
--- source/installation.rst	2010-06-03 15:01:39 +0000
+++ source/installation.rst	2010-06-17 11:18:11 +0000
@@ -19,8 +19,43 @@
 Installation using Dorsal
 *************************
 
-Explain how to use the Dorsal script, and how it can be used to install
-individual packages.
+The easiest way to install FEniCS on a UNIX-like operating environment
+is to use Dorsal. Dorsal is a simple shell script that automates the
+process of fetching, compiling and installing the various FEniCS
+sub-projects and their requisite dependencies. It currently supports
+the following platforms:
+
+* Debian GNU/Linux 4.0, 5.0, unstable
+* Fedora 10, 11, 12          
+* Mac OS X 10.4, 10.5, 10.6
+* openSUSE 11.1, 11.2      
+* Red Hat Enterprise Linux 4, 5 
+* Ubuntu 8.10, 9.04, 9.10, 10.04 LTS
+* Gentoo (and Sabayon) Linux
+
+It is easy to extend support to other similar platforms. Please let us
+know if that you are interested, and we can work together toward
+adding this functionality.
+
+In order to install the FEniCS project on one of the supported
+platforms listed above, follow the following steps:
+
+#. Fetch the most recent version of Dorsal from its `download page <https://launchpad.net/dorsal/+download>`_.
+#. Uncompress the archive to a convenient location.
+#. Navigate to this folder and tweak dorsal.cfg to your liking.
+#. Invoke the build script by running:
+      ./dorsal.sh
+#. At this point, Dorsal attempts to guess your operating environment (platform) and provides a list of instructions to ensure your system is ready for installing FEniCS. Go through these carefully, and copy and paste appropriate commands into another terminal window to prepare your system.
+#. Once you've completed these steps, hit enter to begin the installation!
+
+
+If all goes according to plan, you should see a lot of
+compilation-related text scroll past your screen and eventually end up
+with a complete, up-to-date installation of various FEniCS projects
+and their corresponding dependencies.
+
+Don't forget to follow any post-build instructions before rushing off to try the demos!
+
 
 ***
 FFC

# Begin bundle
IyBCYXphYXIgcmV2aXNpb24gYnVuZGxlIHY0CiMKQlpoOTFBWSZTWVp60BAAAjlfgBEQeP//93/n
3kD////wYAcMwx80jzpe21vbWDCh2t7sGhCaNBTyaPVNpqemhT1P1PUm1PKbBEPU0GgzU0DRNAZJ
kI0apo0NDIaAAyAAA00GpkyCj0p5TJ6ZIaephNGgaAAABoAJERAI0yhoNTKbU2UM0IMR6EaNNAxA
5pkZDJghowmCNNGjEDTJkYAAgkkJ6QJpqm8mo8iZQAGTRoAAAAFEsZB0QH/a8qz8rP8LMbvGGMA+
W6iih3UM2O1wGfl5qA8TAxwONpPp6wohQuidiEGRgVcreDyrIiGj1Co7z2/EmcpBai2Y4xFVcNX7
MTV2ZkwNT2ua2hDSDomewQz4YLkW+Qa++5OKrT6yKdDxylfpvHoivSw026TjBDKWxx3WD8D/p0ss
YiaYykjIJzo6sjlKyhAqirwiTm3QHytGDn8Wbzgbnux2vTdCiWdZcHPerZPqIvrKgkyRWLn7IWSs
HTgSUE8WY5zyvpKrBDxRnUwZoOciRaKyftlRdpmqSpRcxtSZUMEMK1BitGZmWztt4khkPaCdVcTl
WMIuDtF6ShSA5q35MOFqSqRolBCIlhWJIFRgtnZl59ZNn7XJOub03WnccJgz2U9L8FJ5FKMj0gRg
FVhAnJQ7rPTVXB02aLaYgXQqmZoMAdkSbH/C6XMVSONARzGWMlQHRY048+y4dl6rXQaTjQzBShU1
mmZp0zvEx4BXmxaxTpdqzvrmWhYxjoVR8AZceHJMqAtQYLPdSgLyGGkNzhoVZS8Ls0J9kkxm2JVT
lgK6UguOTlWQuMoUIXxC1sc7OJWlFuKsxrg6hhkZVIzmoHIylrpdironMiHGKGz2OVbHQDYTzuKg
cAFxhcUwdgM1UsLusCMgOAZDNlz3wyqXUYIX+Ll0oLRBHlvs7S+dbE+4Zj1Q03GRT0Wj1na9A2qD
SMUkNMbbjsC5BynRMHCGFzRFOMUcclYTtdCoWWvzaDt7d/byQzr7I7mFUurC3Bpnq6UUlo7q+9Ep
Fr/uwgbWT7vhAvn8PiwrnX/L8J2tefq2d5gW9ih9odZgrwwDMNBe/dcBPHFzhTb8Tcl78AZgoDHx
JFaLr5IQ4rk0HspDp6PPKXpAx/i9G1rY1Yvtu6pSp7qhGmTR3ny4iR4z0kaeXwZ0YPUgMWsm595T
wADfwx8QJdoMW2b+FzONdAqJBtvLvZrPOBA6N4VKcQ8ZVeMVVKzlTtOsN7WRRWMFq5QbHEMBZQHy
WYGFxgo2MfVlBA5Y2nOF8WK/itVicqtQ5ObYU+LqmiBiaJjtIgax5TgpTdvDdf8SPHLNdc9DkyKG
lar1obSBlcU5dqOVUe9tTwiNeeIIcsIz5p6w44vAlKhKg4c2cii9To6kJYL5YvdIYzwHC7UZ1UDF
O8+7eghsAbIMBs8Uk75OfhPA+jXIo/ZYoTkjAwIjImIek5D5WXE0a5FqpKrW7t1DR355aYRJcTha
EKdR52VjVNz6GfuktwxE0apGOGHnqZc9AWU6TDkJEUiwCjMngR9YJ81UgWHzSMTqNunQ/+dAol7m
LVktDpCtjzH7Ds3211uW8kDCmxEFU1mFDZ5FpRUgbFPpDasgMiGiysWEjg4aCsae4OfY9pdUdpyU
iM+pYLbtaAcGPX71u3367xhmQyZbTqpjeaFh1E1NBIM8R69mFWTu8Mlgtwtu67AIcHeYt4S4q6xm
ZMEUhjALQlzKIb3hAJKLLdA2aurF2P9ZskVhfGybQHCp4XMBELINkOTCtjRvGq6smEQbrJGciLW2
HJrUncp1UzJE2VFqlKpSjR46UlNgNKkS7aAeNcEvfOtx64kUtN3hBfEwd8gH7o5bDSnhLS/bh9dC
lgK5DaeEQwbUuFRqDd9lzrzIX3MOdfTvNQ59yXBO2Krsxhg+xIq0rNwN+r9YEX0/C4oW3TVMm/ZU
K0ocbJQsB01YTXAhfnW2GtauWCO3edmiqlrtUCBoXOLZk+jrhplTOg18lJTy9sErl0U68YRtDpi3
HPCh153zmcWw8ixx19q2piuLa5lSYoxpURywVAozamFRuYyOiKs0azrMXbtKmFK91xgTFUVanVqv
gzLqGj4hX7sEEHhUEMxNhEMdWx0wccJXRvqaHGrkRISvM01EUIoPpAEwDprZ3SSmhTvFqLAtxkYE
aylD2rDw6kUYQrpUcUiUqIby0uBzOKjGcSAbLuSP8a26aish3T0FB0iBkwmtN4TCTGBQSzEGxDoW
VrFWcdkF8vN27JWMhjKWjSqYwKs1y0KCM0sjMEWp70sAZJZyBI0V2KRJYcKCWT1sRtvUccOEb4cC
5ntdioHE18YjUNO5cBRNNc97hxuSpkSByiho4OZkTvVqtRbv5+TOmtJ1umcHClBiBU70Tuh5f+Lu
SKcKEgtPWgIA

References