Curvenote Docs

Curvenote

Curvenote is a platform for scientific and technical communication providing modern tooling for technical writing, collaboration, publishing, and reproducible science. Our mission is to help in transitioning scientific communication out of static documents and promote more connections between how researchers work, and how they communicate and share that work.

Critical to that mission is providing tools that:

  1. are accessible to programmers and non-programmers alike;
  2. allow the creation of interactive, computationally driven online documents;
  3. allow you to reuse components of documents across various resources; and
  4. export to traditional formats, like PDF, PPT and Word to support your existing workflows.

You can use Curvenote to write scientific papers, technical reports, course materials, tutorials, documentation, blog posts, prepare a manuscript or thesis, and more!

Writing your research and technical material once and publishing that in a number of places; Curvenote provides document conversion, version control, collaboration, and commenting at the center of your communication workflow.

#The Curvenote Platform

Curvenote is comprised of three main components:

  1. The Curvenote CMS (curvenote.com)
  2. The Curvenote Command Line Interface (CLI)
  3. Web-based publishing infrastructure (curve.space)

#Curvenote - curvenote.com

Curvenote is a Content Management System (CMS) and online application for technical writing, built around an online editor that is designed for scientific and technical content. The editor provides a WYSIWYG interface with Markdown Acceleration, Latex based inline math and equations, and support for citations, tables, figures and interactive components.

Log in to Curvenote and use it to write anything from scientific papers, and technical reports to a complete PhD thesis or project documentation. Manage your work in Projects, whilst also working online with collaborators or organizing multiple Projects and people within a Team.

Curvenote integrates with Jupyter Notebooks through a browser extension providing version control and collaboration features, forming a bridge between data science and analysis work and writing & review, enabling effective collaboration across domains and skillsets. By saving Jupyter Notebooks in Curvenote your papers, reports and articles can include reproducible figures and interactive outputs that remain linked to your Jupyter Notebook environment and are easy to track and update.

Curvenote allows you to publish your work:

  1. as a rich and interactive website that can preserve many of the interactive and reproducible features from your draft in Curvenote and;
  2. by exporting to traditional document formats including LaTeX\LaTeX, PDF and Microsoft Word.

#Curvenote Command Line Interface (CLI)

Curvenote provides an open-source CLI tool, that allows you to interact with the Curvenote API as well as work with content locally on your machine to produce documents and websites.

With the Curvenote CLI you can:

The CLI is in active development and our roadmap includes the following powerful features:

  • curvenote push allowing local content, including images and files, to be saved to or updated in a Curvenote project, enabling workflow automation for figure generation and reporting.
  • curvenote sync allowing complete round trip of content between the Curvenote CMS and local folders and files, enabling collaboration between authors online and those working locally in Markdown and Notebooks.
  • curvenote export “local mode”, enabling document conversion and workflow automation for creating LaTeX\LaTeX, PDF and Microsoft Word (docx) from mixes of Markdown and Jupyter Notebooks.

#Web-based publishing - curve.space

Curvenote provides a modern website publishing system that makes building and deploying a professional scientific website quick and easy. Based on the Curvenote CLI’s web command set, websites can be built from one or more Curvenote projects, from a folder containing Markdown and Jupyter Notebooks, or directly from GitHub.

The resulting websites are automatically deployed on a global CDN for fast rendering and delivery around the globe and incorporate interactive features typically only found in the most modern web-based Journals and publications.

Each Curvenote user can deploy multiple sites for free to their curve.space subdomain (e.g. https://username-slug.curve.space) or deploy to a custom domain. Members of Curvenote Team can also deploy websites linked to shared team projects, making content aggregation and collaboration across a group of authors, editors, and reviewers easy.