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

Add documentation to tem_tutorial.ipynb for simSPI/path_config.yaml #132

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

geoffwoollard
Copy link
Contributor

@geoffwoollard geoffwoollard commented Jun 24, 2022

Checklist

Verify that your PR checks all the following items.

  • The pull request (PR) has a clear and explanatory title.
  • The description of this PR links to relevant GitHub issues.
  • Unit tests have been added in the tests folder:
    • in the test_*.py files corresponding the files modified by this PR,
    • for each function added by this PR.
  • The code of this PR is properly documented, with docstrings following simSPI conventions.
  • The PR passes the DeepSource GitHub Actions workflow (refer to comment below).
  • The PR passes Test and Lint GitHub Actions workflows. (refer to comment below)

If some items are not checked, mark your PR as draft (Look for "Still in progress? Convert to Draft" on your PR) . Only mark the PR as "Ready for review" if all the items above are checked.

If you do not know how to address some items, reach out to a maintainer by requesting reviewers.

If some items cannot be addressed, explain the reason in the Description of your PR, and mark the PR ready for review

Description

Issue

Closes #131

Additional context

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@geoffwoollard geoffwoollard added the documentation Improvements or additions to documentation label Jun 24, 2022
@geoffwoollard geoffwoollard self-assigned this Jun 24, 2022
@codecov
Copy link

codecov bot commented Jun 24, 2022

Codecov Report

Merging #132 (75dbbc0) into master (1bab48a) will not change coverage.
The diff coverage is n/a.

❗ Current head 75dbbc0 differs from pull request most recent head 02c4625. Consider uploading reports for the commit 02c4625 to get more accurate results

@@           Coverage Diff           @@
##           master     #132   +/-   ##
=======================================
  Coverage   98.12%   98.12%           
=======================================
  Files          15       15           
  Lines         744      744           
=======================================
  Hits          730      730           
  Misses         14       14           

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 1bab48a...02c4625. Read the comment docs.

@geoffwoollard
Copy link
Contributor Author

Actually, this is resolved. See comments in issue.

@geoffwoollard
Copy link
Contributor Author

I spoke too soon, there is actually two path_config.yaml files:

  • simSPI/path_config.yaml
    • has output_dir: './simSPI/temp_workspace/output/'
  • simSPI/notebooks/path_config.yaml
    • has output_dir: './notebooks/'

So I think the comment I added to tem_tutorial.ipynb is helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation to tem_tutorial.ipynb for simSPI/path_config.yaml
1 participant