msoon / PyMonsoon

Monsoon Power Monitor Python Library
MIT License
55 stars 23 forks source link

Installation / Documentation mismatch #8

Open AtomicAntimatter opened 7 years ago

AtomicAntimatter commented 7 years ago

issue is just capitalization of module name (Monsoon vs monsoon)

after installing monsoon through pip install monsoon

to import, it had to be import Monsoon

Documentation refers to the lowercase import which will fail

 import monsoon.LVPM as LVPM
 import monsoon.sampleEngine as sampleEngine
 import monsoon.Operations as op
luiscruz commented 6 years ago

I'd suggest changing the module name to lowercase 'monsoon', according to Python style guide.

MaxwellVolz commented 11 months ago

Came across this issue today. Still relevant.

It appears that there may be a discrepancy between the package installation directory and the recommended import statement in the package's documentation.

To complete Sampling from the main channel from Power Monitor Python API.pdf:

import Monsoon.LVPM as LVPM
import Monsoon.sampleEngine as sampleEngine