-
Notifications
You must be signed in to change notification settings - Fork 101
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
Add more information in README.md #210
Conversation
f6fd84a
to
d17b90f
Compare
a5acafc
to
2c56f62
Compare
Since static linking issue can occur in macOS, using `ldd $(which python) | grep libpython` could be confusing.
"`pyjulia`" and "pyjulia" are replaced with "PyJulia" (unless it appears as a part of URL). I'm OK with "pyjulia". Using "PyJulia" only because it appears as the title of README.md.
@stevengj Can you have a look at updated README? Especially the notes on the pre-compilation cache? https://github.com/tkf/pyjulia/blob/readme/README.md#pre-compilation-mechanism-in-julia-10 |
Here is how it'd be rendered in PyPI https://test.pypi.org/project/julia/0.2.0.dev1/ |
``` | ||
pip install julia | ||
```console | ||
$ python3 -m pip install --user julia |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I switched pip
to python3 -m pip
everywhere since it's a common pitfall that pip
uses different Python executable than python
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... and added --user
since that's likely what they want.
Fine, although what we did previously was not technically monkey patching. I’m not sure it is a good idea to try to explain what is going wrong in the readme. Just say that pecompilation doesn’t work with 1.0 and link the issue. |
We are changing the path of the Julia executable which is conceptually like mutating a function. But it is done through the public API (but in an implementation-dependent manner) so I guess I'm stretching it somewhat to call it a monkey patch. The pre-compilation issue was asked by multiple users (including me) so I think it would be nice to explain it in some details. How about blending it into |
Here is the new fake-julia documentation I suggest: https://github.com/tkf/pyjulia/tree/readme/julia/fake-julia |
@stevengj Thanks a lot for reviewing! |
Preview: https://github.com/tkf/pyjulia/blob/readme/README.md
TODO:
conda-forge
? PyJulia does not work with Julia 1.0 & 0.7 with Python installed via Conda/Ubuntu/(what else?) #185 (comment); Waiting for Are you switching to dynamic linking? conda-forge/python-feedstock#222%load_ext julia.magic
!