--- Begin Message ---
Merge authors:
Anders Logg (logg)
------------------------------------------------------------
revno: 53 [merge]
committer: Garth N. Wells <gnw20@xxxxxxxxx>
branch nick: fenics-doc
timestamp: Wed 2010-08-25 17:22:08 +0100
message:
Nightmare merge.
modified:
source/index.rst
source/installation.rst
source/introduction.rst
source/programmers-reference/index.rst
--
lp:fenics-doc
https://code.launchpad.net/~fenics-core/fenics-doc/main
You are subscribed to branch lp:fenics-doc.
To unsubscribe from this branch go to https://code.launchpad.net/~fenics-core/fenics-doc/main/+edit-subscription
=== modified file 'source/index.rst'
--- source/index.rst 2010-08-25 16:16:27 +0000
+++ source/index.rst 2010-08-25 16:22:08 +0000
@@ -3,9 +3,9 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-###################################
-Welcome to the FEniCS documentation
-###################################
+####################
+FEniCS Documentation
+####################
.. toctree::
:hidden:
@@ -47,9 +47,9 @@
</p>
</td><td width="50%">
<p class="biglink">
- <a class="biglink" href="programmers-reference/index.html">Programmer's reference</a>
+ <a class="biglink" href="programmers-reference/index.html">Programmer's Reference</a>
<br/><span class="linkdescr">Interface documentation, available for
- <a href="programmers-reference/cpp/index.html"> C++ </a> or
+ <a href="programmers-reference/cpp/index.html"> C++ </a> and
<a href="programmers-reference/python/index.html"> Python </a>
</span>
</p>
=== modified file 'source/installation.rst'
--- source/installation.rst 2010-08-25 16:16:27 +0000
+++ source/installation.rst 2010-08-25 16:22:08 +0000
@@ -6,29 +6,10 @@
Installation
############
-Obtaining and installing FEniCS software has never been easier.
-Packages are available for Debian and Ubuntu users and Dorsal provides a
-framework for custom builds of FEniCS software and dependencies.
-If for some reason you were unable to obtain, build or install a FEniCS
-component, the best place to start is the
-`Launchpad Answers <https://help.launchpad.net/Answers>`_ page for the project
-which cause the problem:
-
-* `DOLFIN <https://answers.launchpad.net/dolfin>`_
-* `Dorsal <https://answers.launchpad.net/dorsal>`__
-* `FFC <https://answers.launchpad.net/ffc>`_
-* `UFC <https://answers.launchpad.net/ufc>`_
-* `UFL <https://answers.launchpad.net/ufl>`_
-
-(Visit the `FEniCS Project <https://launchpad.net/fenics-project>`_ page for a
-complete list of FEniCS components)
-
-If everything else fails you can always try the fenics@xxxxxxxxxxxxxxxxxxx
-mailing list.
-If you have suggestions for improving the information found on this page with
-respect to the installation procedure of FEniCS, you are more than welcome to
-file a bug report or register a blueprint on
-`FEniCS Documentation <https://launchpad.net/fenics-doc>`_.
+Obtaining and installing FEniCS has never been easier. Packages are
+available for Debian and Ubuntu users and we provide a framework
+(`Dorsal <http://www.fenics.org/dorsal/>`_) for simple builds of
+FEniCS on a multitude of platforms.
**********************
Debian/Ubuntu packages
@@ -37,24 +18,29 @@
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::
+FEniCS is included as part of Debian GNU/Linux
+(unstable/sid). To install, simply click `here <apt://fenics>`_
+(requires ``aptlinex``). FEniCS can also be installed by running the
+following command::
- aptitude install fenics
+ sudo apt-get install fenics
Ubuntu
======
-FEniCS is available in the official Ubuntu repositories as of Ubuntu
-10.04 (Lucid). Simply click `here <apt://fenics>`_ to install
+FEniCS is included as part of Ubuntu GNU/Linux (starting with
+10.04/Lucid). To install, simply click `here <apt://fenics>`_
(requires ``apturl``) or install from the Ubuntu Software
Center. FEniCS can also be installed by running the following
command::
sudo apt-get install fenics
+<<<<<<< TREE
FEniCS PPA
+=======
+Ubuntu PPA
+>>>>>>> MERGE-SOURCE
----------
The official Ubuntu repositories may not always contain the latest
@@ -62,14 +48,14 @@
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.
+Software Sources > Third-Party Software** and clicking 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 Ubuntu Software Center.
Here is a list of commands for installing FEniCS from the FEniCS PPA
-for those preferring the command line:
+for those preferring the command-line:
.. code-block:: sh
@@ -81,6 +67,7 @@
The ``add-apt-repository`` command is not available on older (pre
9.10) Ubuntu systems. Please see the `FEniCS PPA page
+<<<<<<< TREE
<https://launchpad.net/~fenics/+archive/ppa>`_ for instructions on
these systems.
@@ -88,28 +75,30 @@
Automated installation using Dorsal
***********************************
-The easiest way to install FEniCS on a UNIX-like operating environment
-is to use `Dorsal <https://launchpad.net/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 officially the following platforms:
+If you are not running a Debian or Ubuntu operating system, you need
+to download and compile FEniCS and all its dependencies. Luckily, this
+can be handled easily using `Dorsal <http://www.fenics.org/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 on Unix-like operating systems.
+
+The following platforms are officially supported by Dorsal:
* Debian GNU/Linux testing, unstable
* Fedora 13
* Gentoo (and Sabayon) Linux
-* Mac OS X 10.5, 10.6
+* Mac OS X (Snow Leopard)
* openSUSE 11.3
* Red Hat Enterprise Linux 6
* Ubuntu 9.10, 10.04 LTS, 10.10
+* Ubuntu (10.04/Lucid and 10.10/Maverick)
A number of other platforms are supported through user contributions.
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.
+know if 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:
+In order to install FEniCS using Dorsal, simply follow these steps:
#. Fetch the most recent version of Dorsal from its
`download page <https://launchpad.net/dorsal/+download>`_.
@@ -117,85 +106,113 @@
#. 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. It will take some time to build all the
-libraries, so be patient.
-
-Don't forget to follow any post-build instructions before rushing off to try
-the demos!
-
+ ./dorsal.sh
+
+#. At this point, Dorsal attempts to guess your operating system
+ (platform) and provides a list of instructions to ensure that your
+ system is ready for installing FEniCS. Go through these
+ instructions carefully, and copy and paste appropriate commands
+ into a separate terminal window to prepare your system.
+#. Once you have completed these steps, hit enter to begin the
+ installation!
+
+Once the build starts, you should see a lot of compilation-related
+text scrolling past your screen and eventually end up with a complete,
+up-to-date installation of FEniCS. It will take some time to build all
+the libraries, so be patient.
+
+Don't forget to follow any post-build instructions before rushing off
+to try the demos!
*******************************
Manual installation from source
*******************************
You can also build and install FEniCS components manually from the source code.
-Tarballs of all packages can be downloaded from Launchpad:
-
-* `download DOLFIN <https://launchpad.net/dolfin/+download>`_
-* `download FIAT <https://launchpad.net/fiat/+download>`_
-* `download FFC <https://launchpad.net/ffc/+download>`_
-* `download UFC <https://launchpad.net/ufc/+download>`_
-* `download UFL <https://launchpad.net/ufl/+download>`_
-* `download Instant <https://launchpad.net/instant/+download>`_
-* `download Viper <https://launchpad.net/fenics-viper/+download>`_
+If you wish to install FEniCS manually you can easily do
+so. You will need to install the Python packages
+`FFC <http://www.fenics.org/ffc>`_,
+`FIAT <http://www.fenics.org/fiat>`_,
+`Viper <http://www.fenics.org/viper>`_, and
+`UFL <http://www.fenics.org/ufl>`_.
+You will also need to install the C++/Python packages
+`UFC <http://www.fenics.org/ufc>`_ and
+`DOLFIN <http://www.fenics.org/dolfin>`_.
+Instructions for how to install these packages are given below.
Python packages (FFC, FIAT, Viper and UFL)
==========================================
-After extracting a Python-base component, enter the directory and
-for a system wide installation do::
-
- $ python setup.py install --prefix=<destination>
-
-where <destination> is the desired installation directory. If you have
-root privileges, you can perform a system-wide installation::
-
- $ python setup.py install
-
-UFC
-===
-
-UFC uses CMake for installation. For a simple installation, extract
-the UFC tarball and in the UFC directory do::
-
- $ cmake -DCMAKE_INSTALL_PREFIX=$INSTALLDIR
-
-DOLFIN
-======
-
-For a system wide installation of the development version of DOLFIN do::
-
- $ bzr branch lp:dolfin
- $ cd dolfin
- $ scons configure <options>
-
-Run the command::
-
- $ scons configure --help
-
-to see available ``<options>``.
-Then build and install DOLFIN by running the commands::
-
- $ scons
- $ scons install
-
-You can also install DOLFIN in the local DOLFIN tree simply by running the
-script::
-
- $ ./scons.local
-
-Visit `download DOLFIN <https://launchpad.net/dolfin/+download>`_ to get
-previous stable releases; unpack and install following the above procedure.
-
+#. First, `download the source code <http://www.fenics.org/download>`_
+ for FFC, FIAT, Viper, and UFL. Then for each of these packages,
+ follow the instructions below.
+#. Uncompress the archive to a convenient location.
+#. Navigate to this folder and run the following command::
+
+ sudo python setup.py install
+
+This will install the packages system wide on your computer. You may
+easily change the installation directory. For example, you may wish to
+install the packages in a directory named ``local`` in you home
+directory. This may be accomplished by running the following command::
+
+ sudo python setup.py install --prefix=~/local
+
+Installation of C++/Python packages (UFC and DOLFIN)
+====================================================
+
+#. First, `download the source code <http://www.fenics.org/download";>`_
+ for UFC and DOLFIN. Then for each of these packages, follow the
+ instructions below.
+#. Uncompress the archive to a convenient location.
+#. Navigate to this folder and run the following commands::
+
+ cmake .
+ make
+ sudo make install
+
+This will install the packages system wide on your computer. You may
+easily change the installation directory. For example, you may wish to
+install the packages in a directory named ``local`` in you home
+directory. This may be accomplished by replacing the first of the
+above commands by the following command::
+
+ cmake . -DCMAKE_INSTALL_PREFIX=~/local
+
+You may also want to consider using a graphical frontend for Cmake
+like either ``cmake-gui`` or ``ccmake`` which both provide a simple
+way to configure the installation.
+
+During the configuration phase of DOLFIN (calling ``cmake``,
+``cmake-gui``, or ``ccmake``), you will be notified of any missing
+dependencies. If a required package is missing, you will need to
+install that package and configure DOLFIN again. If an optional
+package is missing, you may choose to continue with the installation
+but some functionality may be missing.
+
+***************
+Troubleshooting
+***************
+
+If for some reason you were unable to obtain, build, or install a
+FEniCS component, the best place to start is the `Launchpad Answers
+<https://help.launchpad.net/Answers>`_ page for the project which
+causes the problem:
+
+* `DOLFIN <https://answers.launchpad.net/dolfin>`_
+* `Dorsal <https://answers.launchpad.net/dorsal>`_
+
+* `FFC <https://answers.launchpad.net/ffc>`_
+* `FIAT <https://answers.launchpad.net/fiat>`_
+* `Viper <https://answers.launchpad.net/viper>`_
+* `UFC <https://answers.launchpad.net/ufc>`_
+* `UFL <https://answers.launchpad.net/ufl>`_
+
+If all else fails, you can always try the fenics@xxxxxxxxxxxxxxxxxxx
+mailing list.
+
+If you have suggestions for improving the information found on this
+page with respect to the installation procedure of FEniCS, you are
+more than welcome to file a bug report or register a blueprint on
+`FEniCS Documentation <https://launchpad.net/fenics-doc>`_.
+>>>>>>> MERGE-SOURCE
=== modified file 'source/introduction.rst'
--- source/introduction.rst 2010-08-25 12:22:07 +0000
+++ source/introduction.rst 2010-08-25 12:56:08 +0000
@@ -8,39 +8,32 @@
############
This is the documentation for the
-`FEniCS project <http://fenics.org/wiki/FEniCS_Project>`_.
-The FEniCS project consists of many
-`software components <http://fenics.org/wiki/Projects>`_, however, the
-focus of this documentation is on `DOLFIN <http://fenics.org/wiki/DOLFIN>`_
-which is the main interface to FEniCS.
+`FEniCS Project <http://fenics.org/wiki/FEniCS_Project>`_.
+
+Although the FEniCS Project consists of many `software components
+<http://fenics.org/wiki/Projects>`_, the main focus of this
+documentation is on the FEniCS user interface.
+
The documentation comprises three main parts:
-* :ref:`tutorial_index`, which focuses on getting users started solving
- partial differential equations (PDEs) right away.
- The tutorial is self-contained and shows how to use FEniCS tools to setup
- and solve problems.
- Although the tutorial starts with a simple problem, the complexity is soon
- increased to demonstrate how intuitive FEniCS software can be put to work.
- This is the ideal place to start for newcomers to FEniCS and people who are
- simply curious to learn what exactly FEniCS is all about.
-
-* :ref:`demos_index`, which is a collection of *ready to run code examples*
- that demonstrate a subset of FEniCS features.
- This typically involves solving a particular PDE but can just as well be
- demonstrating functionality pertaining to mesh manipulation, linear algebra
- etc.
- Another purpose of the demos is to serve as code templates for FEniCS users
- such that solvers does not have to be written from scratch since it is
- usually possible to find a demo which bears resemblance to the problem at
- hand and modify it accordingly.
-
-* :ref:`programmers_reference_index`, which contains detailed documentation
- of the functions and classes in DOLFIN.
-
-
-All three parts come in a ``C++`` and a ``Python`` version and they can be
-accessed online as ``HTML`` or downloaded as ``PDF`` files.
-
-Any suggestions for improving FEniCS software or the documentation is more
-than welcome, please see :ref:`contributing` on how to do this.
-
+* :ref:`tutorial_index`, which focuses on getting users started
+ solving partial differential equations (PDEs) in FEniCS. The
+ tutorial is self-contained and shows how to use FEniCS tools to
+ setup and solve problems. This is the ideal place to start for
+ newcomers to FEniCS and people who are simply curious to learn what
+ exactly FEniCS is all about.
+
+* :ref:`demos_index`, which is a collection of *ready to run code
+ examples* which demonstrate many of the features of FEniCS. The
+ demos can also serve as code templates for users that wish to
+ implement their own solvers in FEniCS.
+
+* :ref:`programmers_reference_index`, which contains detailed
+ documentation of the FEniCS user interface.
+
+All three parts of the documentation are available in both C++ and a
+Python versions and they can be accessed online as HTML or downloaded
+as PDF files.
+
+Suggestions for improving FEniCS software and documentation is
+welcome. Please see :ref:`contributing` for how to do this.
=== modified file 'source/programmers-reference/index.rst'
--- source/programmers-reference/index.rst 2010-08-25 12:31:03 +0000
+++ source/programmers-reference/index.rst 2010-08-25 16:14:51 +0000
@@ -3,7 +3,7 @@
.. _programmers_reference_index:
#############################
-FEniCS Programmer's reference
+FEniCS Programmer's Reference
#############################
From the Launchpad `blueprint
--- End Message ---
