functioneer 0.4.2__tar.gz → 0.6.0__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 (34) hide show
  1. functioneer-0.6.0/.gitattributes +2 -0
  2. functioneer-0.6.0/.github/workflows/release-please.yml +104 -0
  3. functioneer-0.6.0/.gitignore +180 -0
  4. functioneer-0.6.0/.release-please-manifest.json +3 -0
  5. functioneer-0.6.0/CHANGELOG.md +103 -0
  6. {functioneer-0.4.2 → functioneer-0.6.0}/LICENSE +25 -25
  7. {functioneer-0.4.2/src/functioneer.egg-info → functioneer-0.6.0}/PKG-INFO +189 -186
  8. {functioneer-0.4.2 → functioneer-0.6.0}/README.md +155 -155
  9. functioneer-0.6.0/dev_notes/.old/testing_functioneer_v0.1.ipynb +863 -0
  10. functioneer-0.6.0/dev_notes/.old/testing_functioneer_v0.2.ipynb +1140 -0
  11. functioneer-0.6.0/dev_notes/.old/testing_functioneer_v0.3.ipynb +384 -0
  12. functioneer-0.6.0/dev_notes/Ideas.md +30 -0
  13. functioneer-0.6.0/dev_notes/api_ideas.ipynb +174 -0
  14. functioneer-0.6.0/dev_notes/release_procedure.md +19 -0
  15. functioneer-0.6.0/docs/examples.ipynb +543 -0
  16. {functioneer-0.4.2 → functioneer-0.6.0}/pyproject.toml +53 -39
  17. functioneer-0.6.0/release-please-config.json +9 -0
  18. {functioneer-0.4.2 → functioneer-0.6.0}/setup.cfg +4 -4
  19. functioneer-0.6.0/src/functioneer/__init__.py +14 -0
  20. functioneer-0.6.0/src/functioneer/_version.py +34 -0
  21. {functioneer-0.4.2 → functioneer-0.6.0}/src/functioneer/analysis.py +422 -293
  22. functioneer-0.6.0/src/functioneer/optimize.py +10 -0
  23. {functioneer-0.4.2 → functioneer-0.6.0}/src/functioneer/parameter.py +174 -194
  24. {functioneer-0.4.2 → functioneer-0.6.0}/src/functioneer/steps.py +681 -636
  25. functioneer-0.6.0/src/functioneer/util.py +77 -0
  26. {functioneer-0.4.2 → functioneer-0.6.0/src/functioneer.egg-info}/PKG-INFO +189 -186
  27. functioneer-0.6.0/src/functioneer.egg-info/SOURCES.txt +29 -0
  28. {functioneer-0.4.2 → functioneer-0.6.0}/src/functioneer.egg-info/requires.txt +3 -0
  29. functioneer-0.6.0/tests/test_functioneer.py +23 -0
  30. functioneer-0.4.2/src/functioneer/__init__.py +0 -4
  31. functioneer-0.4.2/src/functioneer/util.py +0 -50
  32. functioneer-0.4.2/src/functioneer.egg-info/SOURCES.txt +0 -13
  33. {functioneer-0.4.2 → functioneer-0.6.0}/src/functioneer.egg-info/dependency_links.txt +0 -0
  34. {functioneer-0.4.2 → functioneer-0.6.0}/src/functioneer.egg-info/top_level.txt +0 -0
@@ -0,0 +1,2 @@
1
+ # Auto detect text files and perform LF normalization
2
+ * text=auto
@@ -0,0 +1,104 @@
1
+ name: Release Please
2
+
3
+ on:
4
+ pull_request:
5
+ branches: [main] # only run for PRs targeting main
6
+ push:
7
+ branches: [main] # optional: also run on direct pushes to main
8
+
9
+ permissions:
10
+ contents: write
11
+ pull-requests: write
12
+
13
+ jobs:
14
+ test:
15
+ runs-on: ubuntu-latest
16
+ steps:
17
+ - uses: actions/checkout@v4
18
+ with:
19
+ fetch-depth: 0 # good for some test tools
20
+
21
+ - name: Set up Python
22
+ uses: actions/setup-python@v5
23
+ with:
24
+ python-version: '3.x'
25
+
26
+ - name: Install dependencies
27
+ run: |
28
+ python -m pip install --upgrade pip
29
+ pip install .[test] # install the package with test dependencies
30
+
31
+ - name: Run tests
32
+ run: pytest tests
33
+
34
+ release-please:
35
+ needs: test
36
+ # Only run on direct pushes to main (never on PRs)
37
+ if: github.event_name == 'push' && github.ref == 'refs/heads/main'
38
+ runs-on: ubuntu-latest
39
+ outputs:
40
+ release_created: ${{ steps.release.outputs.release_created }}
41
+ tag_name: ${{ steps.release.outputs.tag_name }}
42
+ steps:
43
+ - uses: googleapis/release-please-action@v4
44
+ id: release
45
+ with:
46
+ config-file: release-please-config.json
47
+ manifest-file: .release-please-manifest.json
48
+ # package-name: your-package-name # optional, if repo name != package name
49
+ # changelog-types: ... # customize if you want non-standard types
50
+
51
+ build:
52
+ needs: release-please
53
+ if: ${{ needs.release-please.outputs.release_created == 'true' }}
54
+ runs-on: ubuntu-latest
55
+ steps:
56
+ - uses: actions/checkout@v4
57
+ with:
58
+ ref: ${{ needs.release-please.outputs.tag_name }}
59
+ fetch-depth: 0
60
+
61
+ - uses: actions/setup-python@v5
62
+ with:
63
+ python-version: '3.x'
64
+
65
+ - name: Install build tool
66
+ run: python -m pip install --upgrade build
67
+
68
+ - name: Build distribution files
69
+ run: python -m build
70
+
71
+ - name: Upload distribution files to release
72
+ uses: softprops/action-gh-release@v2
73
+ with:
74
+ tag_name: ${{ needs.release-please.outputs.tag_name }}
75
+ files: dist/*
76
+
77
+ - name: Upload artifacts for publish
78
+ uses: actions/upload-artifact@v4
79
+ with:
80
+ name: python-dist
81
+ path: dist/*
82
+ retention-days: 1
83
+
84
+ publish:
85
+ needs: build
86
+ runs-on: ubuntu-latest
87
+ environment: pypi
88
+ permissions:
89
+ id-token: write # for trusted publishing
90
+ steps:
91
+ - name: Download built distributions
92
+ uses: actions/download-artifact@v4
93
+ with:
94
+ name: python-dist
95
+ path: dist/
96
+
97
+ - uses: actions/setup-python@v5
98
+ with:
99
+ python-version: '3.x'
100
+
101
+ - name: Publish to PyPI
102
+ uses: pypa/gh-action-pypi-publish@release/v1
103
+ # with:
104
+ # repository-url: https://test.pypi.org/legacy/ # remove this line to publish to real PyPI
@@ -0,0 +1,180 @@
1
+
2
+ # User-specific stuff
3
+ .vscode
4
+
5
+ # user files
6
+ .idea/
7
+ .old/
8
+
9
+ ### Python ###
10
+ # Byte-compiled / optimized / DLL files
11
+ __pycache__/
12
+ *.py[cod]
13
+ *$py.class
14
+
15
+ # setuptools_scm version file
16
+ src/*/_version.py
17
+
18
+ # C extensions
19
+ *.so
20
+
21
+ # Distribution / packaging
22
+ .Python
23
+ build/
24
+ develop-eggs/
25
+ dist/
26
+ downloads/
27
+ eggs/
28
+ .eggs/
29
+ lib/
30
+ lib64/
31
+ parts/
32
+ sdist/
33
+ var/
34
+ wheels/
35
+ share/python-wheels/
36
+ *.egg-info/
37
+ .installed.cfg
38
+ *.egg
39
+ MANIFEST
40
+
41
+ # PyInstaller
42
+ # Usually these files are written by a python script from a template
43
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
44
+ *.manifest
45
+ *.spec
46
+
47
+ # Installer logs
48
+ pip-log.txt
49
+ pip-delete-this-directory.txt
50
+
51
+ # Unit test / coverage reports
52
+ htmlcov/
53
+ .tox/
54
+ .nox/
55
+ .coverage
56
+ .coverage.*
57
+ .cache
58
+ nosetests.xml
59
+ coverage.xml
60
+ *.cover
61
+ *.py,cover
62
+ .hypothesis/
63
+ .pytest_cache/
64
+ cover/
65
+
66
+ # Translations
67
+ *.mo
68
+ *.pot
69
+
70
+ # Django stuff:
71
+ *.log
72
+ local_settings.py
73
+ db.sqlite3
74
+ db.sqlite3-journal
75
+
76
+ # Flask stuff:
77
+ instance/
78
+ .webassets-cache
79
+
80
+ # Scrapy stuff:
81
+ .scrapy
82
+
83
+ # Sphinx documentation
84
+ docs/_build/
85
+
86
+ # PyBuilder
87
+ .pybuilder/
88
+ target/
89
+
90
+ # Jupyter Notebook
91
+ notebooks/
92
+
93
+ .ipynb_checkpoints
94
+ */.ipynb_checkpoints/*
95
+
96
+ # IPython
97
+
98
+ # pyenv
99
+ # For a library or package, you might want to ignore these files since the code is
100
+ # intended to run in multiple environments; otherwise, check them in:
101
+ # .python-version
102
+
103
+ # pipenv
104
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
105
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
106
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
107
+ # install all needed dependencies.
108
+ #Pipfile.lock
109
+
110
+ # poetry
111
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
112
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
113
+ # commonly ignored for libraries.
114
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
115
+ #poetry.lock
116
+
117
+ # pdm
118
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
119
+ #pdm.lock
120
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
121
+ # in version control.
122
+ # https://pdm.fming.dev/#use-with-ide
123
+ .pdm.toml
124
+
125
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
126
+ __pypackages__/
127
+
128
+ # Celery stuff
129
+ celerybeat-schedule
130
+ celerybeat.pid
131
+
132
+ # SageMath parsed files
133
+ *.sage.py
134
+
135
+ # Environments
136
+ .env
137
+ .venv
138
+ env/
139
+ venv/
140
+ ENV/
141
+ env.bak/
142
+ venv.bak/
143
+
144
+ # Spyder project settings
145
+ .spyderproject
146
+ .spyproject
147
+
148
+ # Rope project settings
149
+ .ropeproject
150
+
151
+ # mkdocs documentation
152
+ /site
153
+
154
+ # mypy
155
+ .mypy_cache/
156
+ .dmypy.json
157
+ dmypy.json
158
+
159
+ # Pyre type checker
160
+ .pyre/
161
+
162
+ # pytype static type analyzer
163
+ .pytype/
164
+
165
+ # Cython debug symbols
166
+ cython_debug/
167
+
168
+ # PyCharm
169
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
170
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
171
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
172
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
173
+ #.idea/
174
+
175
+ ### Python Patch ###
176
+ # Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
177
+ poetry.toml
178
+
179
+ # PyPI configuration file
180
+ .pypirc
@@ -0,0 +1,3 @@
1
+ {
2
+ ".": "0.6.0"
3
+ }
@@ -0,0 +1,103 @@
1
+ # Changelog
2
+ ## [0.6.0](https://github.com/qthedoc/functioneer/compare/v0.5.0...v0.6.0) (2026-02-14)
3
+
4
+
5
+ ### Features
6
+
7
+ * error handling and progress prints ([42dcf2d](https://github.com/qthedoc/functioneer/commit/42dcf2d5406e4cd713ea0ceaed0a5b5f0348ac23))
8
+ * forks can handle np.array ([37be368](https://github.com/qthedoc/functioneer/commit/37be3689488108d36eb1b0c3f753e3e84414b402))
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * match_w_kwargs allows passing of **kwargs ([b520aa2](https://github.com/qthedoc/functioneer/commit/b520aa225c8c432b2bdee8cb55ed46666b692306))
14
+
15
+
16
+ ### Documentation
17
+
18
+ * cleanup ([1b74538](https://github.com/qthedoc/functioneer/commit/1b745383787fed7ab6b73c286ccb830534be4447))
19
+ * update rosenbrock lingo ([8a1c21f](https://github.com/qthedoc/functioneer/commit/8a1c21f3840c271f946395874e7795d8ffa4e0d4))
20
+
21
+ ## [0.5.0](https://github.com/qthedoc/functioneer/compare/v0.4.2...v0.5.0) (2025-06-24)
22
+
23
+ ### Important Updates
24
+
25
+ * API CHANGE: `execute()` changed to `evaluate()`
26
+ * Forks can now handle *value configs*
27
+
28
+ ## [0.4.2](https://github.com/qthedoc/functioneer/compare/v0.4.1...v0.4.2) (2025-06-24)
29
+
30
+ ### Important Updates
31
+
32
+ * Docs Updated - yeah the (anal)ysis had to go: `anal.add.fork` ... no thanks!
33
+
34
+ ## [0.4.1](https://github.com/qthedoc/functioneer/compare/v0.4.0...v0.4.1) (2025-06-24)
35
+
36
+ ### Important Updates
37
+
38
+ * Docs Updated
39
+
40
+ ## [0.4.0](https://github.com/qthedoc/functioneer/compare/v0.3.0...v0.4.0) (2025-06-24)
41
+
42
+ ### Important Updates
43
+
44
+ * Multi Forks are now defined using dicts
45
+
46
+
47
+ ## [0.3.0](https://github.com/qthedoc/functioneer/compare/v0.2.2...v0.3.0) (2025-06-24)
48
+
49
+ ### Important Updates
50
+
51
+ * Fleshed out optimizer
52
+ * Added lots of validation
53
+ * assign_to arg can be assumed from function name
54
+
55
+ ## [0.2.2](https://github.com/qthedoc/functioneer/compare/v0.2.1...v0.2.2) (2025-02-04)
56
+
57
+
58
+ ### Documentation
59
+
60
+ * new descripiton ([9a91dbc](https://github.com/qthedoc/functioneer/commit/9a91dbc39aa2d1c413db9f0307c43ee6b1838529))
61
+ * README ([f8c0205](https://github.com/qthedoc/functioneer/commit/f8c0205509ff3602984bbc83e4bf780061ed58f9))
62
+ * README ([8462d61](https://github.com/qthedoc/functioneer/commit/8462d613b4a541b4adc7d8d33082dd05f85d7b05))
63
+
64
+ ## [0.2.1](https://github.com/qthedoc/functioneer/compare/v0.2.0...v0.2.1) (2025-02-02)
65
+
66
+
67
+ ### Documentation
68
+
69
+ * README and added dist_record ([41c6cad](https://github.com/qthedoc/functioneer/commit/41c6cadaa8bed8498c0027ec5f495698a6e6dc12))
70
+ * README date ([36ee4ff](https://github.com/qthedoc/functioneer/commit/36ee4fffd2906a4fa560fbdda1b9cc8b6d395505))
71
+
72
+ ## [0.2.0](https://github.com/qthedoc/functioneer/compare/v0.1.1...v0.2.0) (2025-02-02)
73
+
74
+
75
+ ### Features
76
+
77
+ * simpler namespace API ([867c3aa](https://github.com/qthedoc/functioneer/commit/867c3aa5ba6977ded6eb65f0ad47bedd939b83b4))
78
+
79
+ ## [0.1.1](https://github.com/qthedoc/functioneer/compare/v0.1.0...v0.1.1) (2025-01-09)
80
+
81
+
82
+ ### Documentation
83
+
84
+ * README ([0405b44](https://github.com/qthedoc/functioneer/commit/0405b446b36603d59137ca56b131833bd6705b67))
85
+ * README ([0df220d](https://github.com/qthedoc/functioneer/commit/0df220de6264a437033b4043cf5c75206ee7356a))
86
+ * README and toml ([227c040](https://github.com/qthedoc/functioneer/commit/227c0403cc2fcd2d3353589983bf35c41455248d))
87
+ * README polished ([f4e4af9](https://github.com/qthedoc/functioneer/commit/f4e4af93d2fa6d82f9a7a5358e24d20fcce8fe1f))
88
+
89
+ ## 0.1.0 (2025-01-09)
90
+
91
+
92
+ ### Bug Fixes
93
+
94
+ * Delete functioneer.code-workspace ([7e3fec5](https://github.com/qthedoc/functioneer/commit/7e3fec564889d7fb1b6f869ac50a90f4cb662c4d))
95
+ * reformatted for release ([47c55b5](https://github.com/qthedoc/functioneer/commit/47c55b52f920d62bd37b8303836ec3ff32967e0d))
96
+
97
+
98
+ ### Documentation
99
+
100
+ * description ([5592c6c](https://github.com/qthedoc/functioneer/commit/5592c6c0801a2be8b5dca05ba5419cb2384796d5))
101
+ * documentation WIP ([fa07546](https://github.com/qthedoc/functioneer/commit/fa07546e6714e5501784da1555b732ff5a002f24))
102
+ * README and LICENSE update ([3d7eea1](https://github.com/qthedoc/functioneer/commit/3d7eea17ef469c25d059b5014c32bf1a75485907))
103
+ * toml error ([761da0c](https://github.com/qthedoc/functioneer/commit/761da0ca4ad394f7130dd41cfeaba5ae7b6536cf))
@@ -1,25 +1,25 @@
1
- Functioneer (c) 2024 by Quinn Marsh is licensed under MIT License
2
-
3
- MIT License
4
-
5
- Copyright (c) 2024 Quinn Marsh (quinnmarsh@hotmail.com, X @qthedoc)
6
-
7
- Permission is hereby granted, free of charge, to any person obtaining a copy
8
- of this software and associated documentation files (the "Software"), to deal
9
- in the Software without restriction, including without limitation the rights
10
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
- copies of the Software, and to permit persons to whom the Software is
12
- furnished to do so, subject to the following conditions:
13
-
14
- The above copyright notice and this permission notice shall be included in
15
- all copies or substantial portions of the Software.
16
-
17
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
- THE SOFTWARE.
24
-
25
-
1
+ Functioneer (c) 2024 by Quinn Marsh is licensed under MIT License
2
+
3
+ MIT License
4
+
5
+ Copyright (c) 2024 Quinn Marsh (quinnmarsh@hotmail.com, X @qthedoc)
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+
25
+