[yt-svn] commit/yt: 2 new changesets
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Sun May 21 10:20:26 PDT 2017
2 new commits in yt:
https://bitbucket.org/yt_analysis/yt/commits/86379508bca8/
Changeset: 86379508bca8
User: ngoldbaum
Date: 2017-05-20 18:02:27+00:00
Summary: Update the docstring for the yt module. Closes #1362
Affected #: 1 file
diff -r 4409c8396c9ad1eafd15f08052aec9b2f2682a0a -r 86379508bca8212ae8cf3aed6b76e0c9207516aa yt/__init__.py
--- a/yt/__init__.py
+++ b/yt/__init__.py
@@ -1,66 +1,10 @@
"""
-YT is a package written primarily in Python designed to make the task of
-running Enzo easier. It contains facilities for creating Enzo data (currently
-in prototype form) as well as runnning Enzo simulations, simulating the actions
-of Enzo on various existing data, and analyzing output from Enzo in a
-wide-variety of methods.
-
-An ever-growing collection of documentation is also available at
-http://yt-project.org/doc/ . Additionally, there is a
-project site at http://yt-project.org/ with recipes, a wiki, a variety of
-ways of peering into the version control, and a bug-reporting system.
-
-YT is divided into several packages.
-
-frontends
----------
-
-This is where interfaces to codes are created. Within each subdirectory of
-yt/frontends/ there must exist the following files, even if empty:
-
-* data_structures.py, where subclasses of AMRGridPatch, Dataset and
- AMRHierarchy are defined.
-* io.py, where a subclass of IOHandler is 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.)
-
-visualization
--------------
+yt is a toolkit for analyzing and visualizing volumetric data.
-This is where all visualization modules are stored. This includes plot
-collections, the volume rendering interface, and pixelization frontends.
-
-data_objects
-------------
-
-All objects that handle data, processed or unprocessed, not explicitly
-defined as visualization are located in here. This includes the base
-classes for data regions, covering grids, time series, and so on. This
-also includes derived fields and derived quantities.
-
-analysis_modules
-----------------
-
-This is where all mechanisms for processing data live. This includes
-things like clump finding, halo profiling, halo finding, and so on. This
-is something of a catchall, but it serves as a level of greater
-abstraction that simply data selection and modification.
-
-gui
----
-
-This is where all GUI components go. Typically this will be some small
-tool used for one or two things, which contains a launching mechanism on
-the command line.
-
-utilities
----------
-
-All broadly useful code that doesn't clearly fit in one of the other
-categories goes here.
-
-
+* Website: http://yt-project.org
+* Documentation: http://yt-project.org/doc
+* Data hub: http://hub.yt
+* Contribute: http://github.com/yt-project/yt
"""
https://bitbucket.org/yt_analysis/yt/commits/3d4f5f4c12bf/
Changeset: 3d4f5f4c12bf
User: xarthisius
Date: 2017-05-21 17:20:10+00:00
Summary: Merge pull request #1415 from ngoldbaum/init-text
Update the docstring for the yt module. Closes #1362
Affected #: 1 file
diff -r 4409c8396c9ad1eafd15f08052aec9b2f2682a0a -r 3d4f5f4c12bffc69ef4ec1b5b57c399623885540 yt/__init__.py
--- a/yt/__init__.py
+++ b/yt/__init__.py
@@ -1,66 +1,10 @@
"""
-YT is a package written primarily in Python designed to make the task of
-running Enzo easier. It contains facilities for creating Enzo data (currently
-in prototype form) as well as runnning Enzo simulations, simulating the actions
-of Enzo on various existing data, and analyzing output from Enzo in a
-wide-variety of methods.
-
-An ever-growing collection of documentation is also available at
-http://yt-project.org/doc/ . Additionally, there is a
-project site at http://yt-project.org/ with recipes, a wiki, a variety of
-ways of peering into the version control, and a bug-reporting system.
-
-YT is divided into several packages.
-
-frontends
----------
-
-This is where interfaces to codes are created. Within each subdirectory of
-yt/frontends/ there must exist the following files, even if empty:
-
-* data_structures.py, where subclasses of AMRGridPatch, Dataset and
- AMRHierarchy are defined.
-* io.py, where a subclass of IOHandler is 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.)
-
-visualization
--------------
+yt is a toolkit for analyzing and visualizing volumetric data.
-This is where all visualization modules are stored. This includes plot
-collections, the volume rendering interface, and pixelization frontends.
-
-data_objects
-------------
-
-All objects that handle data, processed or unprocessed, not explicitly
-defined as visualization are located in here. This includes the base
-classes for data regions, covering grids, time series, and so on. This
-also includes derived fields and derived quantities.
-
-analysis_modules
-----------------
-
-This is where all mechanisms for processing data live. This includes
-things like clump finding, halo profiling, halo finding, and so on. This
-is something of a catchall, but it serves as a level of greater
-abstraction that simply data selection and modification.
-
-gui
----
-
-This is where all GUI components go. Typically this will be some small
-tool used for one or two things, which contains a launching mechanism on
-the command line.
-
-utilities
----------
-
-All broadly useful code that doesn't clearly fit in one of the other
-categories goes here.
-
-
+* Website: http://yt-project.org
+* Documentation: http://yt-project.org/doc
+* Data hub: http://hub.yt
+* Contribute: http://github.com/yt-project/yt
"""
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