{"id":20586570,"url":"https://github.com/emsig/article-fdesign","last_synced_at":"2025-04-14T21:26:19.118Z","repository":{"id":130795917,"uuid":"115236593","full_name":"emsig/article-fdesign","owner":"emsig","description":"Werthmüller, D., K. Key, and E. Slob, 2019, A tool for designing digital filters for the Hankel and Fourier transforms in potential, diffusive, and wavefield modeling: Geophysics, 84(2), F47-F56.","archived":false,"fork":false,"pushed_at":"2023-07-04T09:41:48.000Z","size":58433,"stargazers_count":4,"open_issues_count":2,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T09:36:21.953Z","etag":null,"topics":["digital-linear-filters","empymod","fourier-transform","geophysics","hankel-tranform"],"latest_commit_sha":null,"homepage":"https://doi.org/10.1190/geo2018-0069.1","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-sa-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emsig.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-12-24T03:11:59.000Z","updated_at":"2024-06-26T08:43:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"c1a3cf4e-e220-4d06-8bf9-83fea4a05e57","html_url":"https://github.com/emsig/article-fdesign","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsig%2Farticle-fdesign","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsig%2Farticle-fdesign/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsig%2Farticle-fdesign/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsig%2Farticle-fdesign/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emsig","download_url":"https://codeload.github.com/emsig/article-fdesign/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248962048,"owners_count":21190123,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["digital-linear-filters","empymod","fourier-transform","geophysics","hankel-tranform"],"created_at":"2024-11-16T07:12:12.371Z","updated_at":"2025-04-14T21:26:19.094Z","avatar_url":"https://github.com/emsig.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# A tool for designing digital filters for the Hankel and Fourier transforms in potential, diffusive, and wavefield modeling\n\n\u003e Werthmüller, D., K. Key, and E. Slob, 2019, A tool for designing digital\n\u003e filters for the Hankel and Fourier transforms in potential, diffusive, and\n\u003e wavefield modeling: Geophysics, 84(2), F47-F56; DOI:\n\u003e [10.1190/geo2018-0069.1](http://doi.org/10.1190/geo2018-0069.1).\n\n## Manuscript for Geophysics paper\n\nDirectory contains the LaTeX source of the manuscript as well as the notebooks\nto reproduce all the figures.\n\n\n## History\n\n1. First submitted 22/01/2018 to Geophysics for the Software \u0026 Algorithms\n   Section. The stable release at the time of submission of `empymod` was\n   [Version 1.5.0](https://github.com/empymod/empymod/releases/tag/v1.5.0)\n   and of `empyscripts` was\n   [Version 0.2.0](https://github.com/empymod/empyscripts/releases/tag/v0.2.0).\n\n    * Re-submitted 22/02/2018. The stable release at the time of submission of\n      `empymod` was\n      [Version 1.5.0](https://github.com/empymod/empymod/releases/tag/v1.5.0)\n      and of `empyscripts` was\n      [Version  0.3.0](https://github.com/empymod/empyscripts/releases/tag/v0.3.0).\n      There is no difference in the article between the first and the second\n      submission. In the first submission only the file `fdesign.py` was\n      submitted as source code to Geophysics. The second submission contains a\n      zip-file with the current version of `empymod` and `empyscripts` as well\n      as all the notebooks to reproduce the figures.\n\n    * Re-submitted 12/03/2018. The only difference is that all binary files\n      were replaced by plain ASCII files, due to restrictions by the SEG, and a\n      routine to convert the ASCII files into the binary format was added.\n\n2. Re-submitted 19/06/2018. The stable release at the time of submission of\n   `empymod` was\n   [Version 1.7.1](https://github.com/empymod/empymod/releases/tag/v1.7.1).\n\n3. Final manuscript submitted 21/11/2018. The stable release at the time of\n   submission of `empymod` was\n   [Version 1.8.1](https://github.com/empymod/empymod/releases/tag/v1.8.1).\n\n\n## Instructions to reproduce the figures with the zip-file provided by the SEG\n\nThe piece of code related to the publication is `fdesign.py`, located in the\nfolder `notebooks/empymod/scripts` in the zip-file or in the folder\n`empymod/scripts` on \u003chttps://github.com/empymod/empymod\u003e.\n\n- The zip-file provided by the SEG contains all files required to reproduce the\n  figures of the article.\n- Have a look at \u003chttps://empymod.github.io\u003e for the latest version of\n  `empymod`, further instructions, the manual, and many more examples and\n  information.\n- For a maintained version of the figures in the article see\n  \u003chttps://github.com/empymod/article-fdesign\u003e.\n\n\n## Requirements\n\nRequired are Python version 3.5 or higher and the modules `NumPy` and `SciPy`\nto use `fdesign`. To reproduce the figures with the provided notebooks the\nmodules `IPython`, `Jupyter`, and `matplotlib` are required additionally.\n\nIf you are new to Python I recommend using a Python distribution, which will\nensure that all dependencies are met, specifically properly compiled versions\nof `NumPy` and `SciPy`; I recommend using Anaconda, \u003chttps://www.anaconda.com\u003e.\n\nThe required module `empymod` is included in the provided source code (folder\nin which this README resides). Have a look at \u003chttps://empymod.github.io\u003e if\nyou want to install the latest version of them.\n\n\n## Reproducing\n\nStart `Jupyter` and navigate to the notebooks-folder. The notebooks to\nreproduce the figures in the article are:\n\n1. **01-Figure_InversionCriterium.ipynb**: Figure 1.\n2. **02-03-04-Figure_ExampleDesign.ipynb**: Figures 2, 3, and 4.\n3. **05-06-Figure_KongKey.ipynb**: Figures 5 and 6.\n4. **07-08-Figure_Errors.ipynb**: Figures 7 and 8.\n5. **09-Figure_GPR.ipynb**: Figure 9.\n6. **10-11_Figure_GPR-f-t.ipynb**: Figures 10 and 11.\n7. **A-GPR-create-data.ipynb**: Creation of data for Figures 9-11 (see\n   comments below).\n\nSome comments regarding `A-GPR-create-data.ipynb`:\n- If you want to reproduce the data for `EMmod` too, you will have to install\n  `EMmod` as well (see \u003chttp://software.seg.org/2015/0001\u003e).\n- If you want to run the whole file, including the cell for `EMmod`, the whole\n  script will take likely a day to run.\n- The required data-zips are provided in the `notebooks/data`-directory on\n  \u003chttps://github.com/empymod/article-fdesign\u003e, so you can get them there\n  instead of running `A-GPR-create-data.ipynb` in order to run\n  `09-Figure_GPR.ipynb` and `10-11-Figure_GPR-f-t.ipynb`.\n\nOther notebooks in the notebooks-folder:\n\n8. **AnalyticalTransformPairs.ipynb**: Visual check of all theoretical\n   transform pairs included in ``fdesign``.\n9. **Errors-AllFilters.ipynb**: Check the errors as in Figure 7 but for all\n   filters included in `empymod`.\n10. **Example-using-empymod.ipynb**: Create a filter using `empymod` or your own\n    theoretical transform pairs.\n11. **Filter-wer2001.ipynb**: Creation of the 2001 pt filter.\n12. **Filter-wer201-SineCosine.ipynb**: Creation of a 201 pt Fourier filter.\n13. **Filter-wer201.ipynb**: Creation of the 201 pt filter.\n14. **GPR-RPD.ipynb**: Another error plot for the GPR result.\n\n\nMaintained versions of the notebooks can be found on\n\u003chttps://github.com/empymod/article-fdesign\u003e.\n\n\n## Note\n\nThe final edited version is \u0026copy; Society of Exploration Geophysicists SEG.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femsig%2Farticle-fdesign","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femsig%2Farticle-fdesign","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femsig%2Farticle-fdesign/lists"}