[yt-svn] commit/yt: 2 new changesets
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Thu Jul 9 09:49:01 PDT 2015
2 new commits in yt:
https://bitbucket.org/yt_analysis/yt/commits/a2ea1ed5e650/
Changeset: a2ea1ed5e650
Branch: yt
User: chummels
Date: 2015-07-05 15:35:38+00:00
Summary: Updating the install docs to reflect the differences between the branches and how to install them.
Affected #: 2 files
diff -r 4d383ff42e245a683b65a87e648cc7276e927a04 -r a2ea1ed5e650836e1c7b08158a96586d32c48f76 doc/README
--- a/doc/README
+++ b/doc/README
@@ -7,4 +7,4 @@
Because the documentation requires a number of dependencies, we provide
pre-built versions online, accessible here:
-http://yt-project.org/docs/dev-3.0/
+http://yt-project.org/docs/dev/
diff -r 4d383ff42e245a683b65a87e648cc7276e927a04 -r a2ea1ed5e650836e1c7b08158a96586d32c48f76 doc/source/installing.rst
--- a/doc/source/installing.rst
+++ b/doc/source/installing.rst
@@ -39,6 +39,28 @@
have the the necessary compilers installed (e.g. the ``build-essentials``
package on debian and ubuntu).
+.. _branches-of-yt:
+
+Branches of yt: ``yt``, ``stable``, and ``yt-2.x``
+++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Before you install yt, you must decide which branch (i.e. version) of the code
+you prefer to use:
+
+* ``yt`` -- The most up-to-date *development* version with the most current features but sometimes unstable (yt-3.x)
+* ``stable`` -- The latest stable release of yt-3.x
+* ``yt-2.x`` -- The latest stable release of yt-2.x
+
+If this is your first time using the code, we recommend using ``stable``,
+unless you specifically need some piece of brand-new functionality only
+available in ``yt`` or need to run an old script developed for ``yt-2.x``.
+There were major API and functionality changes made in yt after version 2.7
+in moving to version 3.0. For a detailed description of the changes
+between versions 2.x (e.g. branch ``yt-2.x``) and 3.x (e.g. branches ``yt`` and
+``stable``) see :ref:`yt3differences`. Lastly, don't feel like you're locked
+into one branch when you install yt, because you can easily change the active
+branch by following the instructions in :ref:`switching-between-yt-versions`.
+
.. _install-script:
All-in-One Installation Script
@@ -60,16 +82,22 @@
its dependencies will be removed from your system (no scattered files remaining
throughout your system).
+.. _installing-yt:
+
Running the Install Script
^^^^^^^^^^^^^^^^^^^^^^^^^^
-To get the installation script, download it from:
+To get the installation script for the ``stable`` branch of the code,
+download it from:
.. code-block:: bash
wget http://bitbucket.org/yt_analysis/yt/raw/stable/doc/install_script.sh
-.. _installing-yt:
+If you wish to install a different version of yt (see
+:ref:`above <branches-of-yt>`), replace ``stable`` with the appropriate
+branch name (e.g. ``yt``, ``yt-2.x``) in the path above to get the correct
+install script.
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,
@@ -329,8 +357,8 @@
.. _switching-between-yt-versions:
-Switching between yt-2.x and yt-3.x
------------------------------------
+Switching versions of yt: yt-2.x, yt-3.x, stable, and dev
+---------------------------------------------------------
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
@@ -356,12 +384,8 @@
hg update <desired-version>
python setup.py develop
-Valid versions to jump to are:
+Valid versions to jump to are described in :ref:`branches-of-yt`).
-* ``yt`` -- The latest *dev* changes in yt-3.x (can be unstable)
-* ``stable`` -- The latest stable release of yt-3.x
-* ``yt-2.x`` -- The latest stable release of yt-2.x
-
You can check which version of yt you have installed by invoking ``yt version``
at the command line. If you encounter problems, see :ref:`update-errors`.
@@ -387,11 +411,7 @@
hg update <desired-version>
python setup.py install --user --prefix=
-Valid versions to jump to are:
-
-* ``yt`` -- The latest *dev* changes in yt-3.x (can be unstable)
-* ``stable`` -- The latest stable release of yt-3.x
-* ``yt-2.x`` -- The latest stable release of yt-2.x
+Valid versions to jump to are described in :ref:`branches-of-yt`).
You can check which version of yt you have installed by invoking ``yt version``
at the command line. If you encounter problems, see :ref:`update-errors`.
https://bitbucket.org/yt_analysis/yt/commits/8e7a932ed5cf/
Changeset: 8e7a932ed5cf
Branch: yt
User: MatthewTurk
Date: 2015-07-09 16:48:53+00:00
Summary: Merged in chummels/yt (pull request #1627)
Updating the install docs to reflect the differences between the branches and how to install them.
Affected #: 2 files
diff -r 832060c8ef256adf8a22bac6f60f8de418d4541e -r 8e7a932ed5cf0b086e38e9527f125b6e47e760a6 doc/README
--- a/doc/README
+++ b/doc/README
@@ -7,4 +7,4 @@
Because the documentation requires a number of dependencies, we provide
pre-built versions online, accessible here:
-http://yt-project.org/docs/dev-3.0/
+http://yt-project.org/docs/dev/
diff -r 832060c8ef256adf8a22bac6f60f8de418d4541e -r 8e7a932ed5cf0b086e38e9527f125b6e47e760a6 doc/source/installing.rst
--- a/doc/source/installing.rst
+++ b/doc/source/installing.rst
@@ -39,6 +39,28 @@
have the the necessary compilers installed (e.g. the ``build-essentials``
package on debian and ubuntu).
+.. _branches-of-yt:
+
+Branches of yt: ``yt``, ``stable``, and ``yt-2.x``
+++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Before you install yt, you must decide which branch (i.e. version) of the code
+you prefer to use:
+
+* ``yt`` -- The most up-to-date *development* version with the most current features but sometimes unstable (yt-3.x)
+* ``stable`` -- The latest stable release of yt-3.x
+* ``yt-2.x`` -- The latest stable release of yt-2.x
+
+If this is your first time using the code, we recommend using ``stable``,
+unless you specifically need some piece of brand-new functionality only
+available in ``yt`` or need to run an old script developed for ``yt-2.x``.
+There were major API and functionality changes made in yt after version 2.7
+in moving to version 3.0. For a detailed description of the changes
+between versions 2.x (e.g. branch ``yt-2.x``) and 3.x (e.g. branches ``yt`` and
+``stable``) see :ref:`yt3differences`. Lastly, don't feel like you're locked
+into one branch when you install yt, because you can easily change the active
+branch by following the instructions in :ref:`switching-between-yt-versions`.
+
.. _install-script:
All-in-One Installation Script
@@ -60,16 +82,22 @@
its dependencies will be removed from your system (no scattered files remaining
throughout your system).
+.. _installing-yt:
+
Running the Install Script
^^^^^^^^^^^^^^^^^^^^^^^^^^
-To get the installation script, download it from:
+To get the installation script for the ``stable`` branch of the code,
+download it from:
.. code-block:: bash
wget http://bitbucket.org/yt_analysis/yt/raw/stable/doc/install_script.sh
-.. _installing-yt:
+If you wish to install a different version of yt (see
+:ref:`above <branches-of-yt>`), replace ``stable`` with the appropriate
+branch name (e.g. ``yt``, ``yt-2.x``) in the path above to get the correct
+install script.
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,
@@ -329,8 +357,8 @@
.. _switching-between-yt-versions:
-Switching between yt-2.x and yt-3.x
------------------------------------
+Switching versions of yt: yt-2.x, yt-3.x, stable, and dev
+---------------------------------------------------------
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
@@ -356,12 +384,8 @@
hg update <desired-version>
python setup.py develop
-Valid versions to jump to are:
+Valid versions to jump to are described in :ref:`branches-of-yt`).
-* ``yt`` -- The latest *dev* changes in yt-3.x (can be unstable)
-* ``stable`` -- The latest stable release of yt-3.x
-* ``yt-2.x`` -- The latest stable release of yt-2.x
-
You can check which version of yt you have installed by invoking ``yt version``
at the command line. If you encounter problems, see :ref:`update-errors`.
@@ -387,11 +411,7 @@
hg update <desired-version>
python setup.py install --user --prefix=
-Valid versions to jump to are:
-
-* ``yt`` -- The latest *dev* changes in yt-3.x (can be unstable)
-* ``stable`` -- The latest stable release of yt-3.x
-* ``yt-2.x`` -- The latest stable release of yt-2.x
+Valid versions to jump to are described in :ref:`branches-of-yt`).
You can check which version of yt you have installed by invoking ``yt version``
at the command line. If you encounter problems, see :ref:`update-errors`.
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