Best Practices for IDE Users

At a Glance

This document lists best practices for using HISE IDEs. To ask a question or submit an issue, click the Support button at the top of this page.

• Don't create IDEs with a massive amount of disk space (>200 GB)..
• Treat every IDE as a temporary data processing space, not a permanent workspace.
• Use uploadFiles() to establish a Collaboration Space in HISE for your data and IDEs.
• Use the Project Store to handle data that isn't processed by our automated analysis pipeline.
• Preserve startup scripts in your /private folder so you have them handy to create new IDEs. 
• Avoid dragging and dropping files > 1 GB in size. Instead, use CLI commands to work with your files.
• If the selected IDE modality doesn't meet your needs, improve its functionality by adding relevant packages and libraries. 
• Jupyter notebooks must run in order from start to finish. Begin by caching HISE data, and end by uploading your outputs.
• Stop your instance if you can do so conveniently. Stopped instances incur cloud computing costs only for disk space—not for CPUs or memory. Delete your instance if possible. Deleted instances incur no cloud computing costs.
• Instead of consolidating all research activities into a single IDE, create separate notebooks for specific purposes, such as preprocessing, predictive modeling, and visualization. This task-based approach streamlines your workflow and lowers cloud computing costs, since small instances are easy to stop or delete. Remember, however, that each user is limited to five IDE instances per account.
• For programmatically generated outputs that you intend to keep or share, write to the /home/workspace folder instead of writing directly to the notebook. (More specifically, write to /home/workspace/temp or any other /home/workspace location except /environment, /input, /private, or /sdk.) Doing so ensures the persistence of your data and allows for easy data transfer between the IDEs within your account. 
• Side-loading (manually uploading) data to your IDE makes the source difficult to trace for reproducibility. For greater transparency, either encode the data acquisition process directly in your Jupyter Notebook or use a watchfolder to ingest external data sources automatically into HISE.
• Files accidentally deleted from your /private folder are retained for 90 days. To request file recovery, contact the dev team at immunology-support@alleninstitute.org.

Related Resources

Explore IDE Folders

Use IDE Packages

Use the Conda Environment (Tutorial)

Create a GitHub Repository for Your IDE (Tutorial)