[yt-svn] commit/yt: 5 new changesets
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Wed Jul 13 14:22:12 PDT 2016
5 new commits in yt:
https://bitbucket.org/yt_analysis/yt/commits/c7536173f2a9/
Changeset: c7536173f2a9
Branch: yt
User: MatthewTurk
Date: 2016-07-06 19:28:34+00:00
Summary: Initial draft of an extensions document
Affected #: 2 files
diff -r d7f213e1752e7db1bc4ae5b37c1b9acdaa080a48 -r c7536173f2a931fa57fdcec35e459c581dac71ca doc/source/developing/extensions.rst
--- /dev/null
+++ b/doc/source/developing/extensions.rst
@@ -0,0 +1,47 @@
+.. _extensions:
+
+Extension Packages
+==================
+
+.. note:: For some additional discussion, see :ref:`YTEP-0029
+ <http://ytep.readthedocs.io/en/latest/YTEPs/YTEP-0029.html>`_, where
+ this plan was designed.
+
+As of version 3.3 of yt, we have put into place new methods for easing the
+process of developing extensions to yt. We have created a few pieces of
+infrastructure for developing extensions, making them discoverable, and
+distributing them to collaborators.
+
+If you have a module you would like to retain some external control over, or
+that you don't feel would fit into yt, we encourage you to build it as an
+extension module and distribute and version it independently.
+
+Hooks for Extensions
+--------------------
+
+Starting with version 3.3 of yt, any packaged named with the prefix ``yt_`` is
+importable from the namespace ``yt.extensions``. For instance, the
+``yt_interaction`` package ( https://bitbucket.org/data-exp-lab/yt_interaction
+) is importable as ``yt.extensions.interaction``.
+
+In subsequent versions, we plan to include in yt a catalog of known extensions
+and where to find them; this will put discoverability directly into the code
+base.
+
+Extension Template
+------------------
+
+A template for starting an extension module (or converting an existing set of
+code to an extension module) can be found at
+https://bitbucket.org/yt_analysis/yt_extension_template .
+
+To get started, download a zipfile of the template (
+https://bitbucket.org/yt_analysis/yt_extension_template/get/tip.zip ) and
+follow the directions in ``README.md`` to modify the metadata.
+
+Distributing Extensions
+-----------------------
+
+We encourage you to version on your choice of hosting platform (Bitbucket,
+GitHub, etc), and to distribute your extension widely. We are presently
+working on deploying a method for listing extension modules on the yt webpage.
diff -r d7f213e1752e7db1bc4ae5b37c1b9acdaa080a48 -r c7536173f2a931fa57fdcec35e459c581dac71ca doc/source/developing/index.rst
--- a/doc/source/developing/index.rst
+++ b/doc/source/developing/index.rst
@@ -17,6 +17,7 @@
:maxdepth: 2
developing
+ extensions
building_the_docs
testing
debugdrive
https://bitbucket.org/yt_analysis/yt/commits/4c77abfa0830/
Changeset: 4c77abfa0830
Branch: yt
User: MatthewTurk
Date: 2016-07-13 18:24:18+00:00
Summary: moving this
Affected #: 1 file
diff -r c7536173f2a931fa57fdcec35e459c581dac71ca -r 4c77abfa08301627a8a4cc9e0f21efbc0331e31c doc/source/developing/index.rst
--- a/doc/source/developing/index.rst
+++ b/doc/source/developing/index.rst
@@ -17,9 +17,9 @@
:maxdepth: 2
developing
- extensions
building_the_docs
testing
+ extensions
debugdrive
releasing
creating_datatypes
https://bitbucket.org/yt_analysis/yt/commits/aa3042c13d2a/
Changeset: aa3042c13d2a
Branch: yt
User: MatthewTurk
Date: 2016-07-13 21:16:38+00:00
Summary: adding what an extension is
Affected #: 1 file
diff -r 4c77abfa08301627a8a4cc9e0f21efbc0331e31c -r aa3042c13d2ad3e653b2167abf35e728d31c8d14 doc/source/developing/extensions.rst
--- a/doc/source/developing/extensions.rst
+++ b/doc/source/developing/extensions.rst
@@ -8,9 +8,16 @@
this plan was designed.
As of version 3.3 of yt, we have put into place new methods for easing the
-process of developing extensions to yt. We have created a few pieces of
-infrastructure for developing extensions, making them discoverable, and
-distributing them to collaborators.
+process of developing "extensions" to yt. Extensions might be analysis
+packages, visualization tools, or other software projects that use yt as a base
+engine but that are versioned, developed and distributed separately. This
+brings with it the advantage of retaining control over the versioning,
+contribution guidelines, scope, etc, while also providing a mechanism for
+disseminating information about it, and potentially a method of interacting
+with other extensions.
+
+We have created a few pieces of infrastructure for developing extensions,
+making them discoverable, and distributing them to collaborators.
If you have a module you would like to retain some external control over, or
that you don't feel would fit into yt, we encourage you to build it as an
https://bitbucket.org/yt_analysis/yt/commits/b84a44570029/
Changeset: b84a44570029
Branch: yt
User: MatthewTurk
Date: 2016-07-13 21:20:44+00:00
Summary: Fixing typo
Affected #: 1 file
diff -r aa3042c13d2ad3e653b2167abf35e728d31c8d14 -r b84a44570029ebe6314517b7b128944df72e3ab3 doc/source/developing/extensions.rst
--- a/doc/source/developing/extensions.rst
+++ b/doc/source/developing/extensions.rst
@@ -26,7 +26,7 @@
Hooks for Extensions
--------------------
-Starting with version 3.3 of yt, any packaged named with the prefix ``yt_`` is
+Starting with version 3.3 of yt, any package named with the prefix ``yt_`` is
importable from the namespace ``yt.extensions``. For instance, the
``yt_interaction`` package ( https://bitbucket.org/data-exp-lab/yt_interaction
) is importable as ``yt.extensions.interaction``.
https://bitbucket.org/yt_analysis/yt/commits/1c339ea76199/
Changeset: 1c339ea76199
Branch: yt
User: ngoldbaum
Date: 2016-07-13 21:21:36+00:00
Summary: Merged in MatthewTurk/yt (pull request #2261)
An initial draft of an extensions document. Closes #1238.
Affected #: 2 files
diff -r 6a5dc7d9b000c8b128f7ba99e6a5cc9151b4dcfa -r 1c339ea7619997cba6842e973cf5f0e13b2f30ee doc/source/developing/extensions.rst
--- /dev/null
+++ b/doc/source/developing/extensions.rst
@@ -0,0 +1,54 @@
+.. _extensions:
+
+Extension Packages
+==================
+
+.. note:: For some additional discussion, see :ref:`YTEP-0029
+ <http://ytep.readthedocs.io/en/latest/YTEPs/YTEP-0029.html>`_, where
+ this plan was designed.
+
+As of version 3.3 of yt, we have put into place new methods for easing the
+process of developing "extensions" to yt. Extensions might be analysis
+packages, visualization tools, or other software projects that use yt as a base
+engine but that are versioned, developed and distributed separately. This
+brings with it the advantage of retaining control over the versioning,
+contribution guidelines, scope, etc, while also providing a mechanism for
+disseminating information about it, and potentially a method of interacting
+with other extensions.
+
+We have created a few pieces of infrastructure for developing extensions,
+making them discoverable, and distributing them to collaborators.
+
+If you have a module you would like to retain some external control over, or
+that you don't feel would fit into yt, we encourage you to build it as an
+extension module and distribute and version it independently.
+
+Hooks for Extensions
+--------------------
+
+Starting with version 3.3 of yt, any package named with the prefix ``yt_`` is
+importable from the namespace ``yt.extensions``. For instance, the
+``yt_interaction`` package ( https://bitbucket.org/data-exp-lab/yt_interaction
+) is importable as ``yt.extensions.interaction``.
+
+In subsequent versions, we plan to include in yt a catalog of known extensions
+and where to find them; this will put discoverability directly into the code
+base.
+
+Extension Template
+------------------
+
+A template for starting an extension module (or converting an existing set of
+code to an extension module) can be found at
+https://bitbucket.org/yt_analysis/yt_extension_template .
+
+To get started, download a zipfile of the template (
+https://bitbucket.org/yt_analysis/yt_extension_template/get/tip.zip ) and
+follow the directions in ``README.md`` to modify the metadata.
+
+Distributing Extensions
+-----------------------
+
+We encourage you to version on your choice of hosting platform (Bitbucket,
+GitHub, etc), and to distribute your extension widely. We are presently
+working on deploying a method for listing extension modules on the yt webpage.
diff -r 6a5dc7d9b000c8b128f7ba99e6a5cc9151b4dcfa -r 1c339ea7619997cba6842e973cf5f0e13b2f30ee doc/source/developing/index.rst
--- a/doc/source/developing/index.rst
+++ b/doc/source/developing/index.rst
@@ -19,6 +19,7 @@
developing
building_the_docs
testing
+ extensions
debugdrive
releasing
creating_datatypes
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