Skip to content

Commit

Permalink
REL: update new features for release (#871)
Browse files Browse the repository at this point in the history
* Update changelog since 3.4.2.1

* Replace archaic link to matforge

* Remove questions from changelog

* Remove unmerged PRs from changelog

   Integration branches and other experiments should never
   have changed master
  • Loading branch information
guyer authored Jun 15, 2022
1 parent 85120fd commit ab69def
Show file tree
Hide file tree
Showing 4 changed files with 129 additions and 7 deletions.
4 changes: 4 additions & 0 deletions .en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ GRICAD
Guyer
gzip
gzipped
gzips
Halperin
Hamadani
Hangarter
Expand Down Expand Up @@ -238,6 +239,7 @@ overpotential
O'Beirne
parallelization
parallelize
parallelizing
Patankar
PBICGSTAB
PCG
Expand All @@ -251,6 +253,7 @@ PETSc
photovoltaics
PID
pipelines.yml
plugin
PNG
POSIX
pre-assembled
Expand All @@ -275,6 +278,7 @@ reconstrain
redeclare
refactor
refactoring
refactors
repo
reST
Rhie-Chow
Expand Down
110 changes: 110 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,116 @@ Change Log
Version |release|
-----------------

This maintenance release adds a new example contributed by
`@Jon83Carvalho <https://github.com/Jon83Carvalho>`_,
clarifies many points in the documentation,
migrates all :ref:`CONTINUOUSINTEGRATION` to
`Azure <https://dev.azure.com>`_,
updates to using
`wheels <https://packaging.python.org/en/latest/specifications/binary-distribution-format/>`_
for distribution,
and substantially refactors matrices to work more consistently across
solvers.

Pulls
-----

- Update CI documentation to refer only to Azure
(`#863 <https://github.com/usnistgov/fipy/pull/863>`_)
- Refine azure runs
(`#851 <https://github.com/usnistgov/fipy/pull/851>`_)
- Debug CIs
(`#848 <https://github.com/usnistgov/fipy/pull/848>`_)
- Collect contact information on single page
(`#847 <https://github.com/usnistgov/fipy/pull/847>`_)
- Set up CI with Azure Pipelines
(`#822 <https://github.com/usnistgov/fipy/pull/822>`_)
- Replace deprecated numpy types
(`#798 <https://github.com/usnistgov/fipy/pull/798>`_)
- Move trilinos tests to Py3k
(`#797 <https://github.com/usnistgov/fipy/pull/797>`_)
- Fix Python 2.7 conda environment
(`#795 <https://github.com/usnistgov/fipy/pull/795>`_)
- fix: stop divide by zero warning in LU solvers
(`#790 <https://github.com/usnistgov/fipy/pull/790>`_)
- Introduce `SharedTemporaryFile` (bis)
(`#769 <https://github.com/usnistgov/fipy/pull/769>`_)
- Raise `ImportError` before trying to unpack solvers
(`#768 <https://github.com/usnistgov/fipy/pull/768>`_)
- Disable TVTK tests if its prerequisites aren't met
(`#764 <https://github.com/usnistgov/fipy/pull/764>`_)
- Tabulate versions of FiPy dependencies when tests are run
(`#763 <https://github.com/usnistgov/fipy/pull/763>`_)
- Debug CI failures
(`#749 <https://github.com/usnistgov/fipy/pull/749>`_)
- Stokes Cavity - non-Newtonian
(`#748 <https://github.com/usnistgov/fipy/pull/748>`_)
Thanks to `@Jon83Carvalho <https://github.com/Jon83Carvalho>`_.
- Refactor matrices
(`#721 <https://github.com/usnistgov/fipy/pull/721>`_)

Fixes
-----

- `#862 <https://github.com/usnistgov/fipy/issues/862>`_:
Could not load the Qt platform plugin "`xcb`"
- `#858 <https://github.com/usnistgov/fipy/issues/858>`_:
CI issues
- `#856 <https://github.com/usnistgov/fipy/issues/856>`_:
`FaceVariable` does not accumulate properly in parallel
- `#850 <https://github.com/usnistgov/fipy/issues/850>`_:
Switch to wheels
- `#849 <https://github.com/usnistgov/fipy/issues/849>`_:
`linux-py27-pysparse` fails
- `#841 <https://github.com/usnistgov/fipy/issues/841>`_:
`Matplotlib2DViewer` should accept color map as string
- `#836 <https://github.com/usnistgov/fipy/issues/836>`_:
Document that coupled and high-order diffusion terms are
incompatible
- `#833 <https://github.com/usnistgov/fipy/issues/833>`_:
`fipy.tools.dump` undocumented that it always gzips
- `#828 <https://github.com/usnistgov/fipy/issues/828>`_:
`colorbar=True` no longer works Stokes flow example
- `#826 <https://github.com/usnistgov/fipy/issues/826>`_:
Gmsh load issue
- `#818 <https://github.com/usnistgov/fipy/issues/818>`_:
Document that `GridND` meshes are always Cartesian
- `#811 <https://github.com/usnistgov/fipy/issues/811>`_:
In python 3.9 __repr__ throws an exception with abs
- `#801 <https://github.com/usnistgov/fipy/issues/801>`_:
CircleCI test-36-trilinos-serial extremely slow
- `#800 <https://github.com/usnistgov/fipy/issues/800>`_:
CircleCI conda2_env is really slow and ends up installing FiPy 3.3
- `#796 <https://github.com/usnistgov/fipy/issues/796>`_:
`examples.phase.polyxtal` freezes on CircleCI with Py3k and scipy
solvers
- `#792 <https://github.com/usnistgov/fipy/issues/792>`_:
`circleQuad` example fails with Gmsh > 4.4
- `#781 <https://github.com/usnistgov/fipy/issues/781>`_:
`MatplolibViewer.axes` property is not documented
- `#778 <https://github.com/usnistgov/fipy/issues/778>`_:
Binder failed build
- `#762 <https://github.com/usnistgov/fipy/issues/762>`_:
Equations on Website don't show right
- `#742 <https://github.com/usnistgov/fipy/issues/742>`_:
No documentation for `Variable.mag`
- `#735 <https://github.com/usnistgov/fipy/issues/735>`_:
`pip install fipy` fails
- `#734 <https://github.com/usnistgov/fipy/issues/734>`_:
Document the residual
- `#688 <https://github.com/usnistgov/fipy/issues/688>`_:
try-except not needed for circle Viewer
- `#676 <https://github.com/usnistgov/fipy/issues/676>`_:
Default no-flux condition is not explicitly stated
- `#609 <https://github.com/usnistgov/fipy/issues/609>`_:
Parallelizing of Gmsh meshes not clearly documented
- `#400 <https://github.com/usnistgov/fipy/issues/400>`_:
Fix `FaceVariable.globalValue` method

----------------------------
Version 3.4.2.1 - 2020-08-01
----------------------------

This release fixes assorted viewer issues, fixes a problem with convection
boundary conditions, and introduces spherical meshes.

Expand Down
19 changes: 14 additions & 5 deletions _setup/changelog.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,7 @@ def _printReST(self, issues, label):
print()

for i, issue in issues.iterrows():
# distutils does something disgusting with encodings
# we have to strip out unicode or we get errors
print(issue.ReST.encode("ascii", errors="replace"))
print(issue.ReST)

def _getMilestone(self, milestone):
"""Return Milestone with title of `milestone`
Expand Down Expand Up @@ -116,6 +114,14 @@ def _getDateFromTagOrSHA(self, tagOrSHA):

return date

def read_pull(self, x):
if x['pull_request'] is None:
result = (False, None)
else:
pull = self.repo.get_pull(x.number)
result = (pull.merged, pull.merged_at)
return result

def format_pull(self, x):
prefix = "- "
hang = " " * len(prefix)
Expand Down Expand Up @@ -187,7 +193,8 @@ def run(self):
issues = issues.sort_values(by=["number"], ascending=[False])
wontfix = issues.labels.apply(lambda x: 'wontfix' in x)
invalid = issues.labels.apply(lambda x: 'invalid' in x)
issues = issues[~wontfix & ~invalid]
question = issues.labels.apply(lambda x: 'question' in x)
issues = issues[~wontfix & ~invalid & ~question]

# fix the dates to reflect dates from original Trac issue tracker
trac = (r" _Imported from trac ticket .*, "
Expand All @@ -207,9 +214,11 @@ def run(self):
ispull = issues['pull_request'].notna()
isissue = ~ispull

issues['merged'], issues['merged_at'] = zip(*issues.apply(self.read_pull, axis=1))

issues.loc[ispull, 'ReST'] = issues.apply(self.format_pull, axis=1)

issues.loc[isissue, 'ReST'] = issues.apply(self.format_issue, axis=1)

self._printReST(issues[ispull], "Pulls")
self._printReST(issues[ispull & issues['merged']], "Pulls")
self._printReST(issues[isissue], "Fixes")
3 changes: 1 addition & 2 deletions documentation/USAGE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,8 @@ are not installed, :term:`FiPy` will warn something like::
Although the test suite may show warnings, there should be no other errors.
Any errors should be investigated or reported on the `issue tracker`_.
Users can see if there are any known problems for the latest :term:`FiPy`
distribution by checking `FiPy's automated test display`_.
distribution by checking :term:`FiPy`'s :ref:`CONTINUOUSINTEGRATION` dashboard.

.. _FiPy's automated test display: http://build.cmi.kent.edu:8010/console
.. _issue tracker: https://github.com/usnistgov/fipy/issues/new

Below are a number of common `Command-line Flags`_ for testing various
Expand Down

0 comments on commit ab69def

Please sign in to comment.