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

Create public api for dataset. #3536

Merged
merged 31 commits into from
Jun 13, 2022

Conversation

jenshnielsen
Copy link
Collaborator

@jenshnielsen jenshnielsen commented Nov 1, 2021

  • Move dond module to dataset where it belongs more naturally
  • Let utils be a module that is independent of the rest of qcodes to avoid cirular dependenceis
    1. Move Slack and schema installation to a new module extensions
    2. Refactor a few other modules to import qcodes inside the functions. These will eventually be moved elsewhere
  • Import and document all methods used in dataset examples at the level of qcodes.dataset.
  • Add shims for old modules. These will not currently raise warnings. I suggest we turn these on after the new api is in a release to avoid confusion

This does not in general update examples to use the new imports. I suggest we do that after this pr has been merged. Can be done in small batches making review easier.

@codecov
Copy link

codecov bot commented Nov 1, 2021

Codecov Report

Merging #3536 (33c8143) into master (1040533) will decrease coverage by 0.00%.
The diff coverage is 89.23%.

@@            Coverage Diff             @@
##           master    #3536      +/-   ##
==========================================
- Coverage   68.39%   68.39%   -0.01%     
==========================================
  Files         232      235       +3     
  Lines       30872    30884      +12     
==========================================
+ Hits        21115    21122       +7     
- Misses       9757     9762       +5     

@astafan8 astafan8 added this to the 0.30.0 milestone Nov 2, 2021
@astafan8 astafan8 modified the milestones: 0.30.0, 0.31.0 Dec 8, 2021
@astafan8 astafan8 modified the milestones: 0.31.0, 0.32.0 Dec 19, 2021
@jenshnielsen jenshnielsen force-pushed the add_plot_to_dataset_api branch 3 times, most recently from bc0f9ab to bb6213f Compare January 6, 2022 11:04
astafan8
astafan8 previously approved these changes Jan 6, 2022
@astafan8 astafan8 modified the milestones: 0.32.0, 0.33.0 Jan 24, 2022
@astafan8 astafan8 modified the milestones: 0.33.0, 0.34.0 Feb 16, 2022
@jenshnielsen jenshnielsen force-pushed the add_plot_to_dataset_api branch 3 times, most recently from a505c2a to e89a5af Compare February 28, 2022 15:35
@jenshnielsen jenshnielsen changed the title Add plotting to the dataset public api Add plotting and dond to the dataset public api Mar 4, 2022
@jenshnielsen
Copy link
Collaborator Author

Should probably rename the dond module to clarify the difference between the dond function and module

@jenshnielsen jenshnielsen force-pushed the add_plot_to_dataset_api branch 3 times, most recently from 2db5424 to a501d56 Compare March 7, 2022 10:27
Copy link
Contributor

@astafan8 astafan8 left a comment

Choose a reason for hiding this comment

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

so happy to see doNd's being moved from utils to qcodes.dataset :)

qcodes/utils/dataset/doNd.py Outdated Show resolved Hide resolved
@jenshnielsen jenshnielsen force-pushed the add_plot_to_dataset_api branch 2 times, most recently from 6799651 to 786a902 Compare June 7, 2022 11:38
@jenshnielsen jenshnielsen dismissed astafan8’s stale review June 10, 2022 10:44

Things have changed significantly since this review so lets review again

@jenshnielsen
Copy link
Collaborator Author

@astafan8 Could you have a look again. The description has been updated to reflect what is in scope and what is not

qcodes/extensions/__init__.py Outdated Show resolved Hide resolved
qcodes/extensions/__init__.py Show resolved Hide resolved
qcodes/dataset/__init__.py Show resolved Hide resolved
qcodes/utils/plotting.py Show resolved Hide resolved
Co-authored-by: Mikhail Astafev <astafan8@gmail.com>
@jenshnielsen
Copy link
Collaborator Author

bors merge

bors bot added a commit that referenced this pull request Jun 13, 2022
3536: Create public api for dataset. r=jenshnielsen a=jenshnielsen

* Move dond module to dataset where it belongs more naturally
* Let utils be a module that is independent of the rest of qcodes to avoid cirular dependenceis
     1. Move Slack and schema installation to a new module extensions
     2. Refactor a few other modules to import qcodes inside the functions. These will eventually be moved elsewhere
*  Import and document all methods used in dataset examples at the level of qcodes.dataset. 
* Add shims for old modules. These will not currently raise warnings. I suggest we turn these on after the new api is in a release to avoid confusion


This does not in general update examples to use the new imports. I suggest we do that after this pr has been merged. Can be done in small batches making review easier.


Co-authored-by: Jens H. Nielsen <Jens.Nielsen@microsoft.com>
Co-authored-by: Jens Hedegaard Nielsen <jenshnielsen@gmail.com>
@bors
Copy link
Contributor

bors bot commented Jun 13, 2022

This PR was included in a batch that successfully built, but then failed to merge into master. It will not be retried.

Additional information:

{"message":"All comments must be resolved.","documentation_url":"https://docs.github.com/articles/about-protected-branches"}

@jenshnielsen jenshnielsen merged commit bcfc19f into microsoft:master Jun 13, 2022
@jenshnielsen jenshnielsen deleted the add_plot_to_dataset_api branch June 13, 2022 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants