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

Update README with links to docs and new dependencies #87

Merged
merged 2 commits into from
May 1, 2018

Conversation

philbull
Copy link
Collaborator

@philbull philbull commented May 1, 2018

No description provided.

@philbull philbull self-assigned this May 1, 2018
@philbull philbull added this to the Ready for IDR 2.1 analysis milestone May 1, 2018
@coveralls
Copy link

coveralls commented May 1, 2018

Coverage Status

Coverage increased (+0.1%) to 92.108% when pulling 13cbfc9 on readme-update-docs into ec8b94a on master.

@nkern
Copy link
Member

nkern commented May 1, 2018

ooh, great. our README is severely out of date. Can you add to the end of the README something along the lines of

## Running `hera_pspec`

See [`examples/PS_estimation_examples.ipynb`](link) for a brief tutorial on how to create delay spectra with the various modules in `hera_pspec`.

See [`examples/PSpecBeam_tutorial.ipynb`](link) for a brief tutorial on handling beam objects in `hera_pspec`.

@philbull
Copy link
Collaborator Author

philbull commented May 1, 2018

Done. Thanks!

@philbull philbull merged commit 350e3b8 into master May 1, 2018
@philbull philbull deleted the readme-update-docs branch May 1, 2018 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants