@@ -5,9 +5,7 @@ Updated Data Model
55==================
66
77The goal of this document is to describe developer-specific changes
8- that should drive the next phase of development. The contents
9- reflect changes that will be introduced between release
10- :ref: `v0.9.3 ` and the next major release of ``0.10.0 ``.
8+ that should drive the next phase of development.
119
1210Goals and non-goals
1311===================
@@ -36,8 +34,12 @@ Separation of readers and containers
3634
3735Objects that store information from Serpent files should be separated from
3836objects that read Serpent files. Much of this is inspired by :issue: `335 `,
39- and will help 1) reduce left-over code and methods related to reading files, and
40- 2) support integration with other file formats. Classes that store the file data
37+ and will help
38+
39+ 1. Reduce left-over code and methods related to reading files, and
40+ 2. Support integration with other file formats.
41+
42+ Classes that store the file data
4143will be designated as ``<X>File `` like ``ResultFile ``, while classes that read
4244file data will be designated as ``<X>Reader ``, e.g. ``ResultReader ``.
4345
@@ -58,7 +60,7 @@ and trying to plot before calling ``read``.
5860
5961This has an additional benefit of allowing additional class methods for creating
6062files from alternative data types. A ``fromHdf `` method would be extra wonderful.
61- But, new file formats are not the intended goal of version `` 0.10.0 `` .
63+ But, new file formats are not the intended goal this effort .
6264
6365Reusable readers
6466----------------
@@ -173,12 +175,8 @@ branch. This will hopefully reduce the amount of features to be
173175back-ported into the new library.
174176
175177When the ``next `` module is complete and ready for release, a beta
176- release of the form ``0.10.0b0 `` should be made and pushed to the
177- Python package index. Users should be alerted through appropriate
178- channels.
179-
180- After this point, a new main release on the ``0.9.x ``
181- tree should be made. Users should be alerted to changes, primarily in
178+ release should be made and pushed to the Python package index.
179+ Users should be alerted to changes, primarily in
182180:func: `serpentTools.read ` and the settings interface. These are likely
183181to have the largest changes to non-developer end-users.
184182
@@ -189,8 +187,8 @@ like a good low end target.
189187If/when sufficient bugs are found and fixed, a new beta release should
190188be made and pushed.
191189
192- Once the beta period is complete, a release candidate, `` 0.10.0rc0 ``
193- or similar, should be made and pushed. Users should be alerted through
190+ Once the beta period is complete, a release candidate
191+ should be made and pushed. Users should be alerted through
194192appropriate channels. This release candidate should be live for a
195193reasonable amount of time.
196194
@@ -199,10 +197,10 @@ should be made and pushed.
199197
200198Work should be done to merge the ``next `` module as the main parsing and
201199analysis library. This is the primary goal of the following major release
202- `` 0.11.0 ``, following a similar beta and release candidate period.
203- The new features should still exist inside `` 0.11.0 `` in the
200+ following a similar beta and release candidate period.
201+ The new features should still exist inside the
204202``serpentTools.next `` module, but users and developers should be alerted
205203that these features will be removed, favoring importing from the main
206204``serpentTools `` API.
207205
208- Version `` 0.12.0 `` will fully remove the ``serpentTools.next `` module.
206+ A final major release will fully remove the ``serpentTools.next `` module.
0 commit comments