diff --git a/doc/sphinx/compiling.rst b/doc/sphinx/compiling.rst index f6d4d5c87..8b0bf1100 100644 --- a/doc/sphinx/compiling.rst +++ b/doc/sphinx/compiling.rst @@ -1,3 +1,5 @@ +.. _sec-compiling: + ************************* Cantera Compilation Guide ************************* diff --git a/doc/sphinx/faq.rst b/doc/sphinx/faq.rst new file mode 100644 index 000000000..8395096e8 --- /dev/null +++ b/doc/sphinx/faq.rst @@ -0,0 +1,79 @@ +************************** +Frequently Asked Questions +************************** + +Installation +------------ + +**How do I install Cantera on Windows?** + + Download the MSI installer for Cantera and the corresponding Python module + from `Google Code `_. + Choose between x86 and x64 based on the versions of Python and/or Matlab + you want to work with. + +**How do I install Cantera on Linux?** + + Download the source code from `Google Code + `_ and follow the + instructions in the :ref:`sec-compiling`. + +General +------- + +**Which Cantera interface should I use?** + + If you're new to Cantera, the best interface to get started with is + probably the "new" Python interface. It offers most of the features of the + C++ core in a much more flexible environment. Since all of the + calculations are still done in C++, there is very little performance + penalty to using the high-level language interfaces. + +**Where can I find examples of how to use Cantera?** + + Cantera is distributed with many examples for the Python and Matlab + interfaces, and a smaller number of examples for the C++ and Fortran + interfaces. The Matlab, C++, and legacy Python examples should be + installed in the ``samples`` subdirectory of the Cantera installation + directory, or they can be found in the ``samples`` subdirectory of the + Cantera source directory. + + Examples for the new Python interface can be found in the ``examples`` + subdirectory of the Cantera Python module installation directory, or in + the ``interfaces/cython/cantera/examples`` subdirectory of the Cantera + source directory. + +Support and Bug Reporting +------------------------- + +**What should I do if I think I've found a bug in Cantera?** + + - Check to see if you're using the most recent version of Cantera, and + upgrade if not. + - Check the `Issue Tracker + `_ to see if the issue + has already been reported. + - Try to generate a complete, minimal example that demonstrates the + observed bug. + - Create a new issue on the tracker. Include as much information as + possible about your system configuration (operating system, compiler + versions, Python versions, installation method, etc.) + +**What information should I include in my bug report?** + + - The version of Cantera are you using, and how you installed it + - The operating system are you using + - If you compiled Cantera, what compiler you used, and what compilation + options you specified + - The version of Python or Matlab are you using, if applicable + - The necessary *input* to generate the reported behavior + - The full text of any error message you receive + +**What should I do if I need help using Cantera?** + + You can join the `Cantera Users' Group + `_ on Google + Groups and ask a question there. Please use the search feature before + posting to see if your question has been answered before. This group is + moderated, so it may take some time for your posts to appear if you are a + new member. diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index 1d8defdb2..d17e6a9c2 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -23,6 +23,7 @@ Documentation .. toctree:: :maxdepth: 2 + faq Compiliation Instructions language-interfaces cti/index