diff --git a/README.md b/README.md index 98100c4..04b648c 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,8 @@ -# Getting your tellurium project on nanohub +#Activity Dependent Homeostatic Plasticity (ADHP) Correlations App -1. Create a GitHub account [https://github.com/join?ref\_cta=Sign+up](https://github.com/join?ref_cta=Sign+up) -2. Fork or Copy this repository on your computer [https://github.com/JulianoGianlupi/tellurium-nanohub-base](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](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/](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 -![](image1.png) +![](exampletrajectories.png) -3. 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 -4. 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 -5. 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](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 +![](examplestartendpts.png) -![](image2.png) - -6. 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](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/create-a-repo)) and upload them -7. 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 - -![](image3.png) - -8. Follow the steps in [https://nanohub.org/tools/create](https://nanohub.org/tools/create) +![](examplecorrelations.png) diff --git a/image1.png b/image1.png deleted file mode 100644 index 5c47c8b..0000000 Binary files a/image1.png and /dev/null differ diff --git a/image2.png b/image2.png deleted file mode 100644 index 6d48bbb..0000000 Binary files a/image2.png and /dev/null differ diff --git a/image3.png b/image3.png deleted file mode 100644 index fb88fb8..0000000 Binary files a/image3.png and /dev/null differ