1. Chris Mutel
  2. brightway2

Commits

Chris Mutel  committed 6af22d6

Updated installation instructions

  • Participants
  • Parent commits b7add43
  • Branches default

Comments (0)

Files changed (7)

File docs/configuration.rst

View file
+.. _configuration:
+
+Configuration
+*************
+
+Get started with the web interface. In a shell or command prompt, type:
+
+.. code-block:: bash
+
+    bw2-web.py

File docs/images/canopy-console-ipython.png

Added
New image

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

Removed
Old image

File docs/index.rst

View file
 Please see `the main Brightway2 site <http://brightwaylca.org>`_ for an introduction.
 
 .. note::
-    Brightway2 is currently only compatible with python 2.7, not python 3. Brightway2 will remain 2.7 only until `flask <http://pypi.python.org/pypi/Flask>`_ and its dependencies are ported to Python 3.
+    Brightway2 is currently only compatible with python 2.7, not python 3. Not all Brightway2 dependencies are compatible with Python 3.
 
 Documentation
 =============
 
    quickstart
    installation
+   configuration
    tutorials
    key-concepts
    contributing

File docs/installation.rst

View file
 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>`_. After installing 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.
 
-.. warning:: Be sure to check the option to install **pip**:
+Preferred installation: Python(x,y)
+-----------------------------------
 
-.. image:: images/python-xy-pip.png
-    :align: center
-
-.. warning:: Using other packaged version of Python, e.g. `Anaconda <http://continuum.io/downloads.html>`_ or `Enthought Canopy <https://www.enthought.com/products/canopy/>`_ is not supported. While convenient, these packaged version change basic assumptions about the Python environment that can break Brightway2 functionality.
-
-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/>`_.
-
-LCA practitioners
------------------
+Download and install the `Python(x,y) executable <https://code.google.com/p/pythonxy/wiki/Downloads>`_. All the necessary background libraries will be installed.
 
 After the basic installation, you can install all additional Brightway2 packages and dependencies in one command in the command shell:
 
 .. code-block:: bash
 
-	pip install brightway2
+    pip install brightway2
 
-Developers
-----------
+.. _canopy:
 
-If you want to develop with Brightway2, then don't install the metapackage. Instead, first install `virtualenv <http://www.virtualenv.org/>`_ and `virtualenv for Powershell <https://bitbucket.org/guillermooo/virtualenvwrapper-powershell>`_:
+Alternate installation: Enthought Canopy
+----------------------------------------
+
+.. warning:: This is not the preferred installation method!
+
+.. warning:: `Canopy Express <https://www.enthought.com/canopy-express/>`_ will not work with Brightway2, as it does `not include the lxml package <https://enthought.com/products/canopy/package-index/>`_.
+
+`Enthought Canopy <https://www.enthought.com/products/canopy/>`_ provides a nice Python environment and free academic licenses.
+
+After installing Canopy and all Canopy packages, install the free package ``pip``. You can then install Brightway2 in the command line:
 
 .. code-block:: bash
 
-    pip install virtualenv virtualenvwrapper-powershell
-    mkvirtualenv bw2 --system-site-packages
+    pip install brightway2
 
-Before you do anything else, go back and read what ``virtualenv`` does :) Now you can install packages into your isolated environment:
+Or in the ipython shell in the editor:
 
 .. code-block:: bash
 
-    pip install -e hg+https://bitbucket.org/cmutel/brightway2-data#egg=bw2data
-    pip install -e hg+https://bitbucket.org/cmutel/brightway2-calc#egg=bw2calc
-    pip install -e hg+https://bitbucket.org/cmutel/brightway2-ui#egg=bw2ui
-    pip install -e hg+https://bitbucket.org/cmutel/brightway2-analyzer#egg=bw2analyzer
+    !pip install brightway2
+
+.. image:: images/canopy-console-ipython.png
+    :align: center
+
+.. _anaconda:
+
+Alternate installation: Continuum Anaconda
+------------------------------------------
+
+.. warning:: This is not the preferred installation method!
+
+.. warning:: Brightway2 is only compatible with Python version 2.7, not yet with Python 3
+
+`Continuum Anaconda <http://continuum.io/downloads.html>`_ provides another Python environment and package manager, and is free.
+
+Some requirements are installed by the ``conda`` package manager, but many others aren't. For each of the :ref:`requirements`, try to install with ``conda``, as it is the preferred package manager; use ``pip`` only if ``conda`` fails:
+
+.. code-block:: bash
+
+    conda install some_package
+    # If that doesn't work
+    pip install some_package
+
+Install Brightway2 using ``pip``:
+
+.. code-block:: bash
+    pip install brightway2
+
+See also `pip packages in anaconda <http://stackoverflow.com/questions/18640305/how-to-keep-track-of-pip-installed-packages-in-an-anaconda-conda-env>`_.
+
+.. note:: When I did a test install on Windows XP, Anaconda did not associate ``.py`` files with Python. To run e.g. ``bw2-web.py`` I had to change to the ``C:\Python27\Scripts`` directory
 
 .. _os-x-install:
 
 Max OS X
 ========
 
-There are two main alternatives for installing packages on OS X: `Macports <http://www.macports.org/>`_ and `Homebrew <http://mxcl.github.com/homebrew/>`_. Brightway2 is developed primarily on OS X using Macports, but as it depends on a few standard libraries, either alternative should work well. Homebrew users will have to adapt the following instructions.
+.. note:: If you are using ``Canopy``, see :ref:`canopy`.
+
+.. note:: If you are using ``Anaconda``, see :ref:`anaconda`.
+
+There are two main OS X-specific alternatives for installing Python packages: `Macports <http://www.macports.org/>`_ and `Homebrew <http://mxcl.github.com/homebrew/>`_. Brightway2 is developed primarily on OS X using Macports, but as it depends on a few standard libraries, either alternative should work well. Homebrew users will have to adapt the following instructions.
 
 Follow the `instructions <http://www.macports.org/install.php>`_ and install Macports. Note that both Macports and Homebrew require Xcode to be installed first. Xcode can be installed from the OS X installation disk (for 10.6 or lower), the app store (10.7 or higher), or `other unofficial sources <https://github.com/kennethreitz/osx-gcc-installer>`_.
 
 
 	sudo port install py27-scipy py27-numpy py27-pip py27-progressbar py27-libxml2
 
-LCA practitioners
------------------
-
-To only work with Brightway2, finish your installation using another Terminal command:
+Finish your installation using another Terminal command:
 
 .. code-block:: bash
 
 	sudo pip install brightway2
 
-Developers
-----------
-
-If you want to develop with Brightway, then don't install the metapackage. Instead, we will create a `virtualenv <http://www.virtualenv.org/>`_ for the Brightway2 dependencies and framework. First, read what ``virtualenv`` does; then, run the following in a Terminal:
-
-.. code-block:: bash
-
-    sudo port install virtualenv virtualenvwrapper py27-cython py27-nose py27-sphinx py27-flask py27-requests
-    mkvirtualenv bw2 --system-site-packages
-    pip install docopt voluptuous bw-stats-toolkit fuzzywuzzy
-    pip install -e hg+https://bitbucket.org/cmutel/brightway2-data#egg=bw2data
-    pip install -e hg+https://bitbucket.org/cmutel/brightway2-calc#egg=bw2calc
-    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
 =====
 
-General instructions are provided for Ubuntu; people using other distributions are assumed smart to be enough to adapt as necessary. See also `Platform-agnostic`_ instructions above.
+.. note:: If you are using ``Canopy``, see :ref:`canopy`.
+
+.. note:: If you are using ``Anaconda``, see :ref:`anaconda`.
+
+General instructions are provided for Ubuntu; people using other distributions are assumed smart to be enough to adapt as necessary. See also :ref:`platform-agnostic` instructions above.
 
 First, install the required ``apt`` packages. You can select them in the graphical interface, or through one command in the terminal:
 
 
 	sudo apt-get install python-scipy python-numpy python-nose python-pip python-progressbar python-libxml2 python-sphinx python-virtualenv python-virtualenvwrapper
 
-LCA practitioners
------------------
-
-Install Brightway2 using another terminal command:
+Next, install Brightway2 using another terminal command:
 
 .. code-block:: bash
 
 	sudo pip install brightway2
 
-Developers
-----------
-
-If you want to develop with Brightway, then don't install the metapackage. Instead, we will create a `virtualenv <http://www.virtualenv.org/>`_ for the Brightway2 dependencies and framework. First, read what ``virtualenv`` does; then, run the following in a Terminal:
-
-.. code-block:: bash
-
-    mkvirtualenv bw2 --system-site-packages
-    pip install docopt voluptuous bw-stats-toolkit flask requests fuzzywuzzy
-    pip install -e hg+https://bitbucket.org/cmutel/brightway2-data#egg=bw2data
-    pip install -e hg+https://bitbucket.org/cmutel/brightway2-calc#egg=bw2calc
-    pip install -e hg+https://bitbucket.org/cmutel/brightway2-ui#egg=bw2ui
-    pip install -e hg+https://bitbucket.org/cmutel/brightway2-analyzer#egg=bw2analyzer
+.. _platform-agnostic:
 
 Platform-agnostic
 =================
 
 .. warning:: Make sure that ``SciPy`` builds with support for `UMFPACK <http://www.cise.ufl.edu/research/sparse/umfpack/>`_; you may need to also install `scikits-umpack <http://scikits.appspot.com/umfpack>`_.
 
-Second, install the Brightway2 metapackage:
+Second, install the Brightway2 package:
 
 .. code-block:: bash
 
     pip install brightay2
 
+.. _requirements:
+
+Requirements
+------------
+
 If you want to install packages manually, or not install everything, Brightway2 uses the following Python packages:
 
+* scipy
+* numpy
+* lxml
 * progressbar
 * flask
 * docopt
 * requests
 * bw-stats-toolkit
 
+Brightway2 packages
+-------------------
+
 The Brightway2 packages are:
 
 * bw2data
 * bw2ui
 * bw2analyzer
 
+Developers
+==========
+
+.. warning:: If you are developing, it is *strongly* recommended to use `virtualenv <http://www.virtualenv.org/>`_ and `virtualenvwrapper <http://www.doughellmann.com/projects/virtualenvwrapper/>`_.
+
 If you want to develop with Brightway, then you should install the following:
 
 * nose
 * sphinx
 
-.. warning:: If you are developing, it is *strongly* recommended to use `virtualenv <http://www.virtualenv.org/>`_ and `virtualenvwrapper <http://www.doughellmann.com/projects/virtualenvwrapper/>`_.
+You can install editable Brightway2 packages using `mercurial <http://mercurial.selenic.com/>`_:
+
+.. code-block:: bash
+
+    pip install -e hg+https://bitbucket.org/cmutel/brightway2-data#egg=bw2data
+    pip install -e hg+https://bitbucket.org/cmutel/brightway2-calc#egg=bw2calc
+    pip install -e hg+https://bitbucket.org/cmutel/brightway2-ui#egg=bw2ui
+    pip install -e hg+https://bitbucket.org/cmutel/brightway2-analyzer#egg=bw2analyzer
+
+You can also simply clone the bitbucket repositories.

File docs/quickstart.rst

View file
 Windows quickstart
 ******************
 
-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:
+This is the easiest way to get started using Brightway2 on **Windows**. If you are interested in other installation options, or are using **Mac OS X** or **Linux**, see the 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.
+Installing Python
+-----------------
+
+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 `numerical <http://numpy.scipy.org/>`_ and `scientific <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**:
+Installing Brightway2
+---------------------
 
-.. 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>`_
-
-Third, open a command prompt (Start -> Command Prompt), and type in the following:
+Open a command prompt (Start -> Command Prompt), and type in the following:
 
 .. code-block:: bash
 
     pip install brightway2
 
+Running Brightway2
+------------------
+
 Finally, again in the command prompt, start Brightway2:
 
 .. code-block:: bash
     bw2-web.py
 
 This should start the program, and open a new web browser tab to the correct address. Brightway2 will recognize that you are starting it for the first time, and give you instructions on how to download basic data, import your projects, and start working.
+
+.. note:: See also :ref:`configuration`

File setup.py

View file
     "bw2analyzer>=0.4",
     "bw2data>=0.10.1",
     "requests>=1.1.0",
-    "bw-stats-toolkit>=0.7",
+    "stats_arrays>=0.2.2",
 ]
 
 setup(