Installation and usage instructions updated#17
Conversation
gauravharsha
left a comment
gauravharsha
left a comment
There was a problem hiding this comment.
This is really comprehensive documentation. But perhaps it is a bit too simplified in some places.
For instance, we should not ask user to navigate to the drudge directory and then launch VSCode. This should not be required if the install command is executed properly and with permissions.
Alternatively, if one can only manage to build and not install the files, I prefer (and you have already included) the use of PYTHONPATH environment variable.
install.md
Outdated
| python3 setup.py build | ||
| python3 setup.py install | ||
| ``` | ||
| The first two lines set necessary environment variables, so python knows where to find our python imports, and to utilize local dummy_spark instead of apache spark (which isn't quite working on python3.9 yet). |
There was a problem hiding this comment.
We should include a "Known Issues" section in the README.md or install.md to note incompatibilities like apache spark.
| cp build/lib.linux-x86_64-cpython-39/drudge/wickcore.cpython-39-x86_64-linux-gnu.so drudge/ | ||
| cp build/lib.linux-x86_64-cpython-39/drudge/canonpy.cpython-39-x86_64-linux-gnu.so drudge/ |
There was a problem hiding this comment.
I believe the copying of compiled CPython libraries is not required if python setup.py install is successfully executed. @Wholinator can you double check?
install.md
Outdated
| ### That's it! | ||
| It should be completely installed now. If you now run `code .` from the drudge base directory you'll open a vscode window with the conda environment activated, the environment variables set, and the correct interpreter selected. | ||
|
|
||
| If you should close this vscode window and want to open it again you'll need to do a couple steps |
There was a problem hiding this comment.
Same thing as above -- if drudge is "installed" in the Conda site-packages, you can pretty much open VSCode from anywhere and import drudge and related submodules.
| ### 2) Conda Environment Activated | ||
| In the terminal in the bottom portion of the window (you can open with `ctrl/cmd + ~` if it's closed) with the `TERMINAL` tab selected you should see your command prompt. At the very left there might be some things in parenthesis like `(drudge) (base)`. You want to ensure that your drudge environment name is here. If it's not, simply run |
|
We should eventually consider using a more robust solution, e.g., pixi. But I agree that for now this ad hoc solution should be good enough to move us forward. |
…ent to copy compiled shared object files with updated pythonpath requirement, removed language assuming vscode usage
|
As we chatted about in person, the |
|
Superseded by #22 |
3 participants
Meticulous installation and usage instructions are included.
Instructions for:
These are all labeled as "Local Installation" or "Development" usage.