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

Prepare for v3.0.0 #189

Merged
merged 27 commits into from
Aug 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
4808a6c
Deprecate "transient_asym_att_x", "transient_att_x" in favor of trans…
bdestombe Jul 31, 2023
cd1c221
Deprecate transient_att_x from tests in favor of trans_att
bdestombe Jul 31, 2023
701f599
black formatting
bdestombe Jul 31, 2023
3ba2b20
Inconsistent ds.sections behavior
bdestombe Jul 31, 2023
78c6aa7
Removing api directory from docs
bdestombe Aug 3, 2023
8c295a7
Clean up of documentation
bdestombe Aug 3, 2023
fd57fd3
Another cleanup of docs
bdestombe Aug 3, 2023
e28bb88
Cleanup docs
bdestombe Aug 3, 2023
fcbf028
Update headings example nb 14
bdestombe Aug 4, 2023
3b5afa7
Updated changelog to include the fixing the headers of the example no…
bdestombe Aug 4, 2023
26d795f
Black formatted docs/conf.py
bdestombe Aug 4, 2023
dd6d21c
Improves consistency of ds.sections behavior
bdestombe Aug 4, 2023
ab12189
variance_stokes_linear() does not default through zero anymore.
bdestombe Aug 4, 2023
b58afef
black formatting
bdestombe Aug 4, 2023
0ee7291
Moved validate_sections() to please mypy
bdestombe Aug 4, 2023
146faf2
Renamed io.py to io_utils.py and moved read_*_files() to io.py
bdestombe Aug 4, 2023
bf53930
Pull code through linter
bdestombe Aug 4, 2023
10f36c3
Refactored ufunc_per_section and moved ParameterIndex_Ended to datast…
bdestombe Aug 6, 2023
e64418a
Refactored calibration_single_ended() and calibration_double_ended()
bdestombe Aug 6, 2023
1eded97
Updated changelog and corrected small error due to refactoring
bdestombe Aug 6, 2023
270c74d
Forgotten comma
bdestombe Aug 6, 2023
f8872ec
Sorted imports
bdestombe Aug 6, 2023
cff9809
Reordered some functions in datastore_utils.py
bdestombe Aug 6, 2023
155fafe
Removed installation page from docs
bdestombe Aug 8, 2023
62ffb6c
Reformulated CHANGELOG.rst entry
bdestombe Aug 8, 2023
0c8b1f0
Cleared old dangling readthedocs files
bdestombe Aug 8, 2023
9b1fae2
Merge branch 'prepare-for-v3.0.0' of https://github.com/dtscalibratio…
bdestombe Aug 8, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,16 @@ Added
Fixed

* Single-ended measurements with `fix_alpha` failed due to a bug introduced in v2.0.0 ([#173](https://github.com/dtscalibration/python-dts-calibration/pull/173)).
* Headers in example notebooks and their appearance in the docs are now at correct levels

Changed

* Standardized parameter names. Reduced the freedom in choosing parameter names and dimension names in favor of simplifying the code.
* Requiring netcdf4 >= 1.6.4
* Optional dependencies of xarray that improve performance are now required by default.
* variance_stokes_linear() does not default through zero anymore.
* Refactored calibration_single_ended and calibration_double_ended()
* Moved ParameterIndices classes to calibration_utils.py
* Flox included in requirements to speed up resampling via xarray ([Xarray #5734](https://github.com/pydata/xarray/pull/5734)).

Removed
Expand Down
1 change: 0 additions & 1 deletion docs/_config.yml

This file was deleted.

83 changes: 0 additions & 83 deletions docs/api/dtscalibration.DataStore.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.check_dims.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.check_timestep_allclose.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.get_netcdf_encoding.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.merge_double_ended.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.open_datastore.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.open_mf_datastore.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.plot_accuracy.rst

This file was deleted.

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.plot_residuals_reference_sections.rst

This file was deleted.

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.plot_sigma_report.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.read_apsensing_files.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.read_sensornet_files.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.read_sensortran_files.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.read_silixa_files.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.shift_double_ended.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/dtscalibration.suggest_cable_shift_double_ended.rst

This file was deleted.

3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@


extensions = [
"sphinx_rtd_theme",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.coverage",
Expand Down Expand Up @@ -69,7 +70,7 @@
napoleon_use_param = False

# sphinx_automodapi.automodapi
numpydoc_show_class_members = False
numpydoc_show_class_members = True

# -- nbsphinx configuration --
nbsphinx_allow_errors = False
Expand Down
4 changes: 1 addition & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@ Contents
========

.. toctree::
:maxdepth: 2
:maxdepth: 3

readme
installation
usage
learn_by_examples
reference/index
contributing
Expand Down
8 changes: 0 additions & 8 deletions docs/installation.rst

This file was deleted.

95 changes: 0 additions & 95 deletions docs/nb_examples_to_docs.py

This file was deleted.

Loading
Loading