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

Updated readme #147

Merged
merged 10 commits into from
Nov 3, 2021
Merged

Updated readme #147

merged 10 commits into from
Nov 3, 2021

Conversation

pjmaechling
Copy link
Collaborator

pyCSEP Pull Request Checklist

Please check out the contributing guidelines for some tips
on making pull requests to pyCSEP.

Fixes issue #(please fill in or delete if not needed).

Type of change:

Please delete options that are not relevant.

  • 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)
  • Documentation update (this pull request adds no new code)
  • Unpublished science feature (This may require a science review)
  • This change requires a documentation update

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@wsavran
Copy link
Collaborator

wsavran commented Nov 1, 2021

@pjmaechling this looks really good. i like the new format for the readme file and adding the codemeta and credits.md. i will share smoe comments about the readme.md file. overall, i think these changes are a major improvement.

* updated links to images
* changed example snippet to include plotting
* minor text changes
@wsavran
Copy link
Collaborator

wsavran commented Nov 3, 2021

@pjmaechling i made some small edits to readme.md file. when the CI finished ill merge the pr

@codecov-commenter
Copy link

Codecov Report

Merging #147 (3939290) into master (6d0bd2c) will not change coverage.
The diff coverage is n/a.

❗ Current head 3939290 differs from pull request most recent head aa65b54. Consider uploading reports for the commit aa65b54 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master     #147   +/-   ##
=======================================
  Coverage   56.48%   56.48%           
=======================================
  Files          19       19           
  Lines        3233     3233           
  Branches      479      479           
=======================================
  Hits         1826     1826           
  Misses       1288     1288           
  Partials      119      119           

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 6d0bd2c...aa65b54. Read the comment docs.

@wsavran wsavran merged commit 9e53c0a into SCECcode:master Nov 3, 2021
@wsavran
Copy link
Collaborator

wsavran commented Nov 3, 2021

merging into master. thanks for the contribution @pjmaechling! feel free to delete that branch.

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

Successfully merging this pull request may close these issues.

3 participants