Permalink
Browse files

Documentation and project foundation updates

  • Loading branch information...
1 parent 32e3136 commit 5a1dcd5a93587bfb24f70197f53ac200d709b1f6 @timlinux timlinux committed Jan 10, 2012
View
5 AUTHORS.rst
@@ -0,0 +1,5 @@
+Ordered by date of first contribution:
+
+* Ole Nielsen <ole.nielsen@aifdr.org>
+* Tim Sutton <tim@linfiniti.com>
+
View
1 INSTALL.rst
@@ -0,0 +1 @@
+See README.rst for installation instructions.
View
339 LICENSE.txt
@@ -0,0 +1,339 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
View
35 README.rst
@@ -1,6 +1,6 @@
-=============
-RISK IN A BOX
-=============
+===================
+About Risk-in-a-box
+===================
This is the project: Risk in a Box - QGIS plugin
@@ -9,7 +9,34 @@ which contains modules for risk calculations, gis functionality and plugin
management.
For more information about Risk In a Box please look at
-our documentation on TBA
+our documentation under docs/build/html.
+
+Quick Installation Guide - Users
+================================
+
+.. note:
+
+ This is a plugin for `Quantum GIS <http://qgis.org>` (QGIS). It requires version 1.8 of QGIS
+ (or newer).
+
+To install the plugin, use the plugin manager in QGIS::
+
+ Plugins -> Fetch Python Plugins
+
+Then search for 'Risk In A Box', select it and click the install button. The plugin will
+now be added to your plugins menu.
+
+Quick Installation Guide - Developers
+=====================================
+
+To develop on the plugin, you first need to copy it to your local system. If you are a developer,
+the simplest way to do that is to clone it from our GitHub repository page like this::
+
+ git clone git://github.com/AIFDR/risk_in_a_box.git
+
+Place the local repository under `~/.qgis/python/plugins` and then restart QGIS. If you wish to
+an IDE for development, please refer to `this article <http://linfiniti.com/2011/12/remote-debugging-qgis-python-plugins-with-pydev/>`_
+for detailed information on how you can do so.
Contact:
Ole.Moller.Nielsen@gmail.com
View
102 docs/build/html/README.html
@@ -0,0 +1,102 @@
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>About Risk-in-a-box &mdash; Risk-In-A-Box 0.0.1 documentation</title>
+
+ <link rel="stylesheet" href="_static/haiku.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="_static/print.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '',
+ VERSION: '0.0.1',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="_static/theme_extras.js"></script>
+ <link rel="top" title="Risk-In-A-Box 0.0.1 documentation" href="index.html" />
+ <link rel="next" title="Class: Riab" href="riab.html" />
+ <link rel="prev" title="Welcome to Risk-In-A-Box’s documentation!" href="index.html" />
+ </head>
+ <body>
+ <div class="header"><h1 class="heading"><a href="index.html">
+ <span>Risk-In-A-Box 0.0.1 documentation</span></a></h1>
+ <h2 class="heading"><span>About Risk-in-a-box</span></h2>
+ </div>
+ <div class="topnav">
+
+ <p>
+ «&#160;&#160;<a href="index.html">Welcome to Risk-In-A-Box&#8217;s documentation!</a>
+ &#160;&#160;::&#160;&#160;
+ <a class="uplink" href="index.html">Contents</a>
+ &#160;&#160;::&#160;&#160;
+ <a href="riab.html">Class: Riab</a>&#160;&#160;»
+ </p>
+
+ </div>
+ <div class="content">
+
+
+ <div class="section" id="about-risk-in-a-box">
+<h1>About Risk-in-a-box<a class="headerlink" href="#about-risk-in-a-box" title="Permalink to this headline">¶</a></h1>
+<p>This is the project: Risk in a Box - QGIS plugin</p>
+<p>The latest source code is available in <a class="reference external" href="https://github.com/AIFDR/risk_in_a_box">https://github.com/AIFDR/risk_in_a_box</a>
+which contains modules for risk calculations, gis functionality and plugin
+management.</p>
+<p>For more information about Risk In a Box please look at
+our documentation under docs/build/html.</p>
+<div class="section" id="quick-installation-guide-users">
+<h2>Quick Installation Guide - Users<a class="headerlink" href="#quick-installation-guide-users" title="Permalink to this headline">¶</a></h2>
+<p>To install the plugin, use the plugin manager in QGIS:</p>
+<div class="highlight-python"><pre>Plugins -&gt; Fetch Python Plugins</pre>
+</div>
+<p>Then search for &#8216;Risk In A Box&#8217;, select it and click the install button. The plugin will
+now be added to your plugins menu.</p>
+</div>
+<div class="section" id="quick-installation-guide-developers">
+<h2>Quick Installation Guide - Developers<a class="headerlink" href="#quick-installation-guide-developers" title="Permalink to this headline">¶</a></h2>
+<p>To develop on the plugin, you first need to copy it to your local system. If you are a developer,
+the simplest way to do that is to clone it from our GitHub repository page like this:</p>
+<div class="highlight-python"><pre>git clone git://github.com/AIFDR/risk_in_a_box.git</pre>
+</div>
+<p>Place the local repository under <cite>~/.qgis/python/plugins</cite> and then restart QGIS. If you wish to
+an IDE for development, please refer to <a class="reference external" href="http://linfiniti.com/2011/12/remote-debugging-qgis-python-plugins-with-pydev/">this article</a>
+for detailed information on how you can do so.</p>
+<p>Contact:
+<a class="reference external" href="mailto:Ole&#46;Moller&#46;Nielsen&#37;&#52;&#48;gmail&#46;com">Ole<span>&#46;</span>Moller<span>&#46;</span>Nielsen<span>&#64;</span>gmail<span>&#46;</span>com</a></p>
+</div>
+</div>
+
+
+ </div>
+ <div class="bottomnav">
+
+ <p>
+ «&#160;&#160;<a href="index.html">Welcome to Risk-In-A-Box&#8217;s documentation!</a>
+ &#160;&#160;::&#160;&#160;
+ <a class="uplink" href="index.html">Contents</a>
+ &#160;&#160;::&#160;&#160;
+ <a href="riab.html">Class: Riab</a>&#160;&#160;»
+ </p>
+
+ </div>
+
+ <div class="footer">
+ &copy; Copyright 2012, Ole Moller.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
+ </div>
+ </body>
+</html>
View
43 docs/build/html/_sources/README.txt
@@ -0,0 +1,43 @@
+===================
+About Risk-in-a-box
+===================
+
+This is the project: Risk in a Box - QGIS plugin
+
+The latest source code is available in https://github.com/AIFDR/risk_in_a_box
+which contains modules for risk calculations, gis functionality and plugin
+management.
+
+For more information about Risk In a Box please look at
+our documentation under docs/build/html.
+
+Quick Installation Guide - Users
+================================
+
+.. note:
+
+ This is a plugin for `Quantum GIS <http://qgis.org>` (QGIS). It requires version 1.8 of QGIS
+ (or newer).
+
+To install the plugin, use the plugin manager in QGIS::
+
+ Plugins -> Fetch Python Plugins
+
+Then search for 'Risk In A Box', select it and click the install button. The plugin will
+now be added to your plugins menu.
+
+Quick Installation Guide - Developers
+=====================================
+
+To develop on the plugin, you first need to copy it to your local system. If you are a developer,
+the simplest way to do that is to clone it from our GitHub repository page like this::
+
+ git clone git://github.com/AIFDR/risk_in_a_box.git
+
+Place the local repository under `~/.qgis/python/plugins` and then restart QGIS. If you wish to
+an IDE for development, please refer to `this article <http://linfiniti.com/2011/12/remote-debugging-qgis-python-plugins-with-pydev/>`_
+for detailed information on how you can do so.
+
+Contact:
+Ole.Moller.Nielsen@gmail.com
+
View
1 docs/build/html/_sources/index.txt
@@ -11,6 +11,7 @@ Contents:
.. toctree::
:maxdepth: 2
+ README
riab
riabdialog
riabdialogtest
View
11 docs/build/html/index.html
@@ -28,7 +28,7 @@
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/theme_extras.js"></script>
<link rel="top" title="Risk-In-A-Box 0.0.1 documentation" href="#" />
- <link rel="next" title="Class: Riab" href="riab.html" />
+ <link rel="next" title="About Risk-in-a-box" href="README.html" />
</head>
<body>
<div class="header"><h1 class="heading"><a href="#">
@@ -40,7 +40,7 @@ <h2 class="heading"><span>Welcome to Risk-In-A-Box’s documentation!</span></h2
<p>
<a class="uplink" href="#">Contents</a>
&#160;&#160;::&#160;&#160;
- <a href="riab.html">Class: Riab</a>&#160;&#160;»
+ <a href="README.html">About Risk-in-a-box</a>&#160;&#160;»
</p>
</div>
@@ -52,6 +52,11 @@ <h2 class="heading"><span>Welcome to Risk-In-A-Box’s documentation!</span></h2
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
+<li class="toctree-l1"><a class="reference internal" href="README.html">About Risk-in-a-box</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="README.html#quick-installation-guide-users">Quick Installation Guide - Users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="README.html#quick-installation-guide-developers">Quick Installation Guide - Developers</a></li>
+</ul>
+</li>
<li class="toctree-l1"><a class="reference internal" href="riab.html">Class: Riab</a></li>
<li class="toctree-l1"><a class="reference internal" href="riabdialog.html">Class RiabDialog</a></li>
<li class="toctree-l1"><a class="reference internal" href="riabdialogtest.html">Class: RiabDialogTest</a></li>
@@ -74,7 +79,7 @@ <h2 class="heading"><span>Welcome to Risk-In-A-Box’s documentation!</span></h2
<p>
<a class="uplink" href="#">Contents</a>
&#160;&#160;::&#160;&#160;
- <a href="riab.html">Class: Riab</a>&#160;&#160;»
+ <a href="README.html">About Risk-in-a-box</a>&#160;&#160;»
</p>
</div>
View
2 docs/build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({objects:{"":{riabdialogtest:[0,0,1,""],riab:[2,0,1,""],riabdialog:[3,0,1,""]},"riabdialogtest.RiabDialogTest":{clearForm:[0,1,1,""],setUp:[0,1,1,""],test_defaults:[0,1,1,""]},riabdialogtest:{RiabDialogTest:[0,2,1,""]},"riab.Riab":{initGui:[2,1,1,""],run:[2,1,1,""],unload:[2,1,1,""]},riab:{Riab:[2,2,1,""]},"riabdialog.RiabDialog":{getLayers:[3,1,1,""]},riabdialog:{RiabDialog:[3,2,1,""]}},terms:{all:0,code:2,obtain:3,glue:2,menubar:2,slot:2,current:3,explicitli:2,copyright:[],menu:2,activ:2,except:2,should:2,program:[0,2,3],qgi:[2,3],under:[0,2,3],australia:[],"return":[2,3],risk:[0,1,2,3],test_default:0,disast:[0,2,3],term:[0,2,3],gui:[0,2,3],list:3,email:[],item:2,either:[0,2,3],contain:[0,2,3],initialis:2,remov:2,set:[0,2],ifac:[2,3],riabdialogtest:[0,1],procedur:2,methodnam:0,redistribut:[0,2,3],arg:[2,3],our:2,reduct:[],gmail:[0,2,3],index:1,appear:2,publish:[0,2,3],content:1,"public":[0,2,3],state:0,version:[0,2,3],between:2,method:[2,3],run:2,gener:[0,2,3],clearform:0,free:[0,2,3],riabdialog:[1,3],toolbar:2,ausaid:[0,2,3],box:[0,1,2,3],search:1,plugin:[2,3],page:[0,1,2,3],dialog:3,logic:2,action:2,implement:[2,3],com:[0,2,3],load:3,softwar:[0,2,3],modul:1,foundat:[0,2,3],assess:[0,2,3],api:2,facil:[],your:[0,2,3],unit:0,helper:3,modifi:[0,2,3],licens:[0,2,3],custom:2,avail:3,call:2,interfac:2,popul:3,"function":3,option:[0,2,3],form:0,tool:[0,2,3],"case":0,runtest:0,none:[2,3],graphic:2,gnu:[0,2,3],"default":[0,2],setup:0,launch:2,see:2,act:2,can:[0,2,3],invoc:3,initgui:2,layer:3,indonesia:[],creat:[0,2],ani:[0,2,3],indic:1,sourc:[0,2,3],tabl:1,nielsen:[0,2,3],develop:[0,2,3],welcom:1,perform:2,when:2,click:2,note:[0,2,3],also:2,riab:[1,2],test:0,you:[0,2,3],document:[0,1,2,3],getlay:3,breakdown:2,begin:[],moller:[0,2,3],befor:2,rais:[2,3],user:2,associ:2,"class":[0,1,2,3],icon:2,unload:2,entri:2,later:[0,2,3],explicit:2,element:[0,2],contact:[0,2,3],thi:[0,2,3],lstlayer:3},objtypes:{"0":"py:module","1":"py:method","2":"py:class"},titles:["Class: RiabDialogTest","Welcome to Risk-In-A-Box&#8217;s documentation!","Class: Riab","Class RiabDialog"],objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","class","Python class"]},filenames:["riabdialogtest","index","riab","riabdialog"]})
+Search.setIndex({objects:{"":{riabdialogtest:[0,0,1,""],riab:[2,0,1,""],riabdialog:[3,0,1,""]},"riabdialogtest.RiabDialogTest":{clearForm:[0,1,1,""],setUp:[0,1,1,""],test_defaults:[0,1,1,""]},riabdialogtest:{RiabDialogTest:[0,2,1,""]},"riab.Riab":{initGui:[2,1,1,""],run:[2,1,1,""],unload:[2,1,1,""]},riab:{Riab:[2,2,1,""]},"riabdialog.RiabDialog":{getLayers:[3,1,1,""]},riabdialog:{RiabDialog:[3,2,1,""]}},terms:{all:0,code:[4,2],obtain:3,glue:2,menubar:2,slot:2,content:1,explicitli:2,copyright:[],how:4,menu:[4,2],activ:2,except:2,articl:4,program:[0,2,3],requir:[],qgi:[4,2,3],under:[0,4,2,3],local:4,australia:[],"return":[2,3],risk:[0,1,2,3,4],python:4,test_default:0,between:2,disast:[0,2,3],now:4,restart:4,term:[0,2,3],like:4,should:2,button:4,list:3,"public":[0,2,3],item:2,either:[0,2,3],contain:[0,4,2,3],quick:[4,1],initialis:2,pleas:4,set:[0,2],ifac:[2,3],riabdialogtest:[0,1],procedur:2,methodnam:0,redistribut:[0,2,3],arg:[2,3],quantum:[],our:[4,2],reduct:[],gmail:[0,4,2,3],index:1,appear:2,publish:[0,2,3],current:3,method:[2,3],state:0,version:[0,2,3],select:4,simplest:4,email:[],refer:4,moller:[0,4,2,3],run:2,gener:[0,2,3],clearform:0,free:[0,2,3],debug:[],repositori:4,org:[],riabdialog:[1,3],toolbar:2,ausaid:[0,2,3],box:[0,1,2,3,4],search:[4,1],plugin:[4,2,3],page:[0,1,2,3,4],place:4,dialog:3,logic:2,action:2,implement:[2,3],com:[0,4,2,3],first:4,load:3,softwar:[0,2,3],modul:[4,1],foundat:[0,2,3],assess:[0,2,3],api:2,remot:[],instal:[4,1],guid:[4,1],facil:[],your:[0,4,2,3],unit:0,manag:4,git:4,from:4,creat:[0,2],wai:4,modifi:[0,2,3],licens:[0,2,3],system:4,custom:2,avail:[4,3],call:2,interfac:2,popul:3,more:4,"function":[4,3],setup:0,option:[0,2,3],form:0,tool:[0,2,3],copi:4,about:[4,1],linfin:[],aifdr:4,"case":0,runtest:0,none:[2,3],graphic:2,look:4,gnu:[0,2,3],"default":[0,2],wish:4,remov:2,launch:2,see:2,project:4,calcul:4,can:[0,4,2,3],entri:2,invoc:3,fetch:4,initgui:2,layer:3,later:[0,2,3],helper:3,risk_in_a_box:4,ani:[0,2,3],indic:1,sourc:[0,4,2,3],gui:[0,2,3],tabl:1,need:4,nielsen:[0,4,2,3],develop:[0,1,2,3,4],welcom:1,perform:2,when:2,detail:4,click:[4,2],note:[0,2,3],also:2,riab:[1,2],html:4,build:4,which:4,test:0,you:[0,4,2,3],document:[0,1,2,3,4],getlay:3,breakdown:2,begin:[],http:4,clone:4,act:2,befor:2,rais:[2,3],user:[4,1,2],pydev:[],associ:2,"class":[0,1,2,3],icon:2,github:4,unload:2,doc:4,indonesia:[],explicit:2,element:[0,2],inform:4,contact:[0,4,2,3],thi:[0,4,2,3],lstlayer:3,latest:4},objtypes:{"0":"py:module","1":"py:method","2":"py:class"},titles:["Class: RiabDialogTest","Welcome to Risk-In-A-Box&#8217;s documentation!","Class: Riab","Class RiabDialog","About Risk-in-a-box"],objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","class","Python class"]},filenames:["riabdialogtest","index","riab","riabdialog","README"]})
View
1 docs/source/README.rst
View
1 docs/source/index.rst
@@ -11,6 +11,7 @@ Contents:
.. toctree::
:maxdepth: 2
+ README
riab
riabdialog
riabdialogtest

0 comments on commit 5a1dcd5

Please sign in to comment.