Invert4geom

📦️ Build
* make semantic release GHA need changelog success ([`7b7d1c4`](https://github.com/mdtanker/invert4geom/commit/7b7d1c40805617db9cf42fea3065eb32585bf035))
* add make command for binder env ([`3b5d44e`](https://github.com/mdtanker/invert4geom/commit/3b5d44e926a9925e70220344bba04c464cdbfb3d))
* add optuna-integration package ([`fa648d5`](https://github.com/mdtanker/invert4geom/commit/fa648d56e243edc934d746b8b77ac103ed0c7e10))
🧰 Chores / Maintenance
* ignore dtype in test utils sampling ([`f18e356`](https://github.com/mdtanker/invert4geom/commit/f18e356057a9d8b3889d3a275b273effa8993018))
* more specific dtypes in tests ([`1c587fd`](https://github.com/mdtanker/invert4geom/commit/1c587fda8de5f7cd7b2a51bda1615377de073439))
* fix test dtype issue ([`f16f955`](https://github.com/mdtanker/invert4geom/commit/f16f95541695a0ec0afdd6e4e7f70fcc68c0c284))
* use head commit for skip tests on docs ([`7f4c863`](https://github.com/mdtanker/invert4geom/commit/7f4c863560d69751a2bd09f3a18d102500666648))
* don&39;t run test on docs commits [skip ci] ([`fedf871`](https://github.com/mdtanker/invert4geom/commit/fedf87102cb825a6054ff4e2d3d1c49a17a3e995))
* try stopping tests only for docs (not style) ([`f1cf974`](https://github.com/mdtanker/invert4geom/commit/f1cf9748c7f58cfba44f84166bfb69649ae24914))
* stop tests on docs/style [skip ci] ([`49de955`](https://github.com/mdtanker/invert4geom/commit/49de9550c07a77cefe5c40811090a87cbf07dc4c))
* still trying to stop GHA running on docs / style [skip ci] ([`7306b35`](https://github.com/mdtanker/invert4geom/commit/7306b352993af242e5c95f9566d178e29dc6390f))
* add missing &34;)&34; [skip-ci] ([`49918e9`](https://github.com/mdtanker/invert4geom/commit/49918e9169cf8f79779b7e53370426db50369492))
* fixing skip test on certain commits [skip ci] ([`4dfe4cf`](https://github.com/mdtanker/invert4geom/commit/4dfe4cf3bcd5dc9b212c3c75b239d414b4ea3d0c))
* stop tests running on doc / style commits ([`1a9e308`](https://github.com/mdtanker/invert4geom/commit/1a9e308ddbdfa78795b3055c466325b0c153629d))
* unpin binder env ([`e865ddc`](https://github.com/mdtanker/invert4geom/commit/e865ddc86d69b73da40fdb55fb042df792ce50ac))
* cleanup Make commands ([`482d95a`](https://github.com/mdtanker/invert4geom/commit/482d95af9f93ee79abd9e9ee51eee88ff93fb659))
* don&39;t run tests on docs or style commits ([`30abcdf`](https://github.com/mdtanker/invert4geom/commit/30abcdf322ffb2c5bb8a29b9dfa8dfde26fb0641))
* remove pre-commit updates from changelog ([`f7ea9c8`](https://github.com/mdtanker/invert4geom/commit/f7ea9c8af19be4e432c70442482b3b692fb71618))
📖 Documentation
* remove duplicate thumbnail [skip ci] ([`507bd06`](https://github.com/mdtanker/invert4geom/commit/507bd06dad7479eba3266d428455c7ca96e70d4e))
* specify thumbnails ([`18fcac1`](https://github.com/mdtanker/invert4geom/commit/18fcac15d82fb1bf368de2b3d4fba7fb9db12a7e))
* remove linkcode for API ([`2d2eeff`](https://github.com/mdtanker/invert4geom/commit/2d2eeffee32173505c5e4cc66a48e2b075d38e20))
* add links to github code for API ([`883c706`](https://github.com/mdtanker/invert4geom/commit/883c706ebf83fe0265ea608cb76ee5d8e2190331))
* fix error in conf.py ([`2a7824d`](https://github.com/mdtanker/invert4geom/commit/2a7824de5c826b9e47204c12b468eea94783d490))
* fix links to code in API docs ([`7d1fa5f`](https://github.com/mdtanker/invert4geom/commit/7d1fa5fed5e0c6d6c986510ba1f4ff00e38e533c))
* update notebooks ([`a74dbee`](https://github.com/mdtanker/invert4geom/commit/a74dbeeff70660fe26c9b21f638abed18a266fb2))
* add bishop gallery example ([`7e55c7e`](https://github.com/mdtanker/invert4geom/commit/7e55c7e0874294b3d4809e3cdabeb4a494b18f4a))
* update contrib guide ([`36baf37`](https://github.com/mdtanker/invert4geom/commit/36baf37605f484c83b981c201b495bc9ea035a3e))
* update and rerun user guide notebooks ([`b1c572a`](https://github.com/mdtanker/invert4geom/commit/b1c572abbd5e69db74c0d2776eb27e32cd69566c))
* update contributing guide ([`761814c`](https://github.com/mdtanker/invert4geom/commit/761814c4eb7c0d7e4a5d9f79a18bf9c07628ba1f))
* clarify code comment ([`ef34f57`](https://github.com/mdtanker/invert4geom/commit/ef34f577fff6b38bc28b3ac68ef1d6ebed908a09))
* improve inversion docstrings ([`471a76f`](https://github.com/mdtanker/invert4geom/commit/471a76f62bbc12b7386b998cc8515dff7c29ae24))
* fix pinning issue ([`a8f0ea1`](https://github.com/mdtanker/invert4geom/commit/a8f0ea1a86de678733db806f2c499ab193c68dfb))
* pin python-semantic-release in GHA ([`c5b18da`](https://github.com/mdtanker/invert4geom/commit/c5b18da86d199c198ea5523c6b7f6a40de47b61e))
🚀 Features
* add termination reason to inversion progress bar ([`0274d7b`](https://github.com/mdtanker/invert4geom/commit/0274d7bc63ad24e1a83bbe10bdcee09496dd8fdc))
* add region arg to plot_inversion_topo_results ([`694b778`](https://github.com/mdtanker/invert4geom/commit/694b77898816ae7901bb3a59f4dde51ced0c1467))
* add DC-shift regional estimation method ([`2e91771`](https://github.com/mdtanker/invert4geom/commit/2e9177123a8018dcea16ddc3f2dd8be949b44e31))
* add scale and yoffset args to synthetic topography function ([`4801f33`](https://github.com/mdtanker/invert4geom/commit/4801f3358cbbcc83637aa5e7df6f5bc9aab2f750))
* add iteration progress bar to inversion ([`25a4e92`](https://github.com/mdtanker/invert4geom/commit/25a4e926e3150898eb66643b0af25881b6403edc))
* limit misfit rmse to within optional inversion region ([`b66d3c4`](https://github.com/mdtanker/invert4geom/commit/b66d3c4a66e77b79295fafd17c72083a42c4ac27))
* add dynamic convergence plot to inversion ([`7a5d5b2`](https://github.com/mdtanker/invert4geom/commit/7a5d5b2aa28c4821e610785171aaa7855879347c))
* add inversion_region to plot convergence ([`52eebdd`](https://github.com/mdtanker/invert4geom/commit/52eebddfe3871c624814e720ecd0b7ea495a8b20))
* add plot_title kwarg for plot_cv_scores ([`3cda4e0`](https://github.com/mdtanker/invert4geom/commit/3cda4e070671c10c17b3834279f3458a4c0dd283))
* fix colorscales for inversion grav results ([`9218e68`](https://github.com/mdtanker/invert4geom/commit/9218e68ded9c1e22c4945d8e948462e957755ab8))
🐛 Bug Fixes
* set optuna logging level to warning ([`0796fef`](https://github.com/mdtanker/invert4geom/commit/0796fef8340bc47d361e13d87dce794686283622))
* make ipython optional import ([`ce88f1a`](https://github.com/mdtanker/invert4geom/commit/ce88f1a61d09124cd8df52287e6099323644f0a3))
* allow wiggle room for enforcing confining surfaces ([`7e4e0b0`](https://github.com/mdtanker/invert4geom/commit/7e4e0b03cb0799fe5d810cc0cd7f1f37a98973ee))
* add warning message to annulus derivative calculation ([`99a7ade`](https://github.com/mdtanker/invert4geom/commit/99a7ade218a24a2e595961c1d4b5206a52520fcf))
* add noise to test regional eq sources ([`350baca`](https://github.com/mdtanker/invert4geom/commit/350baca5961beaa3dc95a6854e07e59bbd6196ac))
* replace pygmt gridding with simple set_index for plotting ([`ebf6732`](https://github.com/mdtanker/invert4geom/commit/ebf6732dbb1da0a770e3b446486336fde56b6606))
✏️ Formatting
* pre-commit fixes ([`116a612`](https://github.com/mdtanker/invert4geom/commit/116a612b0ff613375715e320444f85906984483e))
* pre-commit fixes ([`b110f23`](https://github.com/mdtanker/invert4geom/commit/b110f236277b60c6ed82035b5b58316885366997))
* pre-commit fixes ([`9fe3777`](https://github.com/mdtanker/invert4geom/commit/9fe377749e1918b587e630343d9e3d1baf8472ea))

💥 Breaking Changes
* drop python 3.8 support

BREAKING CHANGE: ([`77cc15d`](https://github.com/mdtanker/invert4geom/commit/77cc15df813bde60a638b517d6c4d41ead76a7e0))
📦️ Build
* add support for Python 3.12 ([`b0b058a`](https://github.com/mdtanker/invert4geom/commit/b0b058a83cb54b1b2bc8a179842fd4dc02e55eb9))
* add binder env ([`60f15b7`](https://github.com/mdtanker/invert4geom/commit/60f15b7c84339bcf754b681257fbbfe599a02cbe))
* update pyproj specs ([`e70c4bc`](https://github.com/mdtanker/invert4geom/commit/e70c4bc1128575358603d711ca254ee041543ae2))
* add/remove dev dependencies ([`ec831f3`](https://github.com/mdtanker/invert4geom/commit/ec831f34146c611510c864bd2009da4b4ea617c5))
* add doc dependencies ([`d62d855`](https://github.com/mdtanker/invert4geom/commit/d62d8557e1c20e7a34c2d1df7204a08b9d5dc852))
🧰 Chores / Maintenance
* fixing semantic release action ([`cfcfdf1`](https://github.com/mdtanker/invert4geom/commit/cfcfdf1fd2e440128afd1312172d755feac672b1))
* trying to fix semantic-release action ([`75cadc3`](https://github.com/mdtanker/invert4geom/commit/75cadc332044e985bfcdc5dfbbbf3f02d7cff200))
* manually update GH action and pre-commit versions ([`46d9357`](https://github.com/mdtanker/invert4geom/commit/46d9357dc3c35f04f7c7854b0dcdcfa933892e69))
* update changelog template ([`d20c603`](https://github.com/mdtanker/invert4geom/commit/d20c603c7154e8df03a37cd130598caf2024c302))
* delete tmp optuna file in test ([`9b266aa`](https://github.com/mdtanker/invert4geom/commit/9b266aac6b13a4c0fc771873666f45f4a08035b0))
* gitignore vscode settings ([`ad5ab8e`](https://github.com/mdtanker/invert4geom/commit/ad5ab8e9fd21e25c991192b40d3aa70868ce5e9a))
* remove unnecessary files ([`74b63ae`](https://github.com/mdtanker/invert4geom/commit/74b63ae61fe00f878c568137417646d5cf6ed96f))
* list packages after install in test GHA ([`35f05e5`](https://github.com/mdtanker/invert4geom/commit/35f05e5499abd2685ee590dee89a66fbe4b0aa22))
* include all optimization deps in testing env ([`cb2f091`](https://github.com/mdtanker/invert4geom/commit/cb2f091ce4de1e226b67e5efad91d1449ecf0294))
* add optuna to test deps ([`89e2447`](https://github.com/mdtanker/invert4geom/commit/89e2447d24934eafeb1d603d71c037cfdf7b9e90))
* update GHA test env ([`70fcbf7`](https://github.com/mdtanker/invert4geom/commit/70fcbf7ad1d08b2329b07f098eabd20e7f8dc5fd))
* revert to mamba for GHA test env ([`45c9b7b`](https://github.com/mdtanker/invert4geom/commit/45c9b7b6d7d6b7f0de4715977da9bc4a0995b846))
* add make command for GHA test env ([`9f598bd`](https://github.com/mdtanker/invert4geom/commit/9f598bd85a56684316d70bb5d8f108e82aa64f5e))
* upgrade pip for GHA test env ([`e89ba32`](https://github.com/mdtanker/invert4geom/commit/e89ba325e43db92ae66deb0a293e307478128431))
* include setuptools in GHA test env ([`aa9e569`](https://github.com/mdtanker/invert4geom/commit/aa9e569a1e7ceda842794759f2006a61e3f0b4e2))
* fix typo in pre-commit ([`b05bab5`](https://github.com/mdtanker/invert4geom/commit/b05bab5337ccf46ced49ad6c9904df860e64cb06))
* ignore bib in pre-commit ([`ecd6d93`](https://github.com/mdtanker/invert4geom/commit/ecd6d9398378e2f4c6f0e1432e6c9f0d0d22b76e))
* ignore changelog template in pre-commit ([`23ed7d4`](https://github.com/mdtanker/invert4geom/commit/23ed7d4b584db7df709d93ad9cb320e8615d6d9a))
* update changelog template ([`f3a3c9c`](https://github.com/mdtanker/invert4geom/commit/f3a3c9cc48d1698bf9e50802f58ba53d7e6bb5c5))
* remove old push GHA ([`9e2088d`](https://github.com/mdtanker/invert4geom/commit/9e2088de1f29500a412bfb9ab50ba62824461f93))
* replace mamba with pip for GHA test env install ([`421cffe`](https://github.com/mdtanker/invert4geom/commit/421cffe087d6e1a5c1b41f9d0a6cd32e7cd078f6))
* rename release GHA ([`32b6c3a`](https://github.com/mdtanker/invert4geom/commit/32b6c3a5ce7f372e0425eedb5e8fcc7735870efe))
* add semantic release GHA ([`204c7a7`](https://github.com/mdtanker/invert4geom/commit/204c7a785617a48a5aaaebf94ab38ffe6477a20b))
* update pre-commit config ([`e2dbcdd`](https://github.com/mdtanker/invert4geom/commit/e2dbcddfbc19ad3ee3d6d2cb8ba927e44db88fe8))
* add make commands ([`98d6069`](https://github.com/mdtanker/invert4geom/commit/98d60695ea85dafba46448d6fcc8e88d05f3090c))
* update RTD env and add make command ([`83d4199`](https://github.com/mdtanker/invert4geom/commit/83d419999f832efef1eb172656ecc81ffdcbaf8d))
* change dependa-bot updates to monthly ([`3284324`](https://github.com/mdtanker/invert4geom/commit/3284324bd778579871c9cbaf36db5e47991e7d43))
* update from antarctic-plots to polartoolkit ([`16bf313`](https://github.com/mdtanker/invert4geom/commit/16bf313d1b1b859750552e7b44bd2e2c031f1b92))
📖 Documentation
* rerun all user guide notebooks ([`d8688f2`](https://github.com/mdtanker/invert4geom/commit/d8688f2251510037c8068eb04f6a896707317078))
* fix incorrect reference styles ([`93b6cfc`](https://github.com/mdtanker/invert4geom/commit/93b6cfc7cc3dff1f79f2705eb0ebf873a8d4b3e9))
* fix bibliography references ([`606c936`](https://github.com/mdtanker/invert4geom/commit/606c936aa2a5835e1d0f5242041d0c1b21f542c2))
* fix rtd.yml ([`36376d7`](https://github.com/mdtanker/invert4geom/commit/36376d7788bde28647e4f2c392299bfab4709160))
* use pip to install RTD env ([`27c063a`](https://github.com/mdtanker/invert4geom/commit/27c063a46680910641579b7abe765ce25e131048))
* switch from autodoc to autoapi ([`e182bac`](https://github.com/mdtanker/invert4geom/commit/e182bacc09f4630b8aaa594ff3576c44c0ccb4ec))
* add binder link to docs ([`ddb80d3`](https://github.com/mdtanker/invert4geom/commit/ddb80d3a35eecba21a52186224893950ec128bfd))
* add reference .bib and md file ([`048933e`](https://github.com/mdtanker/invert4geom/commit/048933e640d0cf6ee699c15694d8db85097e76f1))
* update install instructions ([`5c051a4`](https://github.com/mdtanker/invert4geom/commit/5c051a4d1af117a0fb5c510c6cf962e3fe691f6b))
* add a discretization user guide ([`8562c06`](https://github.com/mdtanker/invert4geom/commit/8562c0663e2f8d11433073904869beca8720f0b2))
* move contributing guide ([`8d30cda`](https://github.com/mdtanker/invert4geom/commit/8d30cda624eeebd56d7297d60270d90587e83591))
* enable nbgallery for user guide ([`2bcc0aa`](https://github.com/mdtanker/invert4geom/commit/2bcc0aaadbb0a3e915f453d04388570191d6fe76))
* enable binder links ([`e134b4a`](https://github.com/mdtanker/invert4geom/commit/e134b4aa8c495ae7d77b3fbd1b46756fcd1cb583))
🚀 Features
* add plotting options to show_prism_layers ([`8c1874e`](https://github.com/mdtanker/invert4geom/commit/8c1874e746a19a07f4cf5815316a88ddab6c034e))
🐛 Bug Fixes
* resolve permission denied windows error in optuna test ([`1084b56`](https://github.com/mdtanker/invert4geom/commit/1084b569e13f8ac8cb5660be4dbd56e66af2e093))
✏️ Formatting
* pre-commit fixes ([`ed6fed9`](https://github.com/mdtanker/invert4geom/commit/ed6fed98b1e302546e31a6fffb0ecb420a13e164))
* remove unused type ignore ([`6313e7b`](https://github.com/mdtanker/invert4geom/commit/6313e7b1bdb56cca8c5490aa0ab0c1235bf68796))
* fix styling ([`15d96c7`](https://github.com/mdtanker/invert4geom/commit/15d96c7cc8299ea1536f77fa9ea0d92fc9353ed3))
* formatting ([`ccb890c`](https://github.com/mdtanker/invert4geom/commit/ccb890c0154186fdd11e45ed1c2ee49c9ae4daac))

📦️ Build
* only install doc optional deps for nox ([`da69dcb`](https://github.com/mdtanker/invert4geom/commit/da69dcbc46c0e8895e380dc6b1696761789b4ad7))
🧰 Chores / Maintenance
* adds license file to pyproject.toml ([`ed882d8`](https://github.com/mdtanker/invert4geom/commit/ed882d85b8bdf790126d5a638d14b4bcdd511716))
* adds github issue templates amd comments ([`721b391`](https://github.com/mdtanker/invert4geom/commit/721b391d94f9adbdeb28aa65dbea5615231cc0ce))
📖 Documentation
* remove optimization deps from RTD env ([`dad0330`](https://github.com/mdtanker/invert4geom/commit/dad033019a0d78421bdc94fe928e51500624d41d))
* fix docstring for jacobian_annular ([`7b7be72`](https://github.com/mdtanker/invert4geom/commit/7b7be7286476795fbf882dcee74ba9ef98eef97d))
* fix intersphinx mapping links ([`1ca89af`](https://github.com/mdtanker/invert4geom/commit/1ca89affd93f93b365727bb014620c2fd4c4bd4a))
* add docs link to contributing file ([`9d7f830`](https://github.com/mdtanker/invert4geom/commit/9d7f830d92fc05f514766fc964c85eabe17f76dd))
* fixes minor issues in docs ([`0bca578`](https://github.com/mdtanker/invert4geom/commit/0bca578550b1bf3d3cbefa25784692032d12aac6))
* add cover figure ([`5c0d029`](https://github.com/mdtanker/invert4geom/commit/5c0d029d44c257c51856711b3823a011a6db6c25))
🐛 Bug Fixes
* adds encoding to open calls ([`110ff36`](https://github.com/mdtanker/invert4geom/commit/110ff368f91cc1138a48922798f42982cd352b82))
✏️ Formatting
* formatting ([`3ab7fb3`](https://github.com/mdtanker/invert4geom/commit/3ab7fb3bd9691816e4bc18d2205d46a37053d383))

📦️ Build
* restrict xrft version

Seems to be cause issues in conda-forge feedstock, harmonica requires >= 1.0, match this ([`f9a17ff`](https://github.com/mdtanker/invert4geom/commit/f9a17ff8effbbd18261434619df1b9d514badc04))
* combine optional dependencies into `all` ([`d5f038b`](https://github.com/mdtanker/invert4geom/commit/d5f038ba675c5ad2c95f26e1e589a9ab0b825489))
* add optimization optional deps ([`871a870`](https://github.com/mdtanker/invert4geom/commit/871a870acba5db7adbc51297e3c8bed274990be4))
* alter dependency versions ([`82695f5`](https://github.com/mdtanker/invert4geom/commit/82695f574fa0118af5a8874dcc53d811d99b1272))
* add new dependencies ([`8d9982c`](https://github.com/mdtanker/invert4geom/commit/8d9982cd1b5d04804cd2c9f245c3d48aabafa896))
🧰 Chores / Maintenance
* add Make changelog command ([`d433a9d`](https://github.com/mdtanker/invert4geom/commit/d433a9d9a4b881e7525ee44d9303a60312fae591))
* numba-progress install from pip to conda ([`59099bf`](https://github.com/mdtanker/invert4geom/commit/59099bfa07dd082d77010c4d0e10fd78524f5527))
* move changelog template location ([`2bdeccb`](https://github.com/mdtanker/invert4geom/commit/2bdeccbf43d3c4b6b494b38f4d4724d25207d729))
* fix env.yml files ([`2735f09`](https://github.com/mdtanker/invert4geom/commit/2735f093543e59f660e8bb974de14f5ba3c6dcd8))
* seperate RTD env and testing env ([`0d1621d`](https://github.com/mdtanker/invert4geom/commit/0d1621df983e3c6eedb36afdb7395974dd3f5012))
* remove build api docs to ci.yml ([`0bf7f87`](https://github.com/mdtanker/invert4geom/commit/0bf7f8780819a9376615a027c8c6924e2cc6e372))
* add sphinx-apidoc call to ci.yml ([`9d0ff3a`](https://github.com/mdtanker/invert4geom/commit/9d0ff3a231d199a30943f8b05b065693d9c1ba76))
📖 Documentation
* replace `Unknown` with `Other` in changelog ([`e7f274a`](https://github.com/mdtanker/invert4geom/commit/e7f274a8975b7a3ab577af0be1665fd769318389))
* customize jinja changelog template ([`203c1c8`](https://github.com/mdtanker/invert4geom/commit/203c1c8775f7ec8754f4a2b137a50c0da499c16f))
* add rst files for new modules ([`b9010e5`](https://github.com/mdtanker/invert4geom/commit/b9010e562990879cf0570db2c4380bf630982c3c))
* add estimating regional field user guide ([`7e5b69b`](https://github.com/mdtanker/invert4geom/commit/7e5b69bdb4be483909530ce0c89310474ef874dc))
* add testing instructions to contrib guide ([`9c2732d`](https://github.com/mdtanker/invert4geom/commit/9c2732d6d9949895f29f0008f287c60fa7576d99))
* add module descriptions to overview ([`ae7469d`](https://github.com/mdtanker/invert4geom/commit/ae7469d52dbaea67851e28c21ca3e033484a639f))
* fix some docstrings ([`920e129`](https://github.com/mdtanker/invert4geom/commit/920e12997354b91b2d4659f75d834e47a73686c4))
* add cross_validation to pre-commit ignore ([`b8e8e86`](https://github.com/mdtanker/invert4geom/commit/b8e8e86174442c1b16ed4b268097cc56b95c84ac))
🚀 Features
* add test files for all modules ([`2c11f56`](https://github.com/mdtanker/invert4geom/commit/2c11f56fdc4e349f485295f3a616c7ef3a7b0e1e))
* add regional module ([`2d52c19`](https://github.com/mdtanker/invert4geom/commit/2d52c1924d578140a47679d30a7f37b3dcc5fea5))
* add optimization module ([`a398e12`](https://github.com/mdtanker/invert4geom/commit/a398e129a243014a0aa78ac92d7c8a9fdea24cbb))
* add synthetic regional field function ([`aeb81b2`](https://github.com/mdtanker/invert4geom/commit/aeb81b2083d477a7bbd19b93dcad3c7006d91059))
* add eq_sources_score function ([`6c132d8`](https://github.com/mdtanker/invert4geom/commit/6c132d8533fac4f30e4a537059ef2adca423283b))
* add best_spline_cv function ([`3965dcb`](https://github.com/mdtanker/invert4geom/commit/3965dcbeb7ab333d8578b74cf3c686ad96908e86))
🐛 Bug Fixes
* optional optuna Journal import ([`e0a159f`](https://github.com/mdtanker/invert4geom/commit/e0a159f6c175419fb42728ca61fba305ab66db84))
* make optimization dep imports optional ([`e7ed8a1`](https://github.com/mdtanker/invert4geom/commit/e7ed8a16fdf052688d0fd1d1dd868a55abfb1744))
* use lock_obj to fix file store for windows ([`f835c74`](https://github.com/mdtanker/invert4geom/commit/f835c74bfaeb47491f4a3f74be6b7428e2ef63a8))
* replace psutil cpu affinity with new function

used a function from a stack overlow answer which is able to get cpu core numbers for many operating systems since psutil doesn&39;t seem to work for MacOS or Windows. ([`f3bf61e`](https://github.com/mdtanker/invert4geom/commit/f3bf61e6f497d6a70551b098f2b7e3e257fa39d4))
* typos and formatting ([`9ce69c2`](https://github.com/mdtanker/invert4geom/commit/9ce69c21921ad0584f1fee6fc932ed24fd989864))
Other
* ([`99bcfac`](https://github.com/mdtanker/invert4geom/commit/99bcfac948ca9e5a169d46b1af4d8daf55b7193d))
* ([`daf3c9c`](https://github.com/mdtanker/invert4geom/commit/daf3c9ccb32c5dbee137d20b61e959247399b0dc))
* ([`cade158`](https://github.com/mdtanker/invert4geom/commit/cade1589062388546c6dd79b0471f04758d37111))

🧰 Chores / Maintenance
* add ignore option for codespell ([`bc4f597`](https://github.com/mdtanker/invert4geom/commit/bc4f5973b89f4b27885b2037b8d861732cf6240f))
* add semantic-release changelog template ([`bc93159`](https://github.com/mdtanker/invert4geom/commit/bc93159f5cd3261d5049c9b1c12c228abec3ebd9))
* add semantic release check to makefile ([`d3bb077`](https://github.com/mdtanker/invert4geom/commit/d3bb077c038394a8c66e21d9916cf38ab9c48c96))
📖 Documentation
* minor changes ([`c29c742`](https://github.com/mdtanker/invert4geom/commit/c29c74239237ed08013f6eaf1df2e90c874971c4))
* new user guide notebook

adds notebook which combines damping, density, and zref cross validations, as well as using a starting model and weighting grid. ([`1ad026a`](https://github.com/mdtanker/invert4geom/commit/1ad026a188413934c298aaff20f7eda306a3cf59))
* update user guide notebooks

To run faster, this lowers the resolution of the user guide notebooks. It also adds synthetic noise to all the examples. ([`d63c410`](https://github.com/mdtanker/invert4geom/commit/d63c410c5083078c0d20e1e4f1f840a83b58bbdf))
* update some docstrings ([`0bf4d7b`](https://github.com/mdtanker/invert4geom/commit/0bf4d7bd35900285ea5c42c29d2c23fa451f8f68))
* add references to docstrings ([`d0357a8`](https://github.com/mdtanker/invert4geom/commit/d0357a819db975295302d6aada0ba14206258aaf))
* add emojis to homepage ([`eda2938`](https://github.com/mdtanker/invert4geom/commit/eda29385c90692600469a5d9a48c123c9b2c5842))
* set nb execute to never for docs ([`ef58202`](https://github.com/mdtanker/invert4geom/commit/ef58202e4ab1e853be4924ddda3355bc902ffd00))
* edit the user guide notebooks ([`aec1fe6`](https://github.com/mdtanker/invert4geom/commit/aec1fe67409dd2db0da602483bda98c3cc6e3df0))
* add cross validation api docs ([`03c38d6`](https://github.com/mdtanker/invert4geom/commit/03c38d6fd89d8b1d3506cc865596dbaf75afb108))
* remove tqdm mapping ([`088409e`](https://github.com/mdtanker/invert4geom/commit/088409e3ae897e213b6c51d4d59ba5c5a2300b8b))
🚀 Features
* add 2 parameter cross validation plotting ([`2d1269e`](https://github.com/mdtanker/invert4geom/commit/2d1269ebacbe4149642c8cd3484b7ffa65554b83))
* add contaminate function for synthetic noise ([`3a1cf8d`](https://github.com/mdtanker/invert4geom/commit/3a1cf8d1b081057d0f8e19e611bab30f807fb4a5))
🐛 Bug Fixes
* add reference level to iteration plots ([`960eb44`](https://github.com/mdtanker/invert4geom/commit/960eb44cc5956b9795dbc9b18bcdd627eec7ea17))
✏️ Formatting
* formatting ([`66b0a56`](https://github.com/mdtanker/invert4geom/commit/66b0a56aaba2b590e2594fd2bd31735823959128))
Other
* ([`86c611b`](https://github.com/mdtanker/invert4geom/commit/86c611b322de101c79fa8072718418c8a0b1a56f))

🐛 Bug Fixes
* forcing a new patch ([`9a73194`](https://github.com/mdtanker/invert4geom/commit/9a73194ea5b0e22e4422ed04f2c180c15de29867))
Other
* ([`2546ee4`](https://github.com/mdtanker/invert4geom/commit/2546ee401201509409c932cf8111370142911599))