Lenty / SLiCAP_python

Open-source version of SLiCAP, implemented in python
Other
33 stars 15 forks source link

Help() has no effect in Jupyter Notebook #23

Closed ArthurAdmiraal closed 2 years ago

ArthurAdmiraal commented 3 years ago

Hi! I am running:

from SLiCAP import *
my_project = initProject('my_firstSLiCAP_project')
Help()

But don't see the webpage mentioned in (the documentation)[https://analog-electronics.eu/slicap/SLiCAP_python/docs/html/userguide/install.html#getting-help] opening up with Firefox on OS X and Python 3.9. Have you run into this before?

Lenty commented 3 years ago

Hi! I have ran it locally on my Fedora 33 install with python 3.8.3. For me it works as designed (it opens the local 'help' web page): image

Could you check in the SLiCAP_python/SLiCAP/SLiCAPsettings/SLiCAPsettings.py what is defined as DOCPATH?

ArthurAdmiraal commented 3 years ago

SLiCAPsetting.py contains:

SYSINSTALL = r' '
LIBCOREPATH = r'/Users/arthuradmiraal/Documents/TU\ Delft/Master/StructuredElectronicsDesign/SLiCAP/SLiCAP /lib'
DOCPATH     = r'/Users/arthuradmiraal/Documents/TU\ Delft/Master/StructuredElectronicsDesign/SLiCAP/SLiCAP /docs'

Interestingly, the space in the file path has been escaped even though it's a string and I apparently added a space on installation. However, SLiCAP did create the /Users/arthuradmiraal/Documents/TU\ Delft/Master/StructuredElectronicsDesign/SLiCAP/SLiCAP /docs path, including the space. It includes index.html amongst other things.

Runnning iPython in the command line, I obtain:

Python 3.9.0 (default, Oct 27 2020, 14:13:35) 
Type 'copyright', 'credits' or 'license' for more information
IPython 7.19.0 -- An enhanced Interactive Python. Type '?' for help.

In [1]: from SLiCAP import *
Succesfully self-tested the Maxima command.
SLiCAP Version matches with the latest release of SLiCAP on github.
Running from an Ipython enviroment, importing SLiCAPnotebook.

In [2]: Help()
50:51: syntax error: Verwachtte “"” maar vond onbekend token. (-2741)
151:152: syntax error: Verwachtte “"” maar vond onbekend token. (-2741)
152:153: syntax error: Verwachtte “"” maar vond onbekend token. (-2741)
151:152: syntax error: Verwachtte “"” maar vond onbekend token. (-2741)

In [3]: 

Which gives some errors I didn't see with the web interface.

Lenty commented 3 years ago

Hmm, this looks like somewhere incorrect quotes are added or perhaps the not escaped space is causing some errors. I do not have a mac to try to debug it myself. However, what could be an option is to open an ipython console and run the following (with the path to your documentation): image You can also rerun the installer and I believe it should remove the space (otherwise there is likely a bug in the installer).

ArthurAdmiraal commented 3 years ago

I just reran the installer with 1.0.1, and can confirm that the space and escaped space were due to user error. No luck with webbrowser.open_new though, although it does return True.