Switch to src layout

[SeanBryan51]

Currently we are not testing the installed version of the package in our CI workflow. This is one of the major disadvantages in using a flat layout. This change switches the source code to use a src layout and reproduces the error described in #267 (see logs).

This pull request should be merged once #272 is merged so that we can verify the CI passes.

Fixes #270

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.81%. Comparing base (ac2cb1f) to head (59910ed).
Report is 8 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #271      +/-   ##
==========================================
+ Coverage   63.84%   72.81%   +8.96%     
==========================================
  Files          35       18      -17     
  Lines        2597      982    -1615     
==========================================
- Hits         1658      715     -943     
+ Misses        939      267     -672     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[abhaasgoyal]

Wouldn't the actual src files clash with the current folders created by runs of benchcab (this could further be a problem when we run benchcab clean).

└── src
    ├── benchcab <- Work on this PR
    ├── <realisation-0>
    └── <realisation-1>

For example , running benchcab clean would delete benchcab as well. Also, I believe src is holding folders for 2 different things here.

[SeanBryan51]

@abhaasgoyal I think you might be confusing the benchcab source with bench_example. The src directory you mentioned is only generated when running benchcab and will not contain the benchcab source files.

[abhaasgoyal]

Oh yeah, my mistake.. Looks good to me! (I ran the integration tests as well)

[SeanBryan51]

I've noticed the code coverage reports seem to differ when I have hardly changed the source code or the unit tests. Looking into this now.

[SeanBryan51]

@abhaasgoyal I've made some new changes regarding the unit test coverage reports as coverage reports do not seem to be properly generated unless we run pytest against an editable install of benchcab. I've also restricted the coverage to measure only the source files under the src directory as files like versioneer.py were getting picked up by the coverage report.

Also please hit approve once you are happy with the changes.

[abhaasgoyal]

LGTM