Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README, README.rst and packaging #143

Open
ltalirz opened this issue Jul 26, 2019 · 3 comments
Open

README, README.rst and packaging #143

ltalirz opened this issue Jul 26, 2019 · 3 comments

Comments

@ltalirz
Copy link

ltalirz commented Jul 26, 2019

Hi @victorlei , thanks for making smop!

I came across the github page first, which displays the README.rst and it took me quite a while to figure out how to actually run smop.

  • The easy_install instructions don't mention that a smop executable is added to the path (which actually worked perfectly fine when I realized this).
  • the "use without installation" instructions via python main.py ... don't work for me (even after installation via pip) due to import errors (see relative import path #123), both under python 2.7 and python3

I then realized that, besides README.rst, there is also another README with slightly different content (also written in RST as far as I can tell).
I'd be happy to prepare a PR that

  • merges the two README files (+ INSTALL, NEWS.rst)
  • makes sure to mention early on the various installation options (pip install smop, clone + python setup.py), including how to actually run smop
  • adds the README to the page on PyPI (will happen at next release)

let me know

@RobBW
Copy link

RobBW commented Jul 28, 2019 via email

@RichardoTiono
Copy link

Hello @ltalirz would you be able to share how to run or maybe install this correctly ? So far I also encounter same problem as you stated on use without installation. And installing through pip3 also result in deadend, I mean it says successfully installed yet when I use smop --version it cannot find it. I also tried @RobBW suggestion but it has lots of error when I try to convert

@ltalirz
Copy link
Author

ltalirz commented Sep 8, 2019

@RichardoTiono I believe the smop executable obtained via pip install smop worked fine for me to translate a simple matlab program.
Of course, I guess smop is not perfect, so in more complicated cases it may fail.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants