[yt-svn] commit/yt: chummels: Merged in ngoldbaum/yt/yt-3.0 (pull request #1055)
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Thu Jul 24 09:07:29 PDT 2014
1 new commit in yt:
https://bitbucket.org/yt_analysis/yt/commits/5a10dea0299b/
Changeset: 5a10dea0299b
Branch: yt-3.0
User: chummels
Date: 2014-07-24 18:07:18
Summary: Merged in ngoldbaum/yt/yt-3.0 (pull request #1055)
Updating the installation instructions.
Affected #: 8 files
diff -r 58f37beaba3c763150dc4b1a83debafc5e8f63c8 -r 5a10dea0299bf9cf1587b4365fd8b73688636a8e doc/source/analyzing/units/index.rst
--- a/doc/source/analyzing/units/index.rst
+++ b/doc/source/analyzing/units/index.rst
@@ -12,9 +12,9 @@
and execute the documentation interactively, you need to download the repository
and start the IPython notebook.
-If you installed `yt` using the install script, you will need to navigate to
-:code:`$YT_DEST/src/yt-hg/doc/source/units`, then start an IPython notebook
-server:
+You will then need to navigate to :code:`$YT_HG/doc/source/units` (where $YT_HG
+is the location of a clone of the yt mercurial repository), and then start an
+IPython notebook server:
.. code:: bash
diff -r 58f37beaba3c763150dc4b1a83debafc5e8f63c8 -r 5a10dea0299bf9cf1587b4365fd8b73688636a8e doc/source/developing/building_the_docs.rst
--- a/doc/source/developing/building_the_docs.rst
+++ b/doc/source/developing/building_the_docs.rst
@@ -55,11 +55,11 @@
.. code-block:: bash
- cd $YT_DEST/src/yt-hg/doc
+ cd $YT_HG/doc
make html
This will produce an html version of the documentation locally in the
-``$YT_DEST/src/yt-hg/doc/build/html`` directory. You can now go there and open
+``$YT_HG/doc/build/html`` directory. You can now go there and open
up ``index.html`` or whatever file you wish in your web browser.
Building the docs (full)
@@ -116,7 +116,7 @@
.. code-block:: bash
- cd $YT_DEST/src/yt-hg/doc
+ cd $YT_HG/doc
make html
If all of the dependencies are installed and all of the test data is in the
diff -r 58f37beaba3c763150dc4b1a83debafc5e8f63c8 -r 5a10dea0299bf9cf1587b4365fd8b73688636a8e doc/source/developing/developing.rst
--- a/doc/source/developing/developing.rst
+++ b/doc/source/developing/developing.rst
@@ -165,10 +165,15 @@
Only one of these two options is needed.
-If you plan to develop yt on Windows, we recommend using the `MinGW <http://www.mingw.org/>`_ gcc
-compiler that can be installed using the `Anaconda Python
-Distribution <https://store.continuum.io/cshop/anaconda/>`_. Also, the syntax for the
-setup command is slightly different; you must type:
+.. _windows-developing:
+
+Developing yt on Windows
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you plan to develop yt on Windows, we recommend using the `MinGW
+<http://www.mingw.org/>`_ gcc compiler that can be installed using the `Anaconda
+Python Distribution <https://store.continuum.io/cshop/anaconda/>`_. Also, the
+syntax for the setup command is slightly different; you must type:
.. code-block:: bash
@@ -185,17 +190,24 @@
Making and Sharing Changes
++++++++++++++++++++++++++
-The simplest way to submit changes to yt is to commit changes in your
-``$YT_DEST/src/yt-hg`` directory, fork the repository on BitBucket, push the
-changesets to your fork, and then issue a pull request.
+The simplest way to submit changes to yt is to do the following:
+
+ * Build yt from the mercurial repository
+ * Navigate to the root of the yt repository
+ * Make some changes and commit them
+ * Fork the `yt repository on BitBucket <https://bitbucket.org/yt_analysis/yt>`_
+ * Push the changesets to your fork
+ * Issue a pull request.
Here's a more detailed flowchart of how to submit changes.
#. If you have used the installation script, the source code for yt can be
- found in ``$YT_DEST/src/yt-hg``. (Below, in :ref:`reading-source`,
- we describe how to find items of interest.) Edit the source file you are
- interested in and test your changes. (See :ref:`testing` for more
- information.)
+ found in ``$YT_DEST/src/yt-hg``. Alternatively see
+ :ref:`source-installation` for instructions on how to build yt from the
+ mercurial repository. (Below, in :ref:`reading-source`, we describe how to
+ find items of interest.)
+ #. Edit the source file you are interested in and
+ test your changes. (See :ref:`testing` for more information.)
#. Fork yt on BitBucket. (This step only has to be done once.) You can do
this at: https://bitbucket.org/yt_analysis/yt/fork . Call this repository
``yt``.
@@ -207,7 +219,7 @@
these changes as well.
#. Push your changes to your new fork using the command::
- hg push https://bitbucket.org/YourUsername/yt/
+ hg push -r . https://bitbucket.org/YourUsername/yt/
If you end up doing considerable development, you can set an alias in the
file ``.hg/hgrc`` to point to this path.
@@ -244,9 +256,9 @@
include a recipe in the cookbook section, or it could simply be adding a note
in the relevant docs text somewhere.
-The documentation exists in the main mercurial code repository for yt in the
-``doc`` directory (i.e. ``$YT_DEST/src/yt-hg/doc/source`` on systems installed
-using the installer script). It is organized hierarchically into the main
+The documentation exists in the main mercurial code repository for yt in the
+``doc`` directory (i.e. ``$YT_HG/doc/source`` where ``$YT_HG`` is the path of
+the yt mercurial repository). It is organized hierarchically into the main
categories of:
* Visualizing
@@ -345,16 +357,6 @@
yt``), then you must "activate" it using the following commands from within the
repository directory.
-In order to do this for the first time with a new repository, you have to
-copy some config files over from your yt installation directory (where yt
-was initially installed from the install_script.sh). Try this:
-
-.. code-block:: bash
-
- $ cp $YT_DEST/src/yt-hg/*.cfg <REPOSITORY_NAME>
-
-and then every time you want to "activate" a different repository of yt.
-
.. code-block:: bash
$ cd <REPOSITORY_NAME>
@@ -367,11 +369,16 @@
How To Read The Source Code
---------------------------
-If you just want to *look* at the source code, you already have it on your
-computer. Go to the directory where you ran the install_script.sh, then
-go to ``$YT_DEST/src/yt-hg`` . In this directory are a number of
-subdirectories with different components of the code, although most of them
-are in the yt subdirectory. Feel free to explore here.
+If you just want to *look* at the source code, you may already have it on your
+computer. If you build yt using the install script, the source is available at
+``$YT_DEST/src/yt-hg``. See :ref:`source-installation` for more details about
+to obtain the yt source code if you did not build yt using the install
+script.
+
+The root directory of the yt mercurial repository contains a number of
+subdirectories with different components of the code. Most of the yt source
+code is contained in the ``yt`` subdirectory. This directory its self contains
+the following subdirectories:
``frontends``
This is where interfaces to codes are created. Within each subdirectory of
@@ -380,10 +387,19 @@
* ``data_structures.py``, where subclasses of AMRGridPatch, Dataset
and AMRHierarchy are defined.
* ``io.py``, where a subclass of IOHandler is defined.
+ * ``fields.py``, where fields we expect to find in datasets are defined
* ``misc.py``, where any miscellaneous functions or classes are defined.
* ``definitions.py``, where any definitions specific to the frontend are
defined. (i.e., header formats, etc.)
+ ``fields``
+ This is where all of the derived fields that ship with yt are defined.
+
+ ``geometry``
+ This is where geometric helpler routines are defined. Handlers
+ for grid and oct data, as well as helpers for coordinate transformations
+ can be found here.
+
``visualization``
This is where all visualization modules are stored. This includes plot
collections, the volume rendering interface, and pixelization frontends.
@@ -409,6 +425,10 @@
All broadly useful code that doesn't clearly fit in one of the other
categories goes here.
+ ``extern``
+ Bundled external modules (i.e. code that was not written by one of
+ the yt authors but that yt depends on) lives here.
+
If you're looking for a specific file or function in the yt source code, use
the unix find command:
diff -r 58f37beaba3c763150dc4b1a83debafc5e8f63c8 -r 5a10dea0299bf9cf1587b4365fd8b73688636a8e doc/source/developing/intro.rst
--- a/doc/source/developing/intro.rst
+++ b/doc/source/developing/intro.rst
@@ -66,11 +66,11 @@
typo or grammatical fixes, adding a FAQ, or increasing coverage of
functionality, it would be very helpful if you wanted to help out.
-The easiest way to help out is to fork the main yt repository (where
-the documentation lives in the ``$YT_DEST/src/yt-hg/doc`` directory,
-and then make your changes in your own fork. When you are done, issue a pull
-request through the website for your new fork, and we can comment back and
-forth and eventually accept your changes.
+The easiest way to help out is to fork the main yt repository (where the
+documentation lives in the ``doc`` directory in the root of the yt mercurial
+repository) and then make your changes in your own fork. When you are done,
+issue a pull request through the website for your new fork, and we can comment
+back and forth and eventually accept your changes.
One of the more interesting ways we are attempting to do lately is to add
screencasts to the documentation -- these are recordings of people executing
diff -r 58f37beaba3c763150dc4b1a83debafc5e8f63c8 -r 5a10dea0299bf9cf1587b4365fd8b73688636a8e doc/source/developing/testing.rst
--- a/doc/source/developing/testing.rst
+++ b/doc/source/developing/testing.rst
@@ -59,11 +59,13 @@
$ cd $YT_HG
$ nosetests
+where ``$YT_HG`` is the path to the root of the yt mercurial repository.
+
If you want to specify a specific unit test to run (and not run the entire
suite), you can do so by specifying the path of the test relative to the
-``$YT_DEST/src/yt-hg/yt`` directory -- note that you strip off one ``yt`` more
-than you normally would! For example, if you want to run the
-plot_window tests, you'd run:
+``$YT_HG/yt`` directory -- note that you strip off one ``yt`` more than you
+normally would! For example, if you want to run the plot_window tests, you'd
+run:
.. code-block:: bash
@@ -172,7 +174,7 @@
$ nosetests --with-answer-testing
In either case, the current gold standard results will be downloaded from the
-amazon cloud and compared to what is generated locally. The results from a
+rackspace cloud and compared to what is generated locally. The results from a
nose testing session are pretty straightforward to understand, the results for
each test are printed directly to STDOUT. If a test passes, nose prints a
period, F if a test fails, and E if the test encounters an exception or errors
diff -r 58f37beaba3c763150dc4b1a83debafc5e8f63c8 -r 5a10dea0299bf9cf1587b4365fd8b73688636a8e doc/source/help/index.rst
--- a/doc/source/help/index.rst
+++ b/doc/source/help/index.rst
@@ -88,31 +88,40 @@
-----------------------
We've done our best to make the source clean, and it is easily searchable from
-your computer. Go inside your yt install directory by going to the
-``$YT_DEST/src/yt-hg/yt`` directory where all the code lives. You can then search
-for the class, function, or keyword which is giving you problems with
-``grep -r *``, which will recursively search throughout the code base. (For a
-much faster and cleaner experience, we recommend ``grin`` instead of
-``grep -r *``. To install ``grin`` with python, just type ``pip install
-grin``.)
+your computer.
-So let's say that pesky ``SlicePlot`` is giving you problems still, and you
-want to look at the source to figure out what is going on.
+If you have not done so already (see :ref:`source-installation`), clone a copy of the yt mercurial repository and make it the 'active' installation by doing
+
+.. code-block::bash
+
+ python setup.py develop
+
+in the root directory of the yt mercurial repository.
+
+.. note::
+
+ This has already been done for you if you installed using the bash install
+ script. Building yt from source will not work if you do not have a C compiler
+ installed.
+
+Once inside the yt mercurial repository, you can then search for the class,
+function, or keyword which is giving you problems with ``grep -r *``, which will
+recursively search throughout the code base. (For a much faster and cleaner
+experience, we recommend ``grin`` instead of ``grep -r *``. To install ``grin``
+with python, just type ``pip install grin``.)
+
+So let's say that ``SlicePlot`` is giving you problems still, and you want to
+look at the source to figure out what is going on.
.. code-block:: bash
- $ cd $YT_DEST/src/yt-hg/yt
+ $ cd $YT-HG/yt
$ grep -r SlicePlot * (or $ grin SlicePlot)
-
- data_objects/analyzer_objects.py:class SlicePlotDataset(AnalysisTask):
- data_objects/analyzer_objects.py: from yt.visualization.api import SlicePlot
- data_objects/analyzer_objects.py: self.SlicePlot = SlicePlot
- data_objects/analyzer_objects.py: slc = self.SlicePlot(ds, self.axis, self.field, center = self.center)
- ...
-You can now followup on this and open up the files that have references to
-``SlicePlot`` (particularly the one that definese SlicePlot) and inspect their
-contents for problems or clarification.
+This will print a number of locations in the yt source tree where ``SlicePlot``
+is mentioned. You can now followup on this and open up the files that have
+references to ``SlicePlot`` (particularly the one that defines SlicePlot) and
+inspect their contents for problems or clarification.
.. _isolate_and_document:
@@ -128,7 +137,6 @@
* Put your script, errors, and outputs online:
* ``$ yt pastebin script.py`` - pastes script.py online
- * ``$ python script.py --paste`` - pastes errors online
* ``$ yt upload_image image.png`` - pastes image online
* Identify which version of the code you’re using.
diff -r 58f37beaba3c763150dc4b1a83debafc5e8f63c8 -r 5a10dea0299bf9cf1587b4365fd8b73688636a8e doc/source/installing.rst
--- a/doc/source/installing.rst
+++ b/doc/source/installing.rst
@@ -8,39 +8,190 @@
Getting yt
----------
-yt is a Python package (with some components written in C), using NumPy as a
-computation engine, Matplotlib for some visualization tasks and Mercurial for
-version control. Because installation of all of these interlocking parts can
-be time-consuming, yt provides an installation script which downloads and builds
-a fully-isolated Python + NumPy + Matplotlib + HDF5 + Mercurial installation.
-yt supports Linux and OSX deployment, with the possibility of deployment on
-other Unix-like systems (XSEDE resources, clusters, etc.).
+In this document we describe several methods for installing yt. The method that
+will work best for you depends on your precise situation:
-Since the install is fully-isolated, if you get tired of having yt on your
-system, you can just delete its directory, and yt and all of its dependencies
-will be removed from your system (no scattered files remaining throughout
-your system).
+* If you already have a scientific python software stack installed on your
+ computer and are comfortable installing python packages,
+ :ref:`source-installation` will probably be the best choice. If you have set
+ up python using a source-based package manager like `Homebrew
+ <http://brew.sh>`_ or `MacPorts <http://www.macports.org/>`_ this choice will
+ let you install yt using the python installed by the package manager. Similarly
+ for python environments set up via linux package managers so long as you
+ have the the necessary compilers installed (e.g. the ``build-essentials``
+ package on debian and ubuntu).
+
+* If you use the `Anaconda <https://store.continuum.io/cshop/anaconda/>`_ python
+ distribution see :ref:`anaconda-installation` for details on how to install
+ yt using the ``conda`` package manager. Source-based installation from the
+ mercurial repository or via ``pip`` should also work under Anaconda. Note that
+ this is currently the only supported installation mechanism on Windows.
+
+* If you do not have root access on your computer, are not comfortable managing
+ python packages, or are working on a supercomputer or cluster computer, you
+ will probably want to use the bash installation script. This builds python,
+ numpy, matplotlib, and yt from source to set up an isolated scientific python
+ environment inside of a single folder in your home directory. See
+ :ref:`install-script` for more details.
+
+.. _source-installation:
+
+Installing yt Using pip or from Source
+++++++++++++++++++++++++++++++++++++++
+
+To install yt from source, you must make sure you have yt's dependencies
+installed on your system. These include: a C compiler, ``HDF5``, ``python``,
+``Cython``, ``NumPy``, ``matplotlib``, ``sympy``, and ``h5py``. From here, you
+can use ``pip`` (which comes with ``Python``) to install the latest stable
+version of yt:
+
+.. code-block:: bash
+
+ $ pip install yt
+
+The source code for yt may be found at the Bitbucket project site and can also
+be utilized for installation. If you prefer to install the development version
+of yt instead of the latest stable release, you will need ``mercurial`` to clone
+the official repo:
+
+.. code-block:: bash
+
+ hg clone https://bitbucket.org/yt_analysis/yt
+ cd yt
+ hg update yt
+ python setup.py install --user
+
+This will install yt into ``$HOME/.local/lib64/python2.7/site-packages``.
+Please refer to ``setuptools`` documentation for the additional options.
+
+If you will be modifying yt, you can also make the clone of the yt mercurial
+repository the "active" installed copy:
+
+..code-block:: bash
+
+ hg clone https://bitbucket.org/yt_analysis/yt
+ cd yt
+ hg update yt
+ python setup.py develop
+
+If you choose this installation method, you do not need to run any activation
+script since this will install yt into your global python environment.
+
+Keeping yt Updated via Mercurial
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you want to maintain your yt installation via updates straight from the
+Bitbucket repository or if you want to do some development on your own, we
+suggest you check out some of the :ref:`development docs <contributing-code>`,
+especially the sections on :ref:`Mercurial <mercurial-with-yt>` and
+:ref:`building yt from source <building-yt>`.
+
+You can also make use of the following command to keep yt up to date from the
+command line:
+
+.. code-block:: bash
+
+ yt update
+
+This will detect that you have installed yt from the mercurial repository, pull
+any changes from bitbucket, and then recompile yt if necessary.
+
+.. _anaconda-installation:
+
+Installing yt Using Anaconda
+++++++++++++++++++++++++++++
+
+Perhaps the quickest way to get yt up and running is to install it using the
+`Anaconda Python Distribution <https://store.continuum.io/cshop/anaconda/>`_,
+which will provide you with a easy-to-use environment for installing Python
+packages.
+
+If you do not want to install the full anaconda python distribution, you can
+install a bare-bones Python installation using miniconda. To install miniconda,
+visit http://repo.continuum.io/miniconda/ and download a recent version of the
+``Miniconda-x.y.z`` script (corresponding to Python 2.7) for your platform and
+system architecture. Next, run the script, e.g.:
+
+.. code-block:: bash
+
+ bash Miniconda-3.3.0-Linux-x86_64.sh
+
+Make sure that the Anaconda ``bin`` directory is in your path, and then issue:
+
+.. code-block:: bash
+
+ conda install yt
+
+which will install yt along with all of its dependencies.
+
+Recipes to build conda packages for yt are available at
+https://github.com/conda/conda-recipes. To build the yt conda recipe, first
+clone the conda-recipes repository
+
+.. code-block:: bash
+
+ git clone https://github.com/conda/conda-recipes
+
+Then navigate to the repository root and invoke `conda build`:
+
+.. code-block:: bash
+
+ cd conda-recipes
+ conda build ./yt/
+
+Note that building a yt conda package requires a C compiler.
+
+.. _windows-installation:
+
+Installing yt on Windows
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Installation on Microsoft Windows is only supported for Windows XP Service Pack
+3 and higher (both 32-bit and 64-bit) using Anaconda, see
+:ref:`anaconda-installation`. Also see :ref:`windows-developing` for details on
+how to build yt from source in Windows.
+
+.. _install-script:
+
+All-in-one installation script
+++++++++++++++++++++++++++++++
+
+Because installation of all of the interlocking parts necessary to install yt
+itself can be time-consuming, yt provides an all-in-one installation script
+which downloads and builds a fully-isolated Python + NumPy + Matplotlib + HDF5 +
+Mercurial installation. Since the install script compiles yt's dependencies from
+source, you must have C, C++, and optionally Fortran compilers installed.
+
+The install script supports UNIX-like systems, including Linux, OS X, and most
+supercomputer and cluster environments. It is particularly suited for deployment
+in environments where users do not have root access and can only install
+software into their home directory.
+
+Since the install is fully-isolated in a single directory, if you get tired of
+having yt on your system, you can just delete the directory and yt and all of
+its dependencies will be removed from your system (no scattered files remaining
+throughout your system).
+
+Running the install script
+^^^^^^^^^^^^^^^^^^^^^^^^^^
To get the installation script, download it from:
.. code-block:: bash
- http://hg.yt-project.org/yt/raw/stable/doc/install_script.sh
+ wget http://hg.yt-project.org/yt/raw/stable/doc/install_script.sh
.. _installing-yt:
-Installing yt
--------------
-
-By default, the bash script will install an array of items, but there are
-additional packages that can be downloaded and installed (e.g. SciPy, enzo,
-etc.). The script has all of these options at the top of the file. You should
-be able to open it and edit it without any knowledge of bash syntax.
-To execute it, run:
+By default, the bash install script will install an array of items, but there
+are additional packages that can be downloaded and installed (e.g. SciPy, enzo,
+etc.). The script has all of these options at the top of the file. You should be
+able to open it and edit it without any knowledge of bash syntax. To execute
+it, run:
.. code-block:: bash
- $ bash install_script.sh
+ bash install_script.sh
Because the installer is downloading and building a variety of packages from
source, this will likely take a while (e.g. 20 minutes), but you will get
@@ -48,7 +199,7 @@
If you receive errors during this process, the installer will provide you
with a large amount of information to assist in debugging your problems. The
-file ``yt_install.log`` will contain all of the ``STDOUT`` and ``STDERR`` from
+file ``yt_install.log`` will contain all of the ``stdout`` and ``stderr`` from
the entire installation process, so it is usually quite cumbersome. By looking
at the last few hundred lines (i.e. ``tail -500 yt_install.log``), you can
potentially figure out what went wrong. If you have problems, though, do not
@@ -57,7 +208,7 @@
.. _activating-yt:
Activating Your Installation
-----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once the installation has completed, there will be instructions on how to set up
your shell environment to use yt by executing the activate script. You must
@@ -67,13 +218,13 @@
.. code-block:: bash
- $ source <yt installation directory>/bin/activate
+ source <yt installation directory>/bin/activate
If you use csh or tcsh as your shell, activate that version of the script:
.. code-block:: bash
- $ source <yt installation directory>/bin/activate.csh
+ source <yt installation directory>/bin/activate.csh
If you don't like executing outside scripts on your computer, you can set
the shell variables manually. ``YT_DEST`` needs to point to the root of the
@@ -82,6 +233,38 @@
will also need to set ``LD_LIBRARY_PATH`` and ``PYTHONPATH`` to contain
``$YT_DEST/lib`` and ``$YT_DEST/python2.7/site-packages``, respectively.
+.. _updating-yt:
+
+Updating yt and its dependencies
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+With many active developers, code development sometimes occurs at a furious
+pace in yt. To make sure you're using the latest version of the code, run
+this command at a command-line:
+
+.. code-block:: bash
+
+ yt update
+
+Additionally, if you want to make sure you have the latest dependencies
+associated with yt and update the codebase simultaneously, type this:
+
+.. code-block:: bash
+
+ yt update --all
+
+.. _removing-yt:
+
+Removing yt and its dependencies
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Because yt and its dependencies are installed in an isolated directory when
+you use the script installer, you can easily remove yt and all of its
+dependencies cleanly. Simply remove the install directory and its
+subdirectories and you're done. If you *really* had problems with the
+code, this is a last defense for solving: remove and then fully
+:ref:`re-install <installing-yt>` from the install script again.
+
.. _testing-installation:
Testing Your Installation
@@ -92,7 +275,7 @@
.. code-block:: bash
- $ yt --help
+ yt --help
If this works, you should get a list of the various command-line options for
yt, which means you have successfully installed yt. Congratulations!
@@ -102,112 +285,3 @@
figure it out.
If you like, this might be a good time :ref:`to run the test suite <testing>`.
-
-.. _updating-yt:
-
-Updating yt and its dependencies
---------------------------------
-
-With many active developers, code development sometimes occurs at a furious
-pace in yt. To make sure you're using the latest version of the code, run
-this command at a command-line:
-
-.. code-block:: bash
-
- $ yt update
-
-Additionally, if you want to make sure you have the latest dependencies
-associated with yt and update the codebase simultaneously, type this:
-
-.. code-block:: bash
-
- $ yt update --all
-
-.. _removing-yt:
-
-Removing yt and its dependencies
---------------------------------
-
-Because yt and its dependencies are installed in an isolated directory when
-you use the script installer, you can easily remove yt and all of its
-dependencies cleanly. Simply remove the install directory and its
-subdirectories and you're done. If you *really* had problems with the
-code, this is a last defense for solving: remove and then fully
-:ref:`re-install <installing-yt>` from the install script again.
-
-.. _alternative-installation:
-
-Alternative Installation Methods
---------------------------------
-
-.. _pip-installation:
-
-Installing yt Using pip or from Source
-++++++++++++++++++++++++++++++++++++++
-
-If you want to forego the use of the install script, you need to make sure you
-have yt's dependencies installed on your system. These include: a C compiler,
-``HDF5``, ``python``, ``cython``, ``NumPy``, ``matplotlib``, and ``h5py``. From here,
-you can use ``pip`` (which comes with ``Python``) to install yt as:
-
-.. code-block:: bash
-
- $ pip install yt
-
-The source code for yt may be found at the Bitbucket project site and can also be
-utilized for installation. If you prefer to use it instead of relying on external
-tools, you will need ``mercurial`` to clone the official repo:
-
-.. code-block:: bash
-
- $ hg clone https://bitbucket.org/yt_analysis/yt
- $ cd yt
- $ hg update yt
- $ python setup.py install --user
-
-It will install yt into ``$HOME/.local/lib64/python2.7/site-packages``.
-Please refer to ``setuptools`` documentation for the additional options.
-
-If you choose this installation method, you do not need to run the activation
-script as it is unnecessary.
-
-.. _anaconda-installation:
-
-Installing yt Using Anaconda
-++++++++++++++++++++++++++++
-
-Perhaps the quickest way to get yt up and running is to install it using the `Anaconda Python
-Distribution <https://store.continuum.io/cshop/anaconda/>`_, which will provide you with a
-easy-to-use environment for installing Python packages. To install a bare-bones Python
-installation with yt, first visit http://repo.continuum.io/miniconda/ and download a recent
-version of the ``Miniconda-x.y.z`` script (corresponding to Python 2.7) for your platform and
-system architecture. Next, run the script, e.g.:
-
-.. code-block:: bash
-
- $ bash Miniconda-3.3.0-Linux-x86_64.sh
-
-Make sure that the Anaconda ``bin`` directory is in your path, and then issue:
-
-.. code-block:: bash
-
- $ conda install yt
-
-which will install yt along with all of its dependencies.
-
-.. _windows-installation:
-
-Installing yt on Windows
-++++++++++++++++++++++++
-
-Installation on Microsoft Windows is only supported for Windows XP Service Pack 3 and
-higher (both 32-bit and 64-bit) using Anaconda.
-
-Keeping yt Updated via Mercurial
-++++++++++++++++++++++++++++++++
-
-If you want to maintain your yt installation via updates straight from the Bitbucket repository,
-or if you want to do some development on your own, we suggest you check out some of the
-:ref:`development docs <contributing-code>`, especially the sections on :ref:`Mercurial
-<mercurial-with-yt>` and :ref:`building yt from source <building-yt>`.
-
diff -r 58f37beaba3c763150dc4b1a83debafc5e8f63c8 -r 5a10dea0299bf9cf1587b4365fd8b73688636a8e doc/source/reference/faq/index.rst
--- a/doc/source/reference/faq/index.rst
+++ b/doc/source/reference/faq/index.rst
@@ -196,33 +196,10 @@
.. code-block:: bash
- cd $YT_DEST/src/yt-hg
+ cd $YT_HG
python setup.py develop
-
-Unresolved Installation Problem on OSX 10.6
--------------------------------------------
-When installing on some instances of OSX 10.6, a few users have noted a failure
-when yt tries to build with OpenMP support:
-
- Symbol not found: _GOMP_barrier
- Referenced from: <YT_DEST>/src/yt-hg/yt/utilities/lib/grid_traversal.so
-
- Expected in: dynamic lookup
-
-To resolve this, please make a symbolic link:
-
-.. code-block:: bash
-
- $ ln -s /usr/local/lib/x86_64 <YT_DEST>/lib64
-
-where ``<YT_DEST>`` is replaced by the path to the root of the directory
-containing the yt install, which will usually be ``yt-<arch>``. After doing so,
-you should be able to cd to <YT_DEST>/src/yt-hg and run:
-
-.. code-block:: bash
-
- $ python setup.py install
+where ``$YT_HG`` is the path to the yt mercurial repository.
.. _plugin-file:
Repository URL: https://bitbucket.org/yt_analysis/yt/
--
This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.
More information about the yt-svn
mailing list