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

MAINT, DEP: Restructure the various qmflows sub packages #293

Merged
merged 12 commits into from
Apr 12, 2022
Merged

Conversation

BvB93
Copy link
Collaborator

@BvB93 BvB93 commented Apr 11, 2022

This PR restructures the various qmflows sub-modules.

This includes the following changes:

  • Flattening of the packages, parsers and templates sub-packages; see below for the new (public) structure:
qmflows
├── packages
├── parsers
│   ├── adf
│   ├── cp2k
│   ├── orca
│   ├── utils
├── templates
├── examples
  • Removal of the qmflows.settings module; the Settings class should be imported from the main qmflows namespace.
  • Renaming the qmflows.parsers.cp2k.cp2KBasisParser function to cp2k_basis_parser.
  • Removal of the registry, load_properties, SerMolecule and SerSettings functions from the qmflows.packages namespace.
  • Moving the example_freqs, example_H2O2_TS, example_generic_constraints and example_partial_geometry_opt functions from qmflows to the qmflows.examples namespace.

Note

For the sake of backwards compatiblity all affected functions and modules are still accessible under their old name, accompanied by a DeprecationWarning. This will change at some point in the future though.

@BvB93 BvB93 force-pushed the restructure branch 5 times, most recently from 0f47a6d to f8398c6 Compare April 12, 2022 13:17
@codecov
Copy link

codecov bot commented Apr 12, 2022

Codecov Report

Merging #293 (5c8097e) into master (ba532c9) will decrease coverage by 36.88%.
The diff coverage is 46.00%.

@@             Coverage Diff             @@
##           master     #293       +/-   ##
===========================================
- Coverage   81.54%   44.66%   -36.89%     
===========================================
  Files          42       59       +17     
  Lines        2265     2492      +227     
  Branches      379      417       +38     
===========================================
- Hits         1847     1113      -734     
- Misses        318     1291      +973     
+ Partials      100       88       -12     
Impacted Files Coverage Δ
src/qmflows/__init__.py 0.00% <0.00%> (-100.00%) ⬇️
src/qmflows/_version.py 0.00% <ø> (ø)
src/qmflows/_version_info.py 0.00% <0.00%> (ø)
src/qmflows/components/operations.py 23.07% <0.00%> (-53.85%) ⬇️
src/qmflows/components/reactivity.py 31.81% <0.00%> (-53.04%) ⬇️
src/qmflows/cp2k_utils.py 62.56% <0.00%> (-27.81%) ⬇️
src/qmflows/examples/_deprecations.py 0.00% <0.00%> (ø)
src/qmflows/fileFunctions.py 26.66% <0.00%> (-73.34%) ⬇️
src/qmflows/packages/__init__.py 0.00% <0.00%> (-100.00%) ⬇️
src/qmflows/parsers/__init__.py 0.00% <0.00%> (-100.00%) ⬇️
... and 61 more

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@BvB93 BvB93 force-pushed the restructure branch 2 times, most recently from b898ef0 to e97af52 Compare April 12, 2022 14:08
BvB93 added 2 commits April 12, 2022 19:00
Restructure the sub-package into the following public namespaces:
* `parsers`
* `parsers.adf`
* `parsers.cp2k`
* `parsers.orca`
* `parsers.utils`

f parser
Restructure the sub-package into the following public namespaces:
* `templates`
BvB93 and others added 9 commits April 12, 2022 19:08
Restructure the sub-package into the following public namespaces:
* `packages`

Also deprecates four functions:
* `registry`
* `load_properties`
* `SerMolecule`
* `SerSettings`
* `example_freqs`
* `example_H2O2_TS`
* `example_generic_constraints`
* `example_partial_geometry_opt`
`Settings` should be directly imported from the main namespace
@BvB93 BvB93 merged commit 3493182 into master Apr 12, 2022
@BvB93 BvB93 deleted the restructure branch April 12, 2022 19:08
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.

1 participant