[yt-svn] commit/yt: 4 new changesets
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Mon Jul 28 10:53:13 PDT 2014
4 new commits in yt:
https://bitbucket.org/yt_analysis/yt/commits/12fab09b2e5a/
Changeset: 12fab09b2e5a
Branch: yt-3.0
User: ngoldbaum
Date: 2014-07-28 01:19:38
Summary: Rearranging the installation instructions.
Affected #: 1 file
diff -r a9d2f11690ed2d212d498a769733158fb893ceab -r 12fab09b2e5a7475c35442678764bbfce12ec68a doc/source/installing.rst
--- a/doc/source/installing.rst
+++ b/doc/source/installing.rst
@@ -11,6 +11,19 @@
In this document we describe several methods for installing yt. The method that
will work best for you depends on your precise situation:
+* 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.
+
+* 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 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
@@ -21,136 +34,6 @@
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
@@ -265,6 +148,123 @@
code, this is a last defense for solving: remove and then fully
:ref:`re-install <installing-yt>` from the install script again.
+.. _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.
+
+.. _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 --user
+
+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.
+
.. _testing-installation:
Testing Your Installation
https://bitbucket.org/yt_analysis/yt/commits/8e78516d25ca/
Changeset: 8e78516d25ca
Branch: yt-3.0
User: ngoldbaum
Date: 2014-07-28 01:39:06
Summary: Clarifying the source installation instructions.
Affected #: 1 file
diff -r 12fab09b2e5a7475c35442678764bbfce12ec68a -r 8e78516d25caf133b4367dbf458912e25d333517 doc/source/installing.rst
--- a/doc/source/installing.rst
+++ b/doc/source/installing.rst
@@ -230,8 +230,22 @@
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.
+.. note::
+
+ If you maintain your own python installation separate from the OS-level python
+ installation, you can leave off ``--user --prefix=``, although you might need
+ ``sudo`` depending on where python is installed. See _`This StackOverflow
+ discussion
+ <http://stackoverflow.com/questions/4495120/combine-user-with-prefix-error-with-setup-py-install>`
+ if you are curious why ``--prefix=`` is neccessary on systems.
+
+This will install yt into a folder in your home directory
+(``$HOME/.local/lib64/python2.7/site-packages`` on Linux,
+``$HOME/Library/Python/2.7/lib/python/site-packages/`` on OSX) Please refer to
+the ``setuptools`` documentation for the additional options.
+
+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.
If you will be modifying yt, you can also make the clone of the yt mercurial
repository the "active" installed copy:
@@ -243,8 +257,9 @@
hg update yt
python setup.py develop --user
-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.
+As above, you can leave off ``--user`` if you want to install yt into the default
+package install path. If you do not have write access for this location, you
+might need to use ``sudo``.
Keeping yt Updated via Mercurial
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
https://bitbucket.org/yt_analysis/yt/commits/7ec65fc9ced1/
Changeset: 7ec65fc9ced1
Branch: yt-3.0
User: ngoldbaum
Date: 2014-07-28 19:10:33
Summary: Fixing a syntax error. Adding instructions on how to switch to 2.x.
Affected #: 3 files
diff -r 8e78516d25caf133b4367dbf458912e25d333517 -r 7ec65fc9ced16b12aa69b7d72eb1157a953b42a6 doc/source/help/index.rst
--- a/doc/source/help/index.rst
+++ b/doc/source/help/index.rst
@@ -141,7 +141,7 @@
* Identify which version of the code you’re using.
- * ``$ yt instinfo`` - provides version information, including changeset hash
+ * ``$ yt version`` - provides version information, including changeset hash
It may be that through the mere process of doing this, you end up solving
the problem!
diff -r 8e78516d25caf133b4367dbf458912e25d333517 -r 7ec65fc9ced16b12aa69b7d72eb1157a953b42a6 doc/source/installing.rst
--- a/doc/source/installing.rst
+++ b/doc/source/installing.rst
@@ -250,7 +250,7 @@
If you will be modifying yt, you can also make the clone of the yt mercurial
repository the "active" installed copy:
-..code-block:: bash
+.. code-block:: bash
hg clone https://bitbucket.org/yt_analysis/yt
cd yt
@@ -261,6 +261,36 @@
package install path. If you do not have write access for this location, you
might need to use ``sudo``.
+Switching to yt 2.x
+^^^^^^^^^^^^^^^^^^^
+
+With the release of version 3.0 of yt, development of the legacy yt 2.x series
+has been relegated to bugfixes. That said, we will continue supporting the 2.x
+series for the forseeable future. This makes it easy to use scripts written
+for older versions of yt without substantially updating them to support the
+new field naming or unit systems in yt version 3.
+
+Currently, the yt-2.x codebase is contained in a named branch in the yt
+mercurial repository. First, remove any extant installations of yt on your
+system:
+
+.. code-block:: bash
+
+ pip uninstall yt
+
+To switch to yt-2.x, you will need to clone the mercurial repository as
+described in :ref:`source-installation`. Next, you will need to navigate to the
+mercurial repository, update to the `yt-2.x` branch, and recompile:
+
+.. code-block:: bash
+
+ cd yt
+ hg update yt-2.x
+ python setup.py develop --user
+
+You can check which version of yt you have installed by invoking ``yt version``
+at the command line.
+
Keeping yt Updated via Mercurial
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff -r 8e78516d25caf133b4367dbf458912e25d333517 -r 7ec65fc9ced16b12aa69b7d72eb1157a953b42a6 doc/source/reference/command-line.rst
--- a/doc/source/reference/command-line.rst
+++ b/doc/source/reference/command-line.rst
@@ -64,7 +64,8 @@
(http://hub.yt-project.org/), creating a BitBucket
repo in the process if necessary.
instinfo Get some information about the yt installation
- version Get some information about the yt installation
+ version Get some information about the yt installation (this
+ is an alias for instinfo).
load Load a single dataset into an IPython instance
pastebin Post a script to an anonymous pastebin
pastebin_grab Print an online pastebin to STDOUT for local use.
https://bitbucket.org/yt_analysis/yt/commits/e88c775e9b28/
Changeset: e88c775e9b28
Branch: yt-3.0
User: mzingale
Date: 2014-07-28 19:53:07
Summary: Merged in ngoldbaum/yt/yt-3.0 (pull request #1083)
Installation instruction clarifications
Affected #: 3 files
diff -r c36140fca4f278969ce6a8e3c4ccca1a6bb509bb -r e88c775e9b28a70ec2cfe9af5abf9b4ea7caae56 doc/source/help/index.rst
--- a/doc/source/help/index.rst
+++ b/doc/source/help/index.rst
@@ -141,7 +141,7 @@
* Identify which version of the code you’re using.
- * ``$ yt instinfo`` - provides version information, including changeset hash
+ * ``$ yt version`` - provides version information, including changeset hash
It may be that through the mere process of doing this, you end up solving
the problem!
diff -r c36140fca4f278969ce6a8e3c4ccca1a6bb509bb -r e88c775e9b28a70ec2cfe9af5abf9b4ea7caae56 doc/source/installing.rst
--- a/doc/source/installing.rst
+++ b/doc/source/installing.rst
@@ -11,6 +11,19 @@
In this document we describe several methods for installing yt. The method that
will work best for you depends on your precise situation:
+* 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.
+
+* 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 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
@@ -21,136 +34,6 @@
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
@@ -265,6 +148,168 @@
code, this is a last defense for solving: remove and then fully
:ref:`re-install <installing-yt>` from the install script again.
+.. _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.
+
+.. _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
+
+.. note::
+
+ If you maintain your own python installation separate from the OS-level python
+ installation, you can leave off ``--user --prefix=``, although you might need
+ ``sudo`` depending on where python is installed. See _`This StackOverflow
+ discussion
+ <http://stackoverflow.com/questions/4495120/combine-user-with-prefix-error-with-setup-py-install>`
+ if you are curious why ``--prefix=`` is neccessary on systems.
+
+This will install yt into a folder in your home directory
+(``$HOME/.local/lib64/python2.7/site-packages`` on Linux,
+``$HOME/Library/Python/2.7/lib/python/site-packages/`` on OSX) Please refer to
+the ``setuptools`` documentation for the additional options.
+
+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.
+
+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 --user
+
+As above, you can leave off ``--user`` if you want to install yt into the default
+package install path. If you do not have write access for this location, you
+might need to use ``sudo``.
+
+Switching to yt 2.x
+^^^^^^^^^^^^^^^^^^^
+
+With the release of version 3.0 of yt, development of the legacy yt 2.x series
+has been relegated to bugfixes. That said, we will continue supporting the 2.x
+series for the forseeable future. This makes it easy to use scripts written
+for older versions of yt without substantially updating them to support the
+new field naming or unit systems in yt version 3.
+
+Currently, the yt-2.x codebase is contained in a named branch in the yt
+mercurial repository. First, remove any extant installations of yt on your
+system:
+
+.. code-block:: bash
+
+ pip uninstall yt
+
+To switch to yt-2.x, you will need to clone the mercurial repository as
+described in :ref:`source-installation`. Next, you will need to navigate to the
+mercurial repository, update to the `yt-2.x` branch, and recompile:
+
+.. code-block:: bash
+
+ cd yt
+ hg update yt-2.x
+ python setup.py develop --user
+
+You can check which version of yt you have installed by invoking ``yt version``
+at the command line.
+
+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.
+
.. _testing-installation:
Testing Your Installation
diff -r c36140fca4f278969ce6a8e3c4ccca1a6bb509bb -r e88c775e9b28a70ec2cfe9af5abf9b4ea7caae56 doc/source/reference/command-line.rst
--- a/doc/source/reference/command-line.rst
+++ b/doc/source/reference/command-line.rst
@@ -64,7 +64,8 @@
(http://hub.yt-project.org/), creating a BitBucket
repo in the process if necessary.
instinfo Get some information about the yt installation
- version Get some information about the yt installation
+ version Get some information about the yt installation (this
+ is an alias for instinfo).
load Load a single dataset into an IPython instance
pastebin Post a script to an anonymous pastebin
pastebin_grab Print an online pastebin to STDOUT for local use.
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