One of the difficult parts of working on a Data Library project is setting up all of the tools, including Python, Jupyter, Metatab, Pandas and several others. To make it easier to get started, I’ve set up a hosted instance of JupyterHub, which will allow analysts to run Jupyter notebooks in the cloud. And, the instance uses Redmine for authentication, so you won’t need to create yet another account.
Once you have joined a project and gotten a Redmine account, you can use your Redmine account username and password to log into jupyter.civicknowledge.com. You’ll get a new JupyterLab server. JupyterLab is a lot like Jupyter Notebook, but has a spiffier interface.
If you are an analyst on a Data Library project please try it out and let me know how it works:
- Visit https://jupyter.civicknowledge.com/
- Enter your username and password for your Redmine project management site account.
- Try creating a new Notebook in your ‘work’ directory. (The ‘shared’ directory is for official business. )
Note that this environment lets you start up a terminal window, so you can use git to store and share notebooks. Only work you put in the
work directory will be persisted, and anything that’s really valuable should be managed with git.
Run an Example Analysis
We’ve got an example analysis notebook that you can run in JupyterLab. Once you have logged in and the JupyterLab window open:
- In the “Launcher” window, click on the Terminal tile to open a new terminal, or, use the menus: “File > New > Terminal. ” You should get a back screen with white text.
- Type “cd work” to change to the ‘work’ directory.
- Clone the example notebook repository by typing: “git clone https://github.com/san-diego-water-quality/example-analysis.git”
- Switch to the file browser by clicking on “File” in the tabs on the left side of the screen. Click into the “work” directory, then click into “example-analysis”
- Click on the file “TMDL.ipynb” to open the example notebook.
- In the ‘Run’ menu, click on “Run All Cells”
Here is an example of the process above.