mdolab / CMPLXFOIL

GNU General Public License v2.0
29 stars 20 forks source link

Add conda installation to docs #20

Closed A-CGray closed 1 year ago

A-CGray commented 1 year ago

Purpose

Now that CMPLXFOIL can be installed with conda I added a section explaining this in the docs

Expected time until merged

3 seconds

Type of change

Testing

Checklist

codecov[bot] commented 1 year ago

Codecov Report

Merging #20 (c25b51b) into main (99bdfb9) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #20   +/-   ##
=======================================
  Coverage   78.36%   78.36%           
=======================================
  Files           4        4           
  Lines         564      564           
=======================================
  Hits          442      442           
  Misses        122      122           

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

A-CGray commented 1 year ago

Thanks for the update! What do you think about adding the line “conda install -c conda-forge cmplxfoil” directly into our docs (and maybe saying it supports Linux and macOS) to avoid another click? Sorry this review is a little late since it’s not within 3 sec.

Could do, I thought I'd just link to the official conda forge page so we didn't have to worry about keeping something in our docs up to date with the correct installation instructions there, but maybe there is very little chance of the installation command changing?

eytanadler commented 1 year ago

Thanks for the update! What do you think about adding the line “conda install -c conda-forge cmplxfoil” directly into our docs (and maybe saying it supports Linux and macOS) to avoid another click? Sorry this review is a little late since it’s not within 3 sec.

Could do, I thought I'd just link to the official conda forge page so we didn't have to worry about keeping something in our docs up to date with the correct installation instructions there, but maybe there is very little chance of the installation command changing?

I'd think they'd do their best to avoid changing it since it could break all sorts of installation scripts people have. I just think it's nice as a user to go straight to our installation page and know the one line they need to type. But if you feel strongly about not including it I won't filibuster this PR over it.

A-CGray commented 1 year ago

Bump @bernardopacini