Merge pull request #107 from brittonsmith/release

Updates for 3.0 release

CREDITS

@@ -3,3 +3,5 @@ ytree is a team effort.  Join the team!
 Contributors:
                 Britton Smith ([email protected])
                 Meagan Lang ([email protected])
+                Manodeep Sinha ([email protected])
+                Matthew Turk ([email protected])

README.md

@@ -65,10 +65,9 @@ pip install -e .
 
 ## Getting Started
 
-Below is a notebook that demonstrates how to use `ytree` with merger tree data.  For
-more information, see the full [ytree documentation](https://ytree.readthedocs.io).
-
- * [Introduction](https://github.com/ytree-project/ytree/blob/main/doc/source/notebooks/Intro_to_ytree.ipynb)
+The [ytree documentation](https://ytree.readthedocs.io) will walk you
+through installation, get you started analyzing merger trees, and help
+you become a contributor to the project. Have a look!
 
 ## Sample Data
 

doc/source/changelog.rst

@@ -13,6 +13,135 @@ The `CREDITS file
 contains the most up-to-date list of everyone who has contributed to the
 ``ytree`` source code.
 
+Version 3.0
+-----------
+
+Release date: *August 3, 2021*
+
+New Featues
+^^^^^^^^^^^
+
+ * Halo selection and generation with yt data objects
+   (`PR #82 <https://github.com/ytree-project/ytree/pull/82>`__)
+
+ * Add frontends for consistent-trees hlist and locations.dat files
+   (`PR #48 <https://github.com/ytree-project/ytree/pull/48>`__)
+
+ * Add consistent-trees HDF5 frontend
+   (`PR #53 <https://github.com/ytree-project/ytree/pull/53>`__)
+
+ * Add LHaloTree_hdf5 frontend
+   (`PR #81 <https://github.com/ytree-project/ytree/pull/81>`__)
+
+ * Add TreeFrog frontend
+   (PR `#103 <https://github.com/ytree-project/ytree/pull/103>`__,
+   `#95 <https://github.com/ytree-project/ytree/pull/95>`__,
+   `#88 <https://github.com/ytree-project/ytree/pull/88>`__)
+
+ * Add Moria frontend
+   (`PR #84 <https://github.com/ytree-project/ytree/pull/84>`__)
+
+ * Add get_node and get_leaf_nodes functions
+   (`PR #80 <https://github.com/ytree-project/ytree/pull/80>`__)
+
+ * Add get_root_nodes function
+   (`PR #91 <https://github.com/ytree-project/ytree/pull/91>`__)
+
+ * Add add_vector_field function
+   (`PR #71 <https://github.com/ytree-project/ytree/pull/71>`__)
+
+ * Add plot customization
+   (`PR #49 <https://github.com/ytree-project/ytree/pull/49>`__)
+
+Enhancements
+^^^^^^^^^^^^
+
+ * All functions returning TreeNodes now return generators for a
+   significant speed and memory usage improvement.
+   (PR `#104 <https://github.com/ytree-project/ytree/pull/104>`__,
+   `#64 <https://github.com/ytree-project/ytree/pull/64>`__,
+   `#61 <https://github.com/ytree-project/ytree/pull/61>`__)
+
+ * Speed and usability improvements to select_halos function
+   (PR `#83 <https://github.com/ytree-project/ytree/pull/83>`__,
+   `#72 <https://github.com/ytree-project/ytree/pull/72>`__)
+
+ * Add parallel analysis docs
+   (`PR #106 <https://github.com/ytree-project/ytree/pull/106>`__)
+
+ * Make field_data an public facing attribute.
+   (`PR #105 <https://github.com/ytree-project/ytree/pull/105>`__)
+
+ * Improved sorting for node_io_loop in ctrees_group and ctrees_hdf5
+   (`PR #87 <https://github.com/ytree-project/ytree/pull/87>`__)
+
+ * Relax requirements on cosmological parameters and add load options
+   for AHF frontend
+   (`PR #76 <https://github.com/ytree-project/ytree/pull/76>`__)
+
+ * Speed and usability updates to save_arbor function
+   (PR `#68 <https://github.com/ytree-project/ytree/pull/68>`__,
+   `#58 <https://github.com/ytree-project/ytree/pull/58>`__)
+
+ * Various infrastructure updates for newer versions of Python and
+   dependencies
+   (PR `#92 <https://github.com/ytree-project/ytree/pull/92>`__,
+   `#78 <https://github.com/ytree-project/ytree/pull/78>`__,
+   `#75 <https://github.com/ytree-project/ytree/pull/75>`__,
+   `#60 <https://github.com/ytree-project/ytree/pull/60>`__,
+   `#54 <https://github.com/ytree-project/ytree/pull/54>`__,
+   `#45 <https://github.com/ytree-project/ytree/pull/45>`__)
+
+ * Update frontend development docs
+   (`PR #69 <https://github.com/ytree-project/ytree/pull/69>`__)
+
+ * CI updates
+   (PR `#101 <https://github.com/ytree-project/ytree/pull/101>`__,
+   `#96 <https://github.com/ytree-project/ytree/pull/96>`__,
+   `#94 <https://github.com/ytree-project/ytree/pull/94>`__,
+   `#93 <https://github.com/ytree-project/ytree/pull/93>`__,
+   `#86 <https://github.com/ytree-project/ytree/pull/86>`__,
+   `#79 <https://github.com/ytree-project/ytree/pull/79>`__,
+   `#74 <https://github.com/ytree-project/ytree/pull/74>`__,
+   `#73 <https://github.com/ytree-project/ytree/pull/73>`__)
+   `#63 <https://github.com/ytree-project/ytree/pull/63>`__,
+   `#55 <https://github.com/ytree-project/ytree/pull/55>`__,
+   `#51 <https://github.com/ytree-project/ytree/pull/51>`__,
+   `#50 <https://github.com/ytree-project/ytree/pull/50>`__,
+   `#43 <https://github.com/ytree-project/ytree/pull/43>`__,
+   `#42 <https://github.com/ytree-project/ytree/pull/42>`__)
+
+ * Remove support for ytree-1.x outputs
+   (`PR #62 <https://github.com/ytree-project/ytree/pull/62>`__)
+
+ * Drop support for python 3.5
+   (`PR #59 <https://github.com/ytree-project/ytree/pull/59>`__)
+
+ * Drop support for Python 2
+   (`PR #41 <https://github.com/ytree-project/ytree/pull/41>`__)
+
+Bugfixes
+^^^^^^^^
+
+ * Use file sizes of loaded arbor when only saving analysis fields.
+   (`PR #100 <https://github.com/ytree-project/ytree/pull/100>`__)
+
+ * Use regex for more robust filename check.
+   (PR `#77 <https://github.com/ytree-project/ytree/pull/77>`__,
+   `#47 <https://github.com/ytree-project/ytree/pull/47>`__)
+
+ * Fix issue with saving full arbor
+   (`PR #70 <https://github.com/ytree-project/ytree/pull/70>`__)
+
+ * Check if attr is bytes or string.
+   (`PR #57 <https://github.com/ytree-project/ytree/pull/57>`__)
+
+ * Fix arg in error message.
+   (`PR #56 <https://github.com/ytree-project/ytree/pull/56>`__)
+
+ * Account for empty ctrees files in data files list
+   (`PR #52 <https://github.com/ytree-project/ytree/pull/52>`__)
+
 Version 2.3
 -----------
 

doc/source/conf.py

@@ -66,9 +66,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'3.0.dev5'
+version = u'3.0.0'
 # The full version, including alpha/beta/rc tags.
-release = u'3.0.dev5'
+release = u'3.0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

ytree/__init__.py

@@ -21,4 +21,4 @@
 from ytree.visualization.tree_plot import \
     TreePlot
 
-__version__ = '3.0.dev5'
+__version__ = '3.0.0'