Skip to content

Commit

Permalink
Merge pull request #81 from WolframResearch/feature/README-md-cleanup
Browse files Browse the repository at this point in the history
Clean up README.md
  • Loading branch information
cc-wr authored Feb 7, 2020
2 parents c7673eb + ab6ab8a commit 5587c6b
Showing 1 changed file with 18 additions and 22 deletions.
40 changes: 18 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,17 @@ There are **two** ways to make the Wolfram Language available in Jupyter:

On macOS/Unix: Clone the repository

git clone https://github.com/WolframResearch/WolframLanguageForJupyter.git
Run the following command in your shell to make the Wolfram Language engine available to Jupyter:

./configure-jupyter.wls add
git clone https://github.com/WolframResearch/WolframLanguageForJupyter.git

On Windows:
Follow the fist two steps [here](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository), and on the the third step select `Download Zip`, and unzip the file using a tool for Windows.
Open PowerShell in the directory of the unzipped folder

Run the following command in your shell to make the Wolfram Language engine available to Jupyter:

.\configure-jupyter.wls add
Run the following command in your shell to make the Wolfram Language engine available to Jupyter:

./configure-jupyter.wls add

On Windows: Follow the fist two steps [here](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository), and on the the third step select `Download Zip`, and unzip the file using a tool for Windows. Open PowerShell in the directory of the unzipped folder

Run the following command in your shell to make the Wolfram Language engine available to Jupyter:

.\configure-jupyter.wls add

**Notes:**

Expand All @@ -44,7 +41,7 @@ On Windows:

For more configuration options run:

./configure-jupyter.wls help
./configure-jupyter.wls help

## Method 2: Using Wolfram Language

Expand All @@ -62,31 +59,31 @@ To load the paclet, run:

To add the Wolfram Language to Jupyter, run:

ConfigureJupyter["Add"]
ConfigureJupyter["Add"]

To specify a specific Jupyter binary, run:

ConfigureJupyter["Add", "JupyterInstallation" -> "..."]
ConfigureJupyter["Add", "JupyterInstallation" -> "..."]

To specify a specific Wolfram Engine binary, run:

ConfigureJupyter["Add", "WolframEngineBinary" -> "..." ]
ConfigureJupyter["Add", "WolframEngineBinary" -> "..." ]

Please note, however, that the value for the `"WolframEngineBinary"` option should not be a `wolframscript` path.

# Testing your installation

The following command should now list the Wolfram Engine:

jupyter kernelspec list
jupyter kernelspec list

The output should include a line like this:

wolframlanguage12 C:\ProgramData\jupyter\kernels\wolframlanguage12
wolframlanguage12 C:\ProgramData\jupyter\kernels\wolframlanguage12

## To test your installation in a notebook, run the following command:

jupyter notebook
jupyter notebook

Then select Wolfram Language from the drop down menu:

Expand All @@ -105,8 +102,7 @@ Any messages that occur during evaluation are displayed:
![in-out-3](images/in-out-03.png)

## To test your installation in the terminal, run the following command:
jupyter-console --kernel=wolframlanguage12

jupyter-console --kernel=wolframlanguage12

# Building the WolframLanguageForJupyter paclet

Expand All @@ -122,13 +118,13 @@ This creates the `WolframLanguageForJupyter-x.y.z.paclet` file (use the `PacletI

Run the following command to remove the Wolfram Language engine from Jupyter:

./configure-jupyter.wls remove
./configure-jupyter.wls remove

## Method 2: Using Wolfram Language

Run the following command:

ConfigureJupyter["Remove"]
ConfigureJupyter["Remove"]

# Links

Expand Down

0 comments on commit 5587c6b

Please sign in to comment.