Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Documentation for Parallel execution with Numba and OpenMP #1481

Merged
merged 6 commits into from Mar 19, 2021

Conversation

aribalam
Copy link
Contributor

Description

Fixes #1376
This PR adds a clear documentation to achieve parallelisation in code using Numba and OpenMP, using configuration parameters such as nthreads.
The old documentation has been moved from the Installation section and a new section is created to provide the instructions. (as advised by @andrewfullard).
Relevant links has also been added.

@andrewfullard @wkerzendorf Kindly review.

Motivation and Context

How Has This Been Tested?

  • Testing pipeline
  • Reference Data Comparison following these instructions
  • Other (please describe)

Screenshots (if appropriate):

The Documentation preview has been made available in https://aribalam.github.io/tardis/

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • None of the above (Documentation fix)

Checklist:

  • My code follows the code style of this project
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have built the documentation on my fork following these instructions
  • I have assigned and requested two reviewers for this pull request

@codecov
Copy link

codecov bot commented Mar 14, 2021

Codecov Report

Merging #1481 (cba2f57) into master (9497250) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1481   +/-   ##
=======================================
  Coverage   71.13%   71.13%           
=======================================
  Files          67       67           
  Lines        5523     5523           
=======================================
  Hits         3929     3929           
  Misses       1594     1594           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9497250...41cd3e1. Read the comment docs.

@andrewfullard andrewfullard merged commit 47ed0ce into tardis-sn:master Mar 19, 2021
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
…dis-sn#1481)

* removed openmp requirements from the installation docs

* added section for parallel execution

* added parallelisation section to toctree

* added ref to parallelisation section in using formal integral section

* empty commit

* made suggested changes
@andrewfullard andrewfullard added this to Done in Documentation Jan 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

Add documentation for parallel numba execution
3 participants