Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renaming the hafnian library to The Walrus #34

Merged
merged 7 commits into from
Aug 7, 2019
Merged

Renaming the hafnian library to The Walrus #34

merged 7 commits into from
Aug 7, 2019

Conversation

josh146
Copy link
Member

@josh146 josh146 commented Aug 1, 2019

Description of the Change:

This PR makes the following changes:

  • Renames the Python library to 'The Walrus', and updates all according docstrings, imports, tests, and documentation.

  • Renames the C++ header library to libwalrus, and updates the namespace, filenames, tests, and makefiles.

  • Moves the C++ source code from src to include, to better reflect the convention for a header only library

  • Moves the C++ tests into their own top level folder (tests)

  • Since we now only have one library .so file, I have removed the hafnian/lib subfolder, and now the library is available at thewalrus/libwalrus.so. As a result, the import paths have become simpler:

    from hafnian.lib.libhaf import haf_real

    is now

    from thewalrus.libwalrus import haf_real

Benefits: Simplifies the library structure

Possible Drawbacks: n/a

Related GitHub Issues: n/a

@josh146 josh146 requested review from nquesada and bgupt August 1, 2019 07:35
@codecov
Copy link

codecov bot commented Aug 1, 2019

Codecov Report

Merging #34 into master will not change coverage.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master      #34   +/-   ##
=======================================
  Coverage   95.21%   95.21%           
=======================================
  Files           9        9           
  Lines         627      627           
=======================================
  Hits          597      597           
  Misses         30       30
Impacted Files Coverage Δ
thewalrus/reference.py 98.73% <ø> (ø)
thewalrus/__init__.py 100% <ø> (ø)
thewalrus/_version.py 100% <ø> (ø)
thewalrus/samples.py 85.35% <ø> (ø)
thewalrus/quantum.py 97.82% <ø> (ø)
thewalrus/_hafnian.py 100% <100%> (ø)
thewalrus/_hermite_multidimensional.py 98% <100%> (ø)
thewalrus/_torontonian.py 100% <100%> (ø)
thewalrus/_permanent.py 100% <100%> (ø)

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 bd4982c...1552ede. Read the comment docs.

@josh146 josh146 merged commit 3fd9c78 into master Aug 7, 2019
@josh146 josh146 deleted the renaming branch August 7, 2019 05:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants