8000 Add IPython as nicer Python environment by MakisH · Pull Request #39 · precice/vm · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add IPython as nicer Python environment #39

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

Merged
merged 1 commit into from
Mar 6, 2022
Merged

Add IPython as nicer Python environment #39

merged 1 commit into from
Mar 6, 2022

Conversation

MakisH
Copy link
Member
@MakisH MakisH commented Feb 21, 2022

@carlosal1015 suggested that we also add Jupyter (just the command line, not the full Notebooks environment) to get suggestions when writing Python code.

@BenjaminRodenberg or @IshaanDesai approve if you think this is a good idea. If you want to recommend more Python-related tools that would be useful in the VM (but not very large to install), this would be great!

@IshaanDesai
Copy link
Member

I don't really understand which suggestions are included when we install ipython. I have very little experience with IPython so would like to have some context here.

@uekerman
Copy link
Member
uekerman commented Feb 28, 2022

@IshaanDesai I guess, some solution would be great where we have some interaction with the docstrings of pyprecice. Automatic code completion, ...

@MakisH
Copy link
Member Author
MakisH commented Feb 28, 2022

@IshaanDesai I guess, some solution would be great where we have some interaction with the docstrings of pyprecice. Automatic code completion, ...

I don't have any other suggestion here (apart from a full IDE, which would be rather large and maybe complicated).

I don't really understand which suggestions are included when we install ipython. I have very little experience with IPython so would like to have some context here.

I tried it a bit and could get some very basic auto-completion, but not really enough to not have to look at the documentation. I also think that @carlosal1015 had to keep the documentation open on the side. Maybe @carlosal1015 would you like to give an example of how ipython would help you if it was already installed in the VM?

@carlosal1015
Copy link
carlosal1015 commented Feb 28, 2022

Thanks for opening this topic about ipython3, while we working in the early days with python bindings, I noticed people (me too) that using pyprecice for the first time, we took us a little extra time read the documentation (maybe this program could save user's time). If in the future there is a page generated by sphinx to view the pyprecice docs pypreCICE docs demo, ipython could be omitted in the virtual machine.

In addition to those shown in this video or short demo, there are more additional features shown there, maybe not necessary in a workshop.

Optionally, could include an a script in non-interactive mode that provides ipython (needs to be tested if it doesn't break other existing modules) like for install_vscode.sh in the future.

Copy link
Member
@IshaanDesai IshaanDesai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried out ipython on the command line and the suggestions are indeed very helpful! Lets add this to the vm 👍

@MakisH MakisH merged commit 4a1a61c into main Mar 6, 2022
@MakisH MakisH deleted the add-ipython branch March 6, 2022 20:31
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

Successfully merging this pull request may close these issues.

4 participants
0