You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
`gophernotes` is a Go kernel for [Jupyter](http://jupyter.org/) notebooks and [nteract](https://nteract.io/). It lets you use Go interactively in a browser-based notebook or desktop app. Use `gophernotes` to create and share documents that contain live Go code, equations, visualizations and explanatory text. These notebooks, with the live Go code, can then be shared with others via email, Dropbox, GitHub and the [Jupyter Notebook Viewer](http://nbviewer.jupyter.org/). Go forth and do data science, or anything else interesting, with Go notebooks!
6
6
7
-
**Acknowledgements** - This project utilizes a Go interpreter called [gomacro](https://github.com/cosmos72/gomacro) under the hood to evaluate Go code interactively. The gophernotes logo was designed by the brilliant [Marcus Olsson](https://github.com/marcusolsson) and was inspired by Renee French's original Go Gopher design.
7
+
**Acknowledgements** - This project utilizes a Go interpreter called [gomacro](https://github.com/cosmos72/gomacro) under the hood to evaluate Go code interactively. The gophernotes logo was designed by the brilliant [Marcus Olsson](https://github.com/marcusolsson) and was inspired by Renee French's original Go Gopher design.
To confirm that the `gophernotes` binary is installed and in your PATH, you should see the following when running `gophernotes` directly:
@@ -57,7 +57,7 @@ $ gophernotes
57
57
```
58
58
59
59
**Note** - if you have the `JUPYTER_PATH` environmental variable set or if you are using an older version of Jupyter, you may need to copy this kernel config to another directory. You can check which directories will be searched by executing:
60
-
60
+
61
61
```sh
62
62
$ jupyter --data-dir
63
63
```
@@ -80,7 +80,7 @@ $ gophernotes
80
80
```
81
81
82
82
**Note** - if you have the `JUPYTER_PATH` environmental variable set or if you are using an older version of Jupyter, you may need to copy this kernel config to another directory. You can check which directories will be searched by executing:
83
-
83
+
84
84
```sh
85
85
$ jupyter --data-dir
86
86
```
@@ -102,12 +102,12 @@ Then:
102
102
REM Download w/o building.
103
103
go get -d github.com/gopherdata/gophernotes
104
104
cd %GOPATH%\src\github.com\gopherdata\gophernotes\zmq-win
Note, if you have the `JUPYTER_PATH` environmental variable set or if you are using an older version of Jupyter, you may need to copy this kernel config to another directory. You can check which directories will be searched by executing:
125
-
125
+
126
126
```
127
127
jupyter --data-dir
128
128
```
@@ -143,7 +143,7 @@ Then:
143
143
144
144
### Docker
145
145
146
-
You can try out or run Jupyter + gophernotes without installing anything using Docker. To run a Go notebook that only needs things from the standard library, run:
146
+
You can try out or run Jupyter + gophernotes without installing anything using Docker. To run a Go notebook that only needs things from the standard library, run:
147
147
148
148
```
149
149
$ docker run -it -p 8888:8888 gopherdata/gophernotes
@@ -159,7 +159,7 @@ In either case, running this command should output a link that you can follow to
159
159
160
160
```
161
161
$ docker run -it -p 8888:8888 -v /path/to/local/notebooks:/path/to/notebooks/in/docker gopherdata/gophernotes
gophernotes uses [gomacro](https://github.com/cosmos72/gomacro) under the hood to evaluate Go code interactively. You can evaluate most any Go code with gomacro, but there are some limitation, which are discussed in further detail [here](https://github.com/cosmos72/gomacro#current-status). Most noteably, gophernotes does NOT support:
189
189
190
190
- third party packages when running natively on Mac and Windows - This is a current limitation of the Go `plugin` package.
191
-
- unexported struct fields are emulated
192
-
- interpreted interfaces - They can be declared, but nothing more: there is no way to implement them or call their methods
193
-
Note: interfaces imported from standard library or third party packages are compiled, and fully functional.
194
-
- goto is only partially implemented
191
+
- some corner cases on interpreted interfaces, as interface -> interface type switch and type assertion, are not implemented yet.
192
+
- conversion from typed constant to interpreted interface is not implemented. Workaround: assign the constant to a variable, then convert the variable to the interpreted interface type.
193
+
- goto is only partially implemented.
194
+
- out-of-order code in the same cell is supported, but not heavily tested. It has some known limitations for composite literals.
0 commit comments