tylerni7 / missile-tid

Identifying missile launch signatures from traveling ionic disturbances using GPS data
BSD 3-Clause "New" or "Revised" License
130 stars 15 forks source link

Changed the README and CONTRIBUTING files to include updated install … #37

Closed MGNute closed 1 year ago

MGNute commented 1 year ago

I went through and did an install of the library today and based on that experience I have updated the install documents to reflect all the required steps. One thing that is an issue is that we don't have a setup.py file anymore so all documentation based on that is no longer operative, so I've replaced that where possible. In the CONTRIBUTING.rst file there is a step that requires the setup file in order to run tests, and in that case I added a note that the testing step should be "done manually", and added a # to comment that line out in the commands.

tylerni7 commented 1 year ago

just one minor thing (should run tests with pytest ). Aside from that seems fine I think

MGNute commented 1 year ago

Is there a pytest command I can put there as an example in lieu of the setup.py line now? I’ve never used pytest before.

On Fri, Jul 14, 2023 at 12:24 AM tylerni7 @.***> wrote:

just one minor thing (should run tests with pytest ). Aside from that seems fine I think

— Reply to this email directly, view it on GitHub https://github.com/tylerni7/missile-tid/pull/37#issuecomment-1635249231, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFZ47PO5CE5U5AVBWMNSXLXQDCYDANCNFSM6AAAAAA2JWYRGM . You are receiving this because you authored the thread.Message ID: @.***>

-- Michael Nute @.***

tylerni7 commented 1 year ago

The command should be pytest

MGNute commented 1 year ago

The command should be pytest

Ahh, my bad. I read that awkwardly in my email. I've added that change in the latest commit. Thanks @tylerni7!