nanograv / enterprise

ENTERPRISE (Enhanced Numerical Toolbox Enabling a Robust PulsaR Inference SuitE) is a pulsar timing analysis code, aimed at noise analysis, gravitational-wave searches, and timing model analysis.
https://enterprise.readthedocs.io
MIT License
65 stars 67 forks source link

add conda stuff to docs #336

Closed paulthebaker closed 11 months ago

paulthebaker commented 1 year ago

I checked the updated Contributing section conda commands that install the dependencies by copy/pasting.

The main tests worked, but I got a bunch black errors from the linter on code that I didn't touch...

codecov[bot] commented 1 year ago

Codecov Report

Merging #336 (320dc0d) into dev (a4dd7b6) will not change coverage. The diff coverage is n/a.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/nanograv/enterprise/pull/336/graphs/tree.svg?width=650&height=150&src=pr&token=7Sjk8cLA85&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv)](https://app.codecov.io/gh/nanograv/enterprise/pull/336?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv) ```diff @@ Coverage Diff @@ ## dev #336 +/- ## ======================================= Coverage 88.31% 88.31% ======================================= Files 13 13 Lines 3012 3012 ======================================= Hits 2660 2660 Misses 352 352 ``` ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/nanograv/enterprise/pull/336?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/nanograv/enterprise/pull/336?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv). Last update [a4dd7b6...320dc0d](https://app.codecov.io/gh/nanograv/enterprise/pull/336?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv).
paulthebaker commented 1 year ago

The tests are passing, so there must be some difference in the configuration of the most recent version of black and what's being used in the tests.

paulthebaker commented 1 year ago

I'm currently trying to figure out issue #339 before merging this.

aarchiba commented 1 year ago

The tests are passing, so there must be some difference in the configuration of the most recent version of black and what's being used in the tests.

The black stability policy basically says you need to bump your version of black once a year. https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy

vhaasteren commented 11 months ago

Hi @paulthebaker,

This is ready to merge. Any reason why not to quickly change the conda create line to the following?

$ conda create -n ent_dev -y -c conda-forge python=3.9 black=22.3.0 flake8 sphinx_rtd_theme pytest-cov

She is right that it's faster. Regardless, ready merge, so happy to pull the trigger