Adds link to GitHub on main page and contributing page in docs site. #179
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…stride_dependency Removing stride dependency
…o_pypi_main_repo Releasing to pypi main repo
…ing_poetry_lock_file Regenerating poetry lock file
…_stride_dependency_change Changing scipy dependency of ndk so that it doesn't conflict with stride's dependency
…ng_mkdocs_gallery Downgrading mkdocs gallery
…_bounds_removal Adding bounds to operator. Fixing devito version
…_docs Mentioning libomp in the installation instructions
…ise#145) * initial port of ultrasound imaging experiment * Match _scenario_3.py to update functional API * Update in order to render layout properly * Port notebook up to point of simulate_pulse * Bugfix for receiver locations * Run poetry update * add xarray as dependency for beamforming code * Add jupyter widgets to allow use of tqdm.notebook * Scan-line notebook now enabled, with the workaround-method for recording * Move receiver config from scenario special subclass to _base.py * Port multi-plane imaging to new API * Add comments for fields * Run the notebooks to generate output * Lint code * Some mypy type-hint fixes * Fix mypy type hint error * Fix type-hint warnings: variable reassignment, xarray vs numpy ufunc etc * Suppress type error where can't infer type * Fix linting issues * Add test for beamform and demodulate * Add Scenario3 to built-in tests and mark as integration test similar to test_compilation * Rename _shots.py internal function properly * Fix test_base to work with new receiver_coords argument * Fix test_shots to accomodate new receiver_coords parameter * Lint code * Fix spelling errors * Refactor optimize_f_number into its own function * Add args docstring for delay_and_sum_matrix function * Clean up redundant variable * Swap labeling of x/z dimension order: fix * Refactor time-of-flight calculation to its own function * Refactor out aperture angle of view calculation * Split out interp weights to its own helper function * Lint test_beamform.py * Refactor out sparse matrix indexing code * fix spelling * minor fixes * Convert ipynb jupyter notebooks to ipython scripts for gallery on CI * Fix lint and mypy errors * Fix mkdocs format, which requires standard Python docstring * Fix documentation formatting * Update minor text formatting --------- Co-authored-by: d-lucena <[email protected]>
…erprise#147) * Add method to slice 3d result * Add warning for metrics * Change target warning to use try/except * Change target getter, add checks for None target * Revert target getter, remove checks, add tests * Fix slicing alternate source types * Add suggestions, alter validate function * Drop duplicate _validate_slice_args
* Add link check workflow action file * Added link checker config to ignore linked files * Fix config patterns * Fix link check config patterns * Fixed config file path * Switched link checker to handle linked files
* Move webpage.html files into their own folder, as they are done in local MacOS build * Revert "Move webpage.html files into their own folder, as they are done in local MacOS build" This reverts commit a9b2e4a. * Remove mkdocs offline plugin, which conflicts with how the gallery examples link to images * no need to pass in OFFLINE environment variable since it is no longer used * Revert "no need to pass in OFFLINE environment variable since it is no longer used" This reverts commit 208318e. * Revert "Remove mkdocs offline plugin, which conflicts with how the gallery examples link to images" This reverts commit ca4a389. * Add mkdocs-offline-links-plugin as a dependency and include as a mkdocs.yml plugin * Update mkdocs-offline plugin to new home at agencyenterprise * Update poetry.lock
…enterprise#151) * Add Scenario2 variant that mirrors Benchmark 7 of Aubry et al. (2022) * Fix spellcheck
…terprise#163) * Pin stride version in all the places we specify pip install * Fix dead link
* various documentation changes and corrections * homer example * Fixing Homer Example added * reversion commit * formatting with lint * formatting with lint * added color scale control to steady state renders * Revert "added color scale control to steady state renders" This reverts commit 13c1ffd. * removed comment * Update docs/examples/plot_homer.py docs update Co-authored-by: charles <[email protected]> * fixed documentation commenting * fixed dead link --------- Co-authored-by: charles <[email protected]>
…ar interpolation (agencyenterprise#177) * Add interp dimension in nearest-neighbors interpolation to match * Add test for using nearest-neighbors interpolation for delay-and-sum * Lint code
There was no obvious link to GitHub on the main page. I eventually found it in the linting badge, but it was very non-obvious there. Everything else in the docs just links to various places *besides* the GitHub repository.
MicahZoltu
changed the title
|
Thanks for your contribution @MicahZoltu ! I had to open a new PR with your changes as |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was no obvious link to GitHub on the main page. I eventually found it in the linting badge, but it was very non-obvious there. Everything else in the docs just links to various places besides the GitHub repository.
The Contributing page also was conspicuously missing any link to the GitHub repository.