Curvenote Docs

Installing Curvenote

Curvenote is available through Node. Unless you already have this on your system you will have to install NodeJS. Node is used in Jupyter as well as a number of other packages, you may already have it on your computer and available on your PATH, so the following command may just work🤞.

npm install -g curvenote

This will install curvenote globally (-g) on your system and add a link to the main CLI tool. To see if things worked, try checking the version with:

curvenote --version

Which should print the current version of the package. If all is good, you can type curvenote again in your terminal and it will list the help with all of the options available to you.

#Updating Curvenote

There are new releases of the CLI every few weeks, to update to the latest version of curvenote, use:

npm update -g curvenote

Try the curvenote --version command before and after, with an update you should be on the most up to date version (see npm for the latest version!). If you are not, try npm uninstall -g curvenote or without the -g global flag, until curvenote is no longer available on your command line. Then try installing again!

#Dependencies for LaTeX\LaTeX and PDF

If you are exporting to LaTeX\LaTeX with an open-source template specified (see all templates) or if you are creating a PDF you will need to install the jtex python package to be installed and available on the user's PATH. With Python 3.7 or greater installed, install jtex via pip:

python -m pip install jtex

For LaTeX\LaTeX PDF builds you will also require a version of LaTeX to be installed.

#Usage as a package

curvenote is a node module, and you can use it to chain together other types of workflows that are not possible through the CLI.

import { Session, MyUser } from 'curvenote';

const session = new Session(token);
const user = await new MyUser(session).get();
console.log(user.data.username);

#Developing

For the curvenote library on GitHub, git clone and you can install the dependencies and then create a local copy of the library with the yarn dev:cli command.

git clone git@github.com:curvenote/curvenotejs.git
cd curvenotejs
yarn install
yarn dev:cli

This will create a local copy of curvenote for use on the command line.