Skip to content

Baseline files needed for deploying a tellurium tool on nanoHUB

License

Notifications You must be signed in to change notification settings

JulianoGianlupi/tellurium-nanohub-base

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Getting your tellurium project on nanohub

  1. Create a GitHub account https://github.com/join?ref_cta=Sign+up
  2. Fork or Copy this repository on your computer https://github.com/JulianoGianlupi/tellurium-nanohub-base
    1. It's a good idea to download gitbash https://www.educative.io/edpresso/how-to-install-git-bash-in-windows . Git bash works as a linux / macOS terminal but with more commands, maybe mac/linux people already have git commands built into the terminal.
    2. And github desktop will also help https://desktop.github.com/. If you are not familiar with command line stuff this is a good option – even if you are familiar this will allow you to not have to look up a bunch of git commands, although I recommend you learn to use github regardless
    3. You can download the repo as a zip

  1. In the unzipped files replace the jupyter notebook there by your own (do not place spaces in the notebook name). In other words: replace tellurium.ipynb with <YOUR_NOTEBOOK_NAME>.ipynb
  2. In the unzipped files, under the folder middleware, open the file invoke (use notepad or notepad++) and replace tellurium.ipynb with the name of your jupyter notebook
  3. Also in the middleware/invoke file replace "-t tellurium" with "-t short_tool_name". short_tool_name will be the name nanohub uses in the url for your tool and to call it, it must match "Tool Name" in https://nanohub.org/tools/create. It must be 3-15 alphanumeric characters, no spaces. Once you register your tool, you cannot change this name, so be careful to pick a good one.
    1. If you had already done this before December 18 2020 either pull again from the repo or change "start_jupyter -T @tool tellurium.ipynb" to "start_jupyter -t -T @tool tellurium.ipynb"
    2. If you want your notebook to open on app mode you have to add a -A before the -T in that string
    3. The "not short" tool name will be the Title in that box, that's the one people will mainly see

  1. Create a new repository to host (upload) your files (https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/create-a-repo) and upload them
  2. On github make sure middleware/invoke is executable; open the file in github, the upper left corner will say if it is or not
    1. If it isn't: open gitbash, go to the folder containing your repo and issue the command git update-index --chmod=+x middleware/invoke and push the changes to the repo

  1. Follow the steps in https://nanohub.org/tools/create

About

Baseline files needed for deploying a tellurium tool on nanoHUB

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published