[yt-svn] commit/yt-doc: 6 new changesets
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Wed Nov 6 07:17:54 PST 2013
6 new commits in yt-doc:
https://bitbucket.org/yt_analysis/yt-doc/commits/bafce8464c27/
Changeset: bafce8464c27
User: ngoldbaum
Date: 2013-11-06 05:09:54
Summary: Updating some out of date links in the intro section of the development docs.
Affected #: 1 file
diff -r 53e9fd3ef9ae3089c0322d2220fdb0c27eca7bb1 -r bafce8464c2768c760ac3d369fb71da6171bbe5b source/developing/intro.rst
--- a/source/developing/intro.rst
+++ b/source/developing/intro.rst
@@ -90,11 +90,10 @@
-------------------------
If you have an image or video you'd like to display in the image or video
-galleries, getting it included it easy! For the image, you can either fork the
-`yt homepage repository <http://bitbucket.org/MatthewTurk/yt-homepage>`_ and
-add it there, or email it to us and we'll add it to the `Image Gallery
-<http://hg.yt-project.org/yt/wiki/ImageGallery>`_. If you have a video, just
-add it to the `yt Vimeo group <http://vimeo.com/groups/ytgallery>`_.
+galleries, getting it included it easy! You can either fork the `yt homepage
+repository <http://bitbucket.org/yt_analysis/website>`_ and add it there, or
+email it to us and we'll add it to the `Gallery
+<http://yt-project.org/gallery.html>`_.
We're eager to show off the images you make with yt, so please feel free to
drop `us <http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org>`_ a
https://bitbucket.org/yt_analysis/yt-doc/commits/34c5aab3876e/
Changeset: 34c5aab3876e
User: ngoldbaum
Date: 2013-11-06 05:14:07
Summary: Fixed a bad link in the frontend docs. Added a note about 3.0.
Affected #: 1 file
diff -r bafce8464c2768c760ac3d369fb71da6171bbe5b -r 34c5aab3876e7bc6ee0f9e33e4444ea7d2d07e76 source/developing/creating_frontend.rst
--- a/source/developing/creating_frontend.rst
+++ b/source/developing/creating_frontend.rst
@@ -3,10 +3,18 @@
Creating A New Code Frontend
============================
+.. note::
+
+ The material in this section will be significantly revised with the release
+ of yt 3.0. If you would like to write a new frontend, consider sending a
+ message to the mailing list so you can find out the latest about frontends in
+ yt 3.0.
+
``yt`` is designed to support analysis and visualization of data from multiple
different simulation codes, although it has so far been most successfully
applied to Adaptive Mesh Refinement (AMR) data. For a list of codes and the
-level of support they enjoy, we've created a handy [[CodeSupportLevels|table]].
+level of support they enjoy, see :ref:`code-support`.
+
We'd like to support a broad range of codes, both AMR-based and otherwise. To
add support for a new code, a few things need to be put into place. These
necessary structures can be classified into a couple categories:
https://bitbucket.org/yt_analysis/yt-doc/commits/8bad8b2a98d5/
Changeset: 8bad8b2a98d5
User: ngoldbaum
Date: 2013-11-06 05:20:09
Summary: Small updates for the coding guide.
Affected #: 1 file
diff -r 34c5aab3876e7bc6ee0f9e33e4444ea7d2d07e76 -r 8bad8b2a98d5bbd78dd3dcc005a505b1445d7856 source/developing/developing.rst
--- a/source/developing/developing.rst
+++ b/source/developing/developing.rst
@@ -374,7 +374,7 @@
* Do not use nested classes unless you have a very good reason to, such as
requiring a namespace or class-definition modification. Classes should live
at the top level. ``__metaclass__`` is exempt from this.
- * Do not use unnecessary parenthesis in conditionals. ``if((something) and
+ * Do not use unnecessary parentheses in conditionals. ``if((something) and
(something_else))`` should be rewritten as ``if something and
something_else``. Python is more forgiving than C.
* Avoid copying memory when possible. For example, don't do ``a =
@@ -391,10 +391,9 @@
* Do not import "*" from anything other than ``yt.funcs``.
* Internally, only import from source files directly; instead of: ``from
- yt.visualization.api import PlotCollection`` do
- ``from yt.visualization.plot_collection import PlotCollection``.
- * Numpy is to be imported as ``na`` not ``np``. While this may change in the
- future, for now this is the correct idiom.
+ yt.visualization.api import SlicePlot`` do
+ ``from yt.visualization.plot_window import SlicePlot``.
+ * Numpy is to be imported as ``np``.
* Do not use too many keyword arguments. If you have a lot of keyword
arguments, then you are doing too much in ``__init__`` and not enough via
parameter setting.
https://bitbucket.org/yt_analysis/yt-doc/commits/7a697573c7d9/
Changeset: 7a697573c7d9
User: ngoldbaum
Date: 2013-11-06 05:25:18
Summary: Updates for the testing docs.
Affected #: 1 file
diff -r 8bad8b2a98d5bbd78dd3dcc005a505b1445d7856 -r 7a697573c7d995e38f0a4507403944733edd3f50 source/developing/testing.rst
--- a/source/developing/testing.rst
+++ b/source/developing/testing.rst
@@ -19,7 +19,9 @@
The testing suite should be run locally by developers to make sure they aren't
checking in any code that breaks existing functionality. To further this goal,
an automatic buildbot runs the test suite after each code commit to confirm
-that yt hasn't broken recently.
+that yt hasn't broken recently. To supplement this effort, we also maintain a
+`continuous integration server <http://tests.yt-project.org>`_ that runs the
+tests with each commit to the yt version control repository.
.. _unit_testing:
@@ -146,7 +148,7 @@
directory with the test data you want to compare. Here is an example
config file:
-.. code-block:: bash
+.. code-block::
[yt]
test_data_dir = /Users/tomservo/src/yt-data
@@ -294,13 +296,3 @@
To upload answers, you **must** have the package boto installed, and you
**must** have an Amazon key provided by Matt. Contact Matt for these keys.
-
-What Needs to be Done
-^^^^^^^^^^^^^^^^^^^^^
-
- * Many of the old answer tests need to be converted. This includes tests
- for halos, volume renderings, data object access, and profiles. These
- will require taking the old tests and converting them over, but this
- process should be straightforward.
- * We need to have data for all supported codes. We currently test Enzo, FLASH,
- Orion, and Chombo.
https://bitbucket.org/yt_analysis/yt-doc/commits/7459720f9f1b/
Changeset: 7459720f9f1b
User: ngoldbaum
Date: 2013-11-06 05:34:27
Summary: Fixing a sphinx directive syntax error.
Affected #: 1 file
diff -r 7a697573c7d995e38f0a4507403944733edd3f50 -r 7459720f9f1b8a1d8eec7a1b88bf397e36527f50 source/developing/testing.rst
--- a/source/developing/testing.rst
+++ b/source/developing/testing.rst
@@ -148,7 +148,7 @@
directory with the test data you want to compare. Here is an example
config file:
-.. code-block::
+.. code-block:: none
[yt]
test_data_dir = /Users/tomservo/src/yt-data
https://bitbucket.org/yt_analysis/yt-doc/commits/d0bdc67d7bb6/
Changeset: d0bdc67d7bb6
User: MatthewTurk
Date: 2013-11-06 16:17:53
Summary: Merged in ngoldbaum/yt-doc (pull request #115)
Updating the development docs
Affected #: 4 files
diff -r 42f94049fb5d2a8f22d00915ae24e7a4d9f644fa -r d0bdc67d7bb611d5ca1b613df642a6b6b85c41cb source/developing/creating_frontend.rst
--- a/source/developing/creating_frontend.rst
+++ b/source/developing/creating_frontend.rst
@@ -3,10 +3,18 @@
Creating A New Code Frontend
============================
+.. note::
+
+ The material in this section will be significantly revised with the release
+ of yt 3.0. If you would like to write a new frontend, consider sending a
+ message to the mailing list so you can find out the latest about frontends in
+ yt 3.0.
+
``yt`` is designed to support analysis and visualization of data from multiple
different simulation codes, although it has so far been most successfully
applied to Adaptive Mesh Refinement (AMR) data. For a list of codes and the
-level of support they enjoy, we've created a handy [[CodeSupportLevels|table]].
+level of support they enjoy, see :ref:`code-support`.
+
We'd like to support a broad range of codes, both AMR-based and otherwise. To
add support for a new code, a few things need to be put into place. These
necessary structures can be classified into a couple categories:
diff -r 42f94049fb5d2a8f22d00915ae24e7a4d9f644fa -r d0bdc67d7bb611d5ca1b613df642a6b6b85c41cb source/developing/developing.rst
--- a/source/developing/developing.rst
+++ b/source/developing/developing.rst
@@ -374,7 +374,7 @@
* Do not use nested classes unless you have a very good reason to, such as
requiring a namespace or class-definition modification. Classes should live
at the top level. ``__metaclass__`` is exempt from this.
- * Do not use unnecessary parenthesis in conditionals. ``if((something) and
+ * Do not use unnecessary parentheses in conditionals. ``if((something) and
(something_else))`` should be rewritten as ``if something and
something_else``. Python is more forgiving than C.
* Avoid copying memory when possible. For example, don't do ``a =
@@ -391,10 +391,9 @@
* Do not import "*" from anything other than ``yt.funcs``.
* Internally, only import from source files directly; instead of: ``from
- yt.visualization.api import PlotCollection`` do
- ``from yt.visualization.plot_collection import PlotCollection``.
- * Numpy is to be imported as ``na`` not ``np``. While this may change in the
- future, for now this is the correct idiom.
+ yt.visualization.api import SlicePlot`` do
+ ``from yt.visualization.plot_window import SlicePlot``.
+ * Numpy is to be imported as ``np``.
* Do not use too many keyword arguments. If you have a lot of keyword
arguments, then you are doing too much in ``__init__`` and not enough via
parameter setting.
diff -r 42f94049fb5d2a8f22d00915ae24e7a4d9f644fa -r d0bdc67d7bb611d5ca1b613df642a6b6b85c41cb source/developing/intro.rst
--- a/source/developing/intro.rst
+++ b/source/developing/intro.rst
@@ -90,11 +90,10 @@
-------------------------
If you have an image or video you'd like to display in the image or video
-galleries, getting it included it easy! For the image, you can either fork the
-`yt homepage repository <http://bitbucket.org/MatthewTurk/yt-homepage>`_ and
-add it there, or email it to us and we'll add it to the `Image Gallery
-<http://hg.yt-project.org/yt/wiki/ImageGallery>`_. If you have a video, just
-add it to the `yt Vimeo group <http://vimeo.com/groups/ytgallery>`_.
+galleries, getting it included it easy! You can either fork the `yt homepage
+repository <http://bitbucket.org/yt_analysis/website>`_ and add it there, or
+email it to us and we'll add it to the `Gallery
+<http://yt-project.org/gallery.html>`_.
We're eager to show off the images you make with yt, so please feel free to
drop `us <http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org>`_ a
diff -r 42f94049fb5d2a8f22d00915ae24e7a4d9f644fa -r d0bdc67d7bb611d5ca1b613df642a6b6b85c41cb source/developing/testing.rst
--- a/source/developing/testing.rst
+++ b/source/developing/testing.rst
@@ -19,7 +19,9 @@
The testing suite should be run locally by developers to make sure they aren't
checking in any code that breaks existing functionality. To further this goal,
an automatic buildbot runs the test suite after each code commit to confirm
-that yt hasn't broken recently.
+that yt hasn't broken recently. To supplement this effort, we also maintain a
+`continuous integration server <http://tests.yt-project.org>`_ that runs the
+tests with each commit to the yt version control repository.
.. _unit_testing:
@@ -146,7 +148,7 @@
directory with the test data you want to compare. Here is an example
config file:
-.. code-block:: bash
+.. code-block:: none
[yt]
test_data_dir = /Users/tomservo/src/yt-data
@@ -294,13 +296,3 @@
To upload answers, you **must** have the package boto installed, and you
**must** have an Amazon key provided by Matt. Contact Matt for these keys.
-
-What Needs to be Done
-^^^^^^^^^^^^^^^^^^^^^
-
- * Many of the old answer tests need to be converted. This includes tests
- for halos, volume renderings, data object access, and profiles. These
- will require taking the old tests and converting them over, but this
- process should be straightforward.
- * We need to have data for all supported codes. We currently test Enzo, FLASH,
- Orion, and Chombo.
Repository URL: https://bitbucket.org/yt_analysis/yt-doc/
--
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