0.4.3 release #11

utensil · 2019-02-14T06:40:11Z

This is a work-in-progress for the release of 0.4.3 which is discussed in #10 and https://github.com/brombo/galgebra/pull/42#issuecomment-462263950 .

This PR includes the following:

Cherry-picked bug fixes in Convert doc to nbsphinx #9 but leave the document work out ( because I'm not sure about the process how I convert and fix the documentation, too manual and hacky )
Version Bump
- the version bumps to 0.4.3
- specify that galgebra now supports Python 3 ( see merged [READY] Merge brombo/galgebra#15 #2 )
- update README.md to reflect the changes to installation and testing process ( see merged [READY]Add coverage in CI #8 )

… on ga

codecov · 2019-02-14T06:43:53Z

Codecov Report

Merging #11 into master will increase coverage by 8.89%.
The diff coverage is 62.22%.

@@            Coverage Diff             @@
##           master      #11      +/-   ##
==========================================
+ Coverage      40%   48.89%   +8.89%     
==========================================
  Files           7        8       +1     
  Lines        4959     4947      -12     
==========================================
+ Hits         1984     2419     +435     
+ Misses       2975     2528     -447

Impacted Files	Coverage Δ
galgebra/__init__.py	`100% <100%> (ø)`
galgebra/ga.py	`64.81% <100%> (+2.05%)`	⬆️
galgebra/printer.py	`41.22% <50%> (+10.92%)`	⬆️
galgebra/metric.py	`57.44% <50%> (+2.97%)`	⬆️
galgebra/mv.py	`50% <52.63%> (+12.92%)`	⬆️
galgebra/lt.py	`22.22% <66.66%> (+11.14%)`	⬆️
galgebra/utils.py	`62.5% <85.71%> (+17.04%)`	⬆️
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 21ed56d...78efe65. Read the comment docs.

utensil · 2019-02-14T08:59:21Z

@hugohadfield @arsenovic The release of 0.4.3 is ready for review, thanks.

utensil · 2019-02-14T09:02:42Z

.travis.yml

+
+script:
+  # Run tests, validate Jupyter notebooks and generate coverage report
+  - pytest --cov=galgebra --nbval examples/ipython/ --nbval doc/ipython/ --nbval doc/python/ --current-env test


Tests covers more forms of tests and collects the coverage stat data in one go.

utensil · 2019-02-14T09:05:35Z

doc/python/BACCAB.py

+from __future__ import absolute_import, division
+from __future__ import print_function
+from galgebra.printer import Format, xpdf
+from galgebra.ga import Ga


If the users install galgebra from pip, the way of importing the modules has to conform to the standard "namespaced" way instead of just importing modules from a global namespace. This might break some old code but it's a necessary transition process.

utensil · 2019-02-14T09:08:34Z

galgebra/ga.py

        u = kargs[0]  # Coordinate map or vector embedding to define submanifold
        coords = kargs[1]  # List of cordinates
        ga = kwargs['ga']  # base geometric algebra
-        self.wedge_print = kwargs['wedge']


This line was clearly a copy-paste bug and this self.wedge_print turns out to be not used and useless for this class.

utensil · 2019-02-14T09:10:12Z

galgebra/metric.py

        else:
            for (coef, base) in zip(coefs, bases):
-                obj += modes(coef) * base
+                obj += Simp.modes(coef) * base


An example of using non-existent non-namespaced method.

utensil · 2019-02-14T09:11:36Z

galgebra/metric.py

-            for (coef, base) in zip(coefs, bases):
-                obj += modes(coef) * base
-        mv.obj = obj
+        mv.obj = Simp.apply(mv.obj)


The code was repetitive, so calls the method with exactly the same semantic instead.

utensil · 2019-02-14T09:13:43Z

galgebra/metric.py

                    g_lst = []
                    g_inv_lst = []
-                    for coord1 in self.coords:
-                        i1 = str(coord2)


Incorrect local variable naming, probably just a copy-paste bug. It was not covered in previous tests so it was not detected. Now it's covered and passed.

great, its really nice the tests are running well

utensil · 2019-02-14T09:14:07Z

galgebra/mv.py

            return A > B
        else:
-            raise ValeError('Operation ' + op + 'not allowed in Mv.Mul!')
+            raise ValueError('Operation ' + op + 'not allowed in Mv.Mul!')


A typo bug.

utensil · 2019-02-14T09:15:06Z

galgebra/mv.py

        elif isinstance(sdop, tuple):
            self.term.append(sdop)
-            self = Dfop.consolidate_coefs(self)
+            self = Sdop.consolidate_coefs(self)


Use the correct version of consolidate_coefs method.

utensil · 2019-02-14T09:16:59Z

galgebra/mv.py


            if dop1.cmpflg != dop2.cmpflg:
-                raise ValueError('In Dop.Add complement flags have different values.')
+                raise ValueError('In Dop.Add complement flags have different values: %s vs. %s' % (dop1.cmpflg, dop2.cmpflg))


cmpflg still has some potential bugs. This is to make the exception to have proper context.

utensil · 2019-02-14T09:17:29Z

galgebra/mv.py

                    else:
                        if self.cmpflg:
-                            s += str_dop + '*' + str_base
+                            s += str_sdop + '*' + str_base


Also a local variable name typo

utensil · 2019-02-14T09:17:57Z

galgebra/mv.py

 def com(A, B):
-    return ga.Ga.com(A, B)
+    raise ImportError(
+        """mv.com is removed, please use ga.Ga.com(A, B) instead.""")


Added a deprecation error.

utensil · 2019-02-14T09:19:07Z

galgebra/printer.py

-\\DeclareMathOperator{\Adj}{Adj}
+"""
+$\\DeclareMathOperator{\\Tr}{Tr}
+\\DeclareMathOperator{\\Adj}{Adj}


Many backslashes are not properly escaped, caused some warnings and now fixed.

utensil · 2019-02-14T09:19:31Z

setup.py

 from distutils.core import Extension

-VERSION = '0.4.1.1'
+VERSION = '0.4.3'


The version bump.

utensil · 2019-02-14T09:19:59Z

setup.py

            'Natural Language :: English',
            'Operating System :: OS Independent',
            'Programming Language :: Python :: 2.7',
+            'Programming Language :: Python :: 3',


Py3 support. 🎆

utensil · 2019-02-14T09:21:53Z

README.md

-Get compatible with python 3
-
-Get Travis set up with some good tests
-


These 2 TODOs are done. 😄

hugohadfield

It looks like a load of nice work bringing this library back to life

hugohadfield · 2019-02-15T14:23:37Z

@utensil what is your pypi username? I think it makes sense to add you as an owner on https://pypi.org/manage/project/galgebra/

utensil · 2019-02-18T01:36:46Z

@utensil what is your pypi username? I think it makes sense to add you as an owner on https://pypi.org/manage/project/galgebra/

It's https://pypi.org/user/utensil/ , thanks~

utensil · 2019-02-18T01:39:18Z

@hugohadfield Thanks for the review, I'll merge now, would you please release it to the PyPI?

utensil added 11 commits February 14, 2019 14:22

Add tests in Jupyter notebooks to coverage

a3b5758

Add ImportError for mv.com since it's broken after mv stops depending…

a179957

… on ga

Fix str types

27743b0

Start fixing doc/python

d8b8012

Fix ReciprocalBasis.py

7085dbe

Fix or mark problems in doc/python

37e78ba

Misc fixes

0f26536

Print S(0) as 0

6f72e46

Clean up BACCAB.py and verify Dirac.py

a018c14

Add doc/python/ to nbval

0c0a982

sympy is not compatible with unicode literals under py2, see issue 8312

0bbe5e2

utensil added the state:work_in_progress label Feb 14, 2019

utensil added 2 commits February 14, 2019 16:11

Bump version to 0.4.3 and add py3 support to setup.py spec

1fd0093

Add instructions to install from PyPI and remove outdated contents

78efe65

utensil added state:reviewing and removed state:work_in_progress labels Feb 14, 2019

utensil requested review from arsenovic and hugohadfield February 14, 2019 08:58

utensil commented Feb 14, 2019

View reviewed changes

setup.py

from distutils.core import Extension

VERSION = '0.4.1.1'

VERSION = '0.4.3'

Copy link

Member Author

utensil Feb 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The version bump.

utensil commented Feb 14, 2019

View reviewed changes

hugohadfield approved these changes Feb 15, 2019

View reviewed changes

utensil merged commit 22d8abe into master Feb 18, 2019

utensil removed the state:reviewing label Feb 18, 2019

utensil mentioned this pull request Feb 22, 2019

Convert doc to nbsphinx #9

Merged

27 tasks

utensil deleted the 0.4.3-release branch February 25, 2019 12:30

		Get compatible with python 3

		Get Travis set up with some good tests

0.4.3 release #11

0.4.3 release #11

Uh oh!

Conversation

utensil commented Feb 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Feb 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

utensil commented Feb 14, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

utensil Feb 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

utensil Feb 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hugohadfield left a comment

Choose a reason for hiding this comment

Uh oh!

hugohadfield commented Feb 15, 2019

Uh oh!

utensil commented Feb 18, 2019

Uh oh!

utensil commented Feb 18, 2019

Uh oh!

Uh oh!

utensil commented Feb 14, 2019 •

edited

Loading

codecov bot commented Feb 14, 2019 •

edited

Loading

utensil Feb 14, 2019 •

edited

Loading

utensil Feb 14, 2019 •

edited

Loading