Trovi sharing portal¶
Chameleon Trovi is a sharing portal that allows you to share digital research and education artifacts, such as packaged experiments, workshop tutorials, or class materials. Each research artifact is represented as a deposition (a remotely accessible folder) where a user can put Jupyter notebooks, links to images, orchestration templates, data, software, and other digital representations that together represent a focused contribution that can be run on Chameleon. Users can use these artifacts to recreate and rerun experiments or class exercises on a Jupyter Notebook within Chameleon. They can also create their own artifacts and publish them directly to Trovi from within Chameleon’s Jupyter server.
To get started, find the “Trovi” dropdown option under the “Experiment” section of chameleoncloud.org. Once you’re on the Trovi homepage, you’ll see a list of publicly available experiments and other digital artifacts. You can now browse those artifacts or upload your own.
Trovi allows you to browse artifacts, presented in a scrolling list format. On the right hand side, there are multiple filtering options. By clicking on the project name, you can see all the artifacts that belong to that project. The “All” choice shows you all of the artifacts you have access to. You can also see how many times people have downloaded and launched your notebook with the icons in the bottom left corner of an artifact.
Some Trovi artifacts are supported by the Chameleon team and are denoted with a small Chameleon logo. You can contact the Help Desk if you are using these artifacts and encounter issues.
Launching an artifact¶
The most powerful feature available via Trovi is the ability to re-launch the available artifacts within Chameleon. Clicking “Launch with JupyterHub” will open a new Jupyter Notebook server with the artifacts downloaded (we support artifacts up to 500MB in total size, please contact the Help Desk if you need more space). The animation below shows how easy it is:
Using Day Passes¶
Normally, only Chameleon users with active allocations are able to launch and view Trovi artifacts. To allow anyone to launch an artifact, we also provide day passes. This allows for a non-Chameleon user to have access to Chameleon for a limited amount of time, using a small, separate allocation tied to your allocation. People interested in reproducing your project will send requests to the managers of a project. If approved, the requesting user will recieve an email invitation to join the reproducibility project. When they accept, they can use this project to run your artifact. After the specified time limit, they will be automatically removed from this project.
Allowing Reproducibility Requests¶
First, the owner of an artifact must permit reproducibility requests. This can be revoked at any time, preventing future requests. Additionally, you must also give your artifact a value for “Hours a user has to reproduce.” This value specifies how long a user will have access to Chameleon for. Consider how long it takes to run your experiment from start to finish as a lower bound for this value. The artifact owner must also assign their artifact to a project via the dropdown selector. As these requests are granting access to Chameleon resources, this is needed to tie granted requests to a PI.
These fields can be accessed by navigating to an artifact’s detail page, and then selecting “Share.” At the bottom of the share page, you will see the below forms, which are the project assignment, the enabling of reproducibility requests, and the hours to reproduce.
After these items are saved, an allocation request is automatically made. Your artifact should now appear with a “Request Day Pass” button below the “Launch” button. The “Launch” button will not appear for users that are not a member in an active Chameleon project.
Requesting a Day Pass¶
When you select “Request Day Pass”, you will be taken a form where you are asked to submit your name, institution, and a reason why you want to reproduce the artifact. The goal of this form is to explain to the PI why you are interested in reproducing the artifact, as the PI is still responsible for overseeing the proper use of Chameleon resources, and the PI may be a stranger to you.
After submitting the form, the managers (and PI) of the project associated with the artifact will receive an email informing them of the request.
Reviewing a Day Pass Request¶
After recieving an email with the day pass request, PIs and project managers can navigate to the review page by clicking the link in the email. Here, they will see all of the details submitted with the request. A decision can be made by choosing “approved” or “rejected” in the selector, and then clicking submit.
After this decision is made, an email is sent to the requestor with the result. If the request is approved, an invitation is sent to the user.
Using an Invitation¶
If your day pass request is approved, an email will be sent to you with an invite link. After clicking this link, you will be automatically added to the project. The email will also mention how long the invitation is for. When the invite is accepted, you will be taken to the project page for the reproducibility project. Please note the ID of the project (CHI-XXXXX), which may be needed to configure an artifact.
Next, you can navigate back to the original artifact URL you were given. The “Launch” button can be used now to start running the artifact.
After the duration for the invite has passed, you will be automatically removed from the project.