pykingenie 0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. pykingenie-0.1/LICENSE +21 -0
  2. pykingenie-0.1/PKG-INFO +65 -0
  3. pykingenie-0.1/README.md +24 -0
  4. pykingenie-0.1/pyproject.toml +81 -0
  5. pykingenie-0.1/setup.cfg +4 -0
  6. pykingenie-0.1/src/__init__.py +1 -0
  7. pykingenie-0.1/src/pykingenie/__init__.py +105 -0
  8. pykingenie-0.1/src/pykingenie/fitter.py +917 -0
  9. pykingenie-0.1/src/pykingenie/fitter_solution.py +465 -0
  10. pykingenie-0.1/src/pykingenie/gator.py +528 -0
  11. pykingenie-0.1/src/pykingenie/kingenie_solution.py +139 -0
  12. pykingenie-0.1/src/pykingenie/kingenie_surface.py +249 -0
  13. pykingenie-0.1/src/pykingenie/main.py +629 -0
  14. pykingenie-0.1/src/pykingenie/octet.py +655 -0
  15. pykingenie-0.1/src/pykingenie/solution_exp.py +114 -0
  16. pykingenie-0.1/src/pykingenie/surface_exp.py +688 -0
  17. pykingenie-0.1/src/pykingenie/utils/__init__.py +0 -0
  18. pykingenie-0.1/src/pykingenie/utils/fitting_general.py +430 -0
  19. pykingenie-0.1/src/pykingenie/utils/fitting_solution.py +433 -0
  20. pykingenie-0.1/src/pykingenie/utils/fitting_surface.py +1120 -0
  21. pykingenie-0.1/src/pykingenie/utils/math.py +177 -0
  22. pykingenie-0.1/src/pykingenie/utils/palettes.py +63 -0
  23. pykingenie-0.1/src/pykingenie/utils/plotting.py +698 -0
  24. pykingenie-0.1/src/pykingenie/utils/processing.py +474 -0
  25. pykingenie-0.1/src/pykingenie/utils/signal_solution.py +462 -0
  26. pykingenie-0.1/src/pykingenie/utils/signal_surface.py +829 -0
  27. pykingenie-0.1/src/pykingenie.egg-info/PKG-INFO +65 -0
  28. pykingenie-0.1/src/pykingenie.egg-info/SOURCES.txt +46 -0
  29. pykingenie-0.1/src/pykingenie.egg-info/dependency_links.txt +1 -0
  30. pykingenie-0.1/src/pykingenie.egg-info/requires.txt +34 -0
  31. pykingenie-0.1/src/pykingenie.egg-info/top_level.txt +2 -0
  32. pykingenie-0.1/tests/test_exception_blocks.py +17 -0
  33. pykingenie-0.1/tests/test_fitter_surface.py +328 -0
  34. pykingenie-0.1/tests/test_fitting_general.py +14 -0
  35. pykingenie-0.1/tests/test_fitting_solution.py +653 -0
  36. pykingenie-0.1/tests/test_gator.py +24 -0
  37. pykingenie-0.1/tests/test_kingenie_solution.py +23 -0
  38. pykingenie-0.1/tests/test_kingenie_surface.py +73 -0
  39. pykingenie-0.1/tests/test_main.py +195 -0
  40. pykingenie-0.1/tests/test_main_solution.py +89 -0
  41. pykingenie-0.1/tests/test_octet.py +133 -0
  42. pykingenie-0.1/tests/test_solution_exp.py +21 -0
  43. pykingenie-0.1/tests/test_surface_exp.py +293 -0
  44. pykingenie-0.1/tests/test_utils_math.py +82 -0
  45. pykingenie-0.1/tests/test_utils_plotting.py +152 -0
  46. pykingenie-0.1/tests/test_utils_processing.py +149 -0
  47. pykingenie-0.1/tests/test_utils_signal_solution.py +112 -0
  48. pykingenie-0.1/tests/test_utils_signal_surface.py +326 -0
pykingenie-0.1/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) [2025] [Osvaldo Burastero]
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,65 @@
1
+ Metadata-Version: 2.4
2
+ Name: pykingenie
3
+ Version: 0.1
4
+ Author-email: Osvaldo Burastero <oburastero@gmail.com>
5
+ License: MIT
6
+ Requires-Python: >=3.10
7
+ Description-Content-Type: text/markdown
8
+ License-File: LICENSE
9
+ Requires-Dist: plotly>=6.2.0
10
+ Requires-Dist: kaleido>=1.0.0
11
+ Requires-Dist: numpy>=2.2.5
12
+ Requires-Dist: pandas>=2.2.3
13
+ Requires-Dist: scipy>=1.15.2
14
+ Requires-Dist: matplotlib>=3.10.1
15
+ Provides-Extra: dev
16
+ Requires-Dist: black>=25.1.0; extra == "dev"
17
+ Requires-Dist: coverage-badge>=1.1.2; extra == "dev"
18
+ Requires-Dist: flake8>=7.3.0; extra == "dev"
19
+ Requires-Dist: ipykernel>=6.30.0; extra == "dev"
20
+ Requires-Dist: jupyter>=1.1.1; extra == "dev"
21
+ Requires-Dist: notebook>=7.4.4; extra == "dev"
22
+ Requires-Dist: numpydoc>=1.9.0; extra == "dev"
23
+ Requires-Dist: pydata-sphinx-theme>=0.16.1; extra == "dev"
24
+ Requires-Dist: pytest>=8.4.1; extra == "dev"
25
+ Requires-Dist: pytest-cov>=6.2.1; extra == "dev"
26
+ Requires-Dist: sphinx>=8.1.3; extra == "dev"
27
+ Requires-Dist: sphinx-copybutton>=0.5.2; extra == "dev"
28
+ Requires-Dist: sphinx-design>=0.6.1; extra == "dev"
29
+ Requires-Dist: sphinx-tabs>=3.4.7; extra == "dev"
30
+ Provides-Extra: docs
31
+ Requires-Dist: numpydoc>=1.9.0; extra == "docs"
32
+ Requires-Dist: pydata-sphinx-theme>=0.16.1; extra == "docs"
33
+ Requires-Dist: sphinx>=8.1.3; extra == "docs"
34
+ Requires-Dist: sphinx-copybutton>=0.5.2; extra == "docs"
35
+ Requires-Dist: sphinx-design>=0.6.1; extra == "docs"
36
+ Requires-Dist: sphinx-tabs>=3.4.7; extra == "docs"
37
+ Provides-Extra: test
38
+ Requires-Dist: pytest>=8.4.1; extra == "test"
39
+ Requires-Dist: pytest-cov>=6.2.1; extra == "test"
40
+ Dynamic: license-file
41
+
42
+ [![Test and build](https://github.com/osvalB/pykingenie/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/osvalB/pykingenie/actions/workflows/ci-cd.yml)
43
+ [![codecov](https://codecov.io/gh/osvalB/pykingenie/graph/badge.svg)](https://codecov.io/gh/osvalB/pykingenie)
44
+ [![Docs](https://img.shields.io/badge/docs-online-blue)](https://osvalb.github.io/pykingenie)
45
+
46
+ Welcome to **pyKinGenie**!, a python package for analysing binding kinetics data
47
+
48
+ This project is under development, and breaking changes may occur at any moment!
49
+
50
+ ## Features
51
+
52
+ - Import Octet files (.frd)
53
+ - Import Gator files (Assay_#_Channel#.csv, Setting.ini and ExperimentStep.ini)
54
+ - Import custom CSV files
55
+ - Processs the traces (alignment, baseline correction)
56
+ - Calculate binding kinetics (*k*<sub>on</sub>, *k*<sub>off</sub>, *K*<sub>D</sub>)
57
+ - Global fitting of multiple traces
58
+ - One-to-one, one-to-one with mass transport limitation, and one-to-one with induced fit models
59
+
60
+ ## Contributing
61
+
62
+ Contributions are welcome! Please contact me at oburastero@embl-hamburg.de
63
+
64
+ ## License
65
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
@@ -0,0 +1,24 @@
1
+ [![Test and build](https://github.com/osvalB/pykingenie/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/osvalB/pykingenie/actions/workflows/ci-cd.yml)
2
+ [![codecov](https://codecov.io/gh/osvalB/pykingenie/graph/badge.svg)](https://codecov.io/gh/osvalB/pykingenie)
3
+ [![Docs](https://img.shields.io/badge/docs-online-blue)](https://osvalb.github.io/pykingenie)
4
+
5
+ Welcome to **pyKinGenie**!, a python package for analysing binding kinetics data
6
+
7
+ This project is under development, and breaking changes may occur at any moment!
8
+
9
+ ## Features
10
+
11
+ - Import Octet files (.frd)
12
+ - Import Gator files (Assay_#_Channel#.csv, Setting.ini and ExperimentStep.ini)
13
+ - Import custom CSV files
14
+ - Processs the traces (alignment, baseline correction)
15
+ - Calculate binding kinetics (*k*<sub>on</sub>, *k*<sub>off</sub>, *K*<sub>D</sub>)
16
+ - Global fitting of multiple traces
17
+ - One-to-one, one-to-one with mass transport limitation, and one-to-one with induced fit models
18
+
19
+ ## Contributing
20
+
21
+ Contributions are welcome! Please contact me at oburastero@embl-hamburg.de
22
+
23
+ ## License
24
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
@@ -0,0 +1,81 @@
1
+ [project]
2
+ name = "pykingenie"
3
+ version = "0.1"
4
+ readme = "README.md"
5
+ license = {text = "MIT"}
6
+ authors = [
7
+ { name = "Osvaldo Burastero", email = "oburastero@gmail.com" }
8
+ ]
9
+ requires-python = ">=3.10"
10
+ dependencies = [
11
+ "plotly>=6.2.0",
12
+ "kaleido>=1.0.0",
13
+ "numpy>=2.2.5",
14
+ "pandas>=2.2.3",
15
+ "scipy>=1.15.2",
16
+ "matplotlib>=3.10.1",
17
+ ]
18
+
19
+ [build-system]
20
+ requires = ["setuptools >= 77.0.3"]
21
+ build-backend = "setuptools.build_meta"
22
+
23
+ [project.optional-dependencies]
24
+ dev = [
25
+ "black>=25.1.0",
26
+ "coverage-badge>=1.1.2",
27
+ "flake8>=7.3.0",
28
+ "ipykernel>=6.30.0",
29
+ "jupyter>=1.1.1",
30
+ "notebook>=7.4.4",
31
+ "numpydoc>=1.9.0",
32
+ "pydata-sphinx-theme>=0.16.1",
33
+ "pytest>=8.4.1",
34
+ "pytest-cov>=6.2.1",
35
+ "sphinx>=8.1.3",
36
+ "sphinx-copybutton>=0.5.2",
37
+ "sphinx-design>=0.6.1",
38
+ "sphinx-tabs>=3.4.7",
39
+ ]
40
+ docs = [
41
+ "numpydoc>=1.9.0",
42
+ "pydata-sphinx-theme>=0.16.1",
43
+ "sphinx>=8.1.3",
44
+ "sphinx-copybutton>=0.5.2",
45
+ "sphinx-design>=0.6.1",
46
+ "sphinx-tabs>=3.4.7",
47
+ ]
48
+ test = [
49
+ "pytest>=8.4.1",
50
+ "pytest-cov>=6.2.1",
51
+ ]
52
+
53
+
54
+ [tool.pytest.ini_options]
55
+ testpaths = ["tests"]
56
+ python_files = ["test_*.py", "*_test.py"]
57
+ python_classes = ["Test*"]
58
+ python_functions = ["test_*"]
59
+ addopts = [
60
+ "--cov=src/pykingenie",
61
+ "--cov-report=html",
62
+ "--cov-report=xml",
63
+ "--cov-report=term-missing",
64
+ "--verbose"
65
+ ]
66
+
67
+ [tool.coverage.run]
68
+ source = ["src/pykingenie"]
69
+ omit = ["*/tests/*", "*/test_*"]
70
+
71
+ [tool.coverage.report]
72
+ exclude_lines = [
73
+ "pragma: no cover",
74
+ "def __repr__",
75
+ "raise AssertionError",
76
+ "raise NotImplementedError",
77
+ ]
78
+
79
+ [tool.sphinx]
80
+ source-dir = "docs"
81
+ build-dir = "docs/_build"
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1 @@
1
+ #Empty file to indicate that this is a package
@@ -0,0 +1,105 @@
1
+ from .main import KineticsAnalyzer
2
+ from .octet import OctetExperiment
3
+ from .gator import GatorExperiment
4
+ from .kingenie_solution import KinGenieCsvSolution
5
+ from .kingenie_surface import KinGenieCsv
6
+
7
+ from .utils.processing import (
8
+ guess_experiment_name,
9
+ guess_experiment_type,
10
+ concat_signal_lst,
11
+ get_palette,
12
+ get_plotting_df,
13
+ subset_data,
14
+ sample_type_to_letter,
15
+ get_colors_from_numeric_values
16
+ )
17
+
18
+ from .utils.math import (
19
+ single_exponential,
20
+ double_exponential,
21
+ median_filter,
22
+ rss_p,
23
+ get_rss,
24
+ get_desired_rss
25
+ )
26
+
27
+ from .utils.signal_surface import (
28
+ steady_state_one_site,
29
+ one_site_association_analytical,
30
+ one_site_dissociation_analytical,
31
+ ode_one_site_mass_transport_association,
32
+ ode_one_site_mass_transport_dissociation,
33
+ solve_ode_one_site_mass_transport_association,
34
+ solve_ode_one_site_mass_transport_dissociation,
35
+ differential_matrix_association_induced_fit,
36
+ differential_matrix_association_conformational_selection,
37
+ differential_matrix_dissociation_induced_fit,
38
+ differential_matrix_dissociation_conformational_selection,
39
+ constant_vector_induced_fit,
40
+ constant_vector_conformational_selection,
41
+ solve_all_states_fast,
42
+ solve_steady_state,
43
+ solve_induced_fit_association,
44
+ solve_conformational_selection_association,
45
+ solve_induced_fit_dissociation,
46
+ solve_conformational_selection_dissociation,
47
+ ode_mixture_analyte_association,
48
+ solve_ode_mixture_analyte_association,
49
+ ode_mixture_analyte_dissociation,
50
+ solve_ode_mixture_analyte_dissociation
51
+ )
52
+
53
+ from .utils.signal_solution import (
54
+ ode_one_site_insolution,
55
+ solve_ode_one_site_insolution,
56
+ signal_ode_one_site_insolution,
57
+ ode_induced_fit_insolution,
58
+ solve_ode_induced_fit_insolution,
59
+ signal_ode_induced_fit_insolution,
60
+ ode_conformational_selection_insolution,
61
+ solve_ode_conformational_selection_insolution,
62
+ signal_ode_conformational_selection_insolution,
63
+ get_initial_concentration_conformational_selection,
64
+ get_kobs_induced_fit,
65
+ get_kobs_conformational_selection
66
+ )
67
+
68
+ from .utils.fitting_surface import (
69
+ guess_initial_signal,
70
+ fit_steady_state_one_site,
71
+ steady_state_one_site_asymmetric_ci95,
72
+ fit_one_site_association,
73
+ fit_one_site_dissociation,
74
+ fit_one_site_assoc_and_disso,
75
+ fit_induced_fit_sites_assoc_and_disso,
76
+ fit_one_site_assoc_and_disso_ktr,
77
+ one_site_assoc_and_disso_asymmetric_ci95,
78
+ one_site_assoc_and_disso_asymmetric_ci95_koff
79
+ )
80
+
81
+ from .utils.fitting_general import (
82
+ fit_single_exponential,
83
+ fit_double_exponential
84
+ )
85
+
86
+ from .utils.fitting_solution import (
87
+ fit_one_site_solution,
88
+ fit_induced_fit_solution,
89
+ find_initial_parameters_induced_fit_solution
90
+ )
91
+
92
+ from .utils.plotting import (
93
+ config_fig,
94
+ plot_plate_info,
95
+ plot_traces,
96
+ plot_traces_all,
97
+ plot_steady_state,
98
+ plot_association_dissociation
99
+ )
100
+
101
+ # Package metadata
102
+ __version__ = '0.1.0'
103
+ __author__ = 'osvalB'
104
+ __email__ = 'oburastero@gmail.com'
105
+ __description__ = 'A Python package for kinetics data analysis'