Skip to content

Commit

Permalink
update docs and install kernel script
Browse files Browse the repository at this point in the history
  • Loading branch information
avibryant committed Mar 23, 2020
1 parent 210c7a8 commit f67872a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 11 deletions.
14 changes: 3 additions & 11 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,15 @@ title: Getting Rainier
To add Rainier to your project include the following in your `build.sbt`:

```scala
resolvers += Resolver.bintrayRepo("rainier", "maven")
libraryDependencies += "com.stripe" %% "rainier-core" % "@VERSION@"
```

Or, in [Ammonite](https://ammonite.io/), import it like this:

```scala
interp.repositories() ++= Seq(coursierapi.MavenRepository.of("https://dl.bintray.com/rainier/maven"))
import $ivy.`com.stripe::rainier-core:@VERSION@`
```

For plotting and exploratory work, we suggest [Using Jupyter](jupyter.md).

## Non-release versions

Tagged commits will result in non-release artifacts pushed to `https://dl.bintray.com/rainier/maven`.

You can include these in your projects using

```scala
resolvers += Resolver.bintrayRepo("rainier", "maven")
```
For plotting and exploratory work, we suggest [Using Jupyter](jupyter.md).
2 changes: 2 additions & 0 deletions docs/jupyter.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Specifically, this script installs a kernel that:

* Uses Scala 2.12, which is currently the only version `rainier-notebook` is available for
* Uses Almond 0.9.0, which seems to currently be more reliable than the latest release
* Includes the `https://dl.bintray.com/rainier/maven` repository
* Includes the `https://dl.bintray.com/cibotech/public` repository, which is needed for the [EvilPlot](https://cibotech.github.io/evilplot/) dependency
* Configures the kernel with a custom id, name, and logo

Expand All @@ -37,6 +38,7 @@ If you are not using the custom kernel installer, make sure to use the `Scala 2.

```scala
interp.repositories() ++= Seq(
coursierapi.MavenRepository.of("https://dl.bintray.com/rainier/maven"),
coursierapi.MavenRepository.of("https://dl.bintray.com/cibotech/public"),
coursierapi.MavenRepository.of("https://jitpack.io/")
)
Expand Down
1 change: 1 addition & 0 deletions install-kernel.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ chmod +x /tmp/coursier
/tmp/almond --install \
-f --id rainier -N "Rainier (Scala 2.12)" \
--extra-repository "https://dl.bintray.com/cibotech/public" \
--extra-repository "https://dl.bintray.com/rainier/maven" \
--extra-repository "https://jitpack.io" \
--logo $PWD/logo.png

0 comments on commit f67872a

Please sign in to comment.