logsdail / carmm

Scripts for creation, manipulation and analysis of geometric and electronic structure of molecular models
GNU General Public License v3.0
5 stars 17 forks source link

Update README.md #166

Closed logsdail closed 3 months ago

logsdail commented 3 months ago

@AkashHiregange I've removed the change you made as that just indicates the JUPYTER_PATH is not setup correctly, and it is a hack to resolve. We should only be championing solutions that are best practice!

I also need to resolve that the Binder link doesn't work - that I will do here.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 88.35%. Comparing base (c0a1b4a) to head (4665bf4).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #166 +/- ## ======================================= Coverage 88.35% 88.35% ======================================= Files 82 82 Lines 3316 3316 ======================================= Hits 2930 2930 Misses 386 386 ``` | [Flag](https://app.codecov.io/gh/logsdail/carmm/pull/166/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Andrew+Logsdail) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/logsdail/carmm/pull/166/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Andrew+Logsdail) | `88.35% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Andrew+Logsdail#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

AkashHiregange commented 3 months ago

@AkashHiregange I've removed the change you made as that just indicates the JUPYTER_PATH is not setup correctly, and it is a hack to resolve. We should only be championing solutions that are best practice!

I also need to resolve that the Binder link doesn't work - that I will do here.

On Linux, the JUPYTER_PATH works perfectly fine for me. However, I found that setting the JUPYTER_PATH was quite challenging on windows and hence used this hack.

logsdail commented 3 months ago

@AkashHiregange Ah OK - thanks for confirming. Perhaps then we just state on Linux do this ... and on Windows do that ....?

(As presented, it didn't give this information)