Commits

Chris Mutel  committed 0c16d16

Installation docs improvements

  • Participants
  • Parent commits b3a072f

Comments (0)

Files changed (7)

 Brightway2 life cycle assessment framework
 ==========================================
 
-Brightway2 is a framework for advanced life cycle assessment calculations. It consists of several components which each accomplish specific tasks. This core component does data management, including interacting with metadata, life cycle inventories, and impact assessment methods.
+Brightway2 is a framework for advanced life cycle assessment calculations. It consists of several components which each accomplish specific tasks. This package is a container for all the separate components, for ease of documentation and installation.
 
 Brightway2 is inspired by the Brightway software, which was developed during Chris Mutel's PhD work at ETH Zurich, but is a complete rewrite focusing on simplicity, power, and ease of use. Brightway2 can run on all major operating systems.
 
 Learn more at the following sites:
 
-	http://brightwaylca.org
+* http://brightwaylca.org
+* http://chris.mutel.org
 
 Online documentation is at:
 
-	https://brightway2.readthedocs.org/
+* https://brightway2.readthedocs.org/

File docs/current_status.rst

 brightway2-analyzer
 ===================
 
-Current version: **0.1**
+Current version: **0.1.1**
 
 Upcoming features and releases
 ------------------------------
 brightway2-ui
 =============
 
-Current version: **0.4.2**
+Current version: **0.4.3**
 
 Upcoming features and releases
 ------------------------------
 * Add database explorer
 * Add method explorer
 
-0.4.3 (in progress)
+0.4.4 (in progress)
 -------------------
 
 * Continue cleanup of LCA results page

File docs/images/new-graphics.png

Added
New image

File docs/images/python-xy-pip.png

Added
New image

File docs/index.rst

 
 Brightway2 is a simple framework for life cycle assessment (LCA). Its focus is on efficient calculation and visualization. Brightway2 is a complete rewrite of the original Brightway, which was a previous LCA framework developed during the PhD thesis of Chris Mutel.
 
-.. attention:: 
-    Brightway2 is in heavy development, and while it is used by mutiple people every day, it is probably not ready for people who don't like digging into source code and filing bug reports.
+.. warning:: Brightway2 is in heavy development, and while it is used by mutiple people every day, it is probably not ready for people who don't like digging into source code and filing bug reports.
 
 Why another LCA framework?
 ==========================
 New data visualizations
 -----------------------
 
-(Include visualizations here)
+.. image:: images/new-graphics.png
+    :align: center
 
-Treemaps and Hinton matrices are already part of the standard LCA report, and new visualizations using the D3 library are planned. See the examples.
+Treemaps and Hinton matrices are already part of the standard LCA report, and new visualizations using the D3 library are planned.
 
 Simple data handling
 --------------------
 Quick start
 ===========
 
-This is the easiest way to get started using Brightway2 on **Windows**. If you are interested in using the full power of the Brightway2 framework, or are using **Mac OS X** or **Linux**, see other installation options (link).
+This is the easiest way to get started using Brightway2 on **Windows**. If you are interested in using the full power of the Brightway2 framework, or are using **Mac OS X** or **Linux**, see other installation options:
+
+* :ref:`windows-install`
+* :ref:`os-x-install`
+* :ref:`linux-install`
 
 First, download the latest version of `Python (x,y) <https://code.google.com/p/pythonxy/wiki/Downloads>`_, and install it. This is the easiest way to get the `NumPy <http://numpy.scipy.org/>`_ and `SciPy <http://scipy.org/>`_ libraries.
 
 * `Python (x,y) <https://code.google.com/p/pythonxy/wiki/Downloads>`_
 
+.. note:: Be sure to check the option to install **pip**:
+
+.. image:: images/python-xy-pip.png
+    :align: center
+
 Second, download and install the XML processing library `lxml <http://pythonxy.googlecode.com/files/lxml-3.0.1-1_py27.exe>`_.
 
 * `lxml <http://pythonxy.googlecode.com/files/lxml-3.0.1-1_py27.exe>`_

File docs/installation.rst

 Installation
 ************
 
+.. _windows-install:
+
 Windows 
 =======
 
-Although Brightway2 is relatively simple, installation of the numerical and scientific libraries can be difficult as there is no default compilers installed on most Windows machines. The only sensible way is to use a precompiled set of packages, such as `Python (x,y) <https://code.google.com/p/pythonxy/wiki/Downloads>`_ or the `Enthought Python Distribution <http://www.enthought.com/products/epd.php>`_. If using Python (x,y), be sure to install `lxml <http://pythonxy.googlecode.com/files/lxml-3.0.1-1_py27.exe>`_ separately.
+Although Brightway2 is relatively simple, installation of the numerical and scientific libraries can be difficult as there is no default compilers installed on most Windows machines. The only sensible way is to use a precompiled set of packages, such as `Python (x,y) <https://code.google.com/p/pythonxy/wiki/Downloads>`_. Using `Anaconda Community Edition <http://continuum.io/anacondace.html>`_, or the `Enthought Python Distribution <http://www.enthought.com/products/epd.php>`_ is also possible, but not tested (they have custom package management commands). If using Python (x,y), be sure to install `lxml <http://pythonxy.googlecode.com/files/lxml-3.0.1-1_py27.exe>`_ separately.
+
+.. warning:: If you use python (x,y), be sure to check the option to install **pip**:
+
+.. image:: images/python-xy-pip.png
+    :align: center
 
 If you are stubborn and/or brave, you can try to install Python, NumPy, SciPy and lxml by yourself. The are various compiled binaries for each of these packages available at various places around the net. You should also install `pip <http://www.pip-installer.org/>`_.
 
     pip install -e hg+https://bitbucket.org/cmutel/brightway2-ui#egg=bw2ui
     pip install -e hg+https://bitbucket.org/cmutel/brightway2-analyzer#egg=bw2analyzer
 
+.. _os-x-install:
+
 Max OS X
 ========
 
     pip install -e hg+https://bitbucket.org/cmutel/brightway2-ui#egg=bw2ui
     pip install -e hg+https://bitbucket.org/cmutel/brightway2-analyzer#egg=bw2analyzer
 
+.. _linux-install:
+
 Linux
 =====
 
-from distutils.core import setup
+from setuptools import setup
+
+packages = [
+    "lxml",
+    "numpy",
+    "scipy",
+    "nose",
+    "progressbar",
+    "voluptuous",
+    "fuzzywuzzy",
+    "flask",
+    "docopt",
+    "bw2calc",
+    "bw2ui",
+    "bw2analyzer",
+    "bw2data",
+    "requests",
+    "bw-stats-toolkit",
+]
 
 setup(
   name='brightway2',
-  version="0.8.1",
+  version="0.8.2",
   packages=["brightway2"],
   author="Chris Mutel",
   author_email="cmutel@gmail.com",
   license=open('LICENSE.txt').read(),
-  install_requires=["bw2data", "bw2calc", "bw2ui", "bw2analyzer"],
+  install_requires=packages,
   url="https://bitbucket.org/cmutel/brightway2",
   long_description=open('README').read(),
 )