Overview

This guide will introduce you to Developer Notes (DevNotes) as a way to quickly share ideas and results with the developer community. This guide assumes that you have familiarized yourself with Nucleus Hub (see Nucleus Hub for more information).

Using Curvenote Preview to view a DevNote

• [ ] From the Launcher window, select the icon for Curvenote Preview.

• [ ] You will see a window that says ‘Please set your Curvenote token:

  

  • [ ] Create a Curvenote account

    

  • [ ] Create a new blank project and click ‘NEXT’

  • [ ] Go to personal settings:

    

  • [ ] Select ‘API Access’ and click ‘Generate New Token’.

  • [ ] Give the token a useful descrption and select Expiry for the maximum time allowed.

  • [ ] Open a terminal window from the Launcher window and run the command curvenote token set [my-token]

  • [ ] You should see a message that says: Token set for "[curvenote-username]" <curvenote-email-account> at https://api.curvenote.com/login”

• [ ] You should now be able to view a DevNote by clicking Curvenote Preview from the Launcher window. Note: it may take up to a minute to populate the following viewer window if this is the first time you using the Preview feature.

  

  • [ ] click the template/ directory.
  • [ ] Congratulations! You should now see a rendered DevNote file:

Setting up your DevNote

• [ ] In the File Directory (left panel), navigate to the /devnotes/ directory and make a copy of the /template/ directory and rename it. Note: we recommend that you always work off of a copy of the template file and never edit the template file itself so that it can serve as a working reference.
• [ ] Inspect the output of the directory. In the Launcher Window (Main Panel), click Curvenote Preview and then select your renamed template file.
• [ ] Change the title and author of your DevNote by opening the file curvenote.yml from the File Directory and modify the corresponding fields:

# Ensure your title is the same as in your `main.md`
  title: "An Unexpected Enzyme in PURE"  
  subtitle: "The enzyme MTHFS is needed for 36 pot PURE"
  description:  
# Add any supporting files to the toc, but ensure that your main manuscript
# is first is the list. The title field is optional.
# Authors should have affiliations, emails and ORCIDs if available
  authors:
    - name: Sam Cell
      email: [email protected]
      orcid: 0000-0001-1234-1234
      affiliations:
        - b.next

Connecting a Jupyer Notebook to a DevNote

• [ ] Navigate to your DevNote’s experimental directory devnotes/my-devnote/experiments/