Skip to content

Update pycmap_install.rst #77

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.

Sign up for GitHub

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

Open
jcmcnch wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update pycmap_install.rst #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions user_guide/API_ref/pycmap_api/pycmap_install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,22 @@ pycmap can be installed using pip:

pip install pycmap

You may find the above command installs pycmap to python2. Since pycmap requires python3, this causes issues. If this happens to you, try the following commands:

.. code-block:: shell

python3 -m pip install pycmap
python3 -m pip install IPython

To test your installation, one easy way is to go into a python interactive shell and try importing the module:

.. code-block:: shell

$ python3
>>> import pycmap
>>>
#if you get no errors after importing (as above), then you are good to go!


In order to use pycmap, you will need to obtain an API key from https://simonscmap.com/apikeymanagement.

Expand Down