How to create a project with our Project Builder
A quick guide to building a project
A brief overview of all the steps you need to complete to set up your project.
- Log in to your Zooniverse account.
- Click on "Build a Project" and click "Create a New Project".
- Enter your project details in the pop-up that appears. You’ll then be taken to a “Project Details” page where you can add further basic information.
- Add more information about your project via the blue tabs on the left-hand side of the project builder page. Guidance for each of these sections is provided on the page itself.
- If you have data to upload, add your subjects via the “Subject Sets” tab of the Project Builder (detailed instructions are provided here),
- Next, create your workflow. Click on the “Workflow” tab in the navigation bar on the left-hand side of the page. Use the “New workflow” button to create a workflow. Multiple workflows can be created.
- Once you’ve created a workflow, the "Associated Subject Sets" section allows you to link your workflow to your subject sets. If you have no subjects, go to the “Subject Sets” tab and upload your data (see step 5 above).
- Hit the "Test this workflow" button to see how your project looks.
- Explore your project to figure out what works and what doesn't. Make changes, then refresh your project page to test these out.
- Guidelines on how to design your project to maximize engagement and data quality are provided on the Policies page.
- When you are happy with your project, set it to “Public” on the “Visibility” tab. Use the “Apply for review” button to submit it to the Zooniverse team for review.
Navigating the Project Builder
On the left-hand side of the project builder you will see a number of tabs which can be divided into three key sections; “Project”, “Workflows” and “Subject Sets”. These are terms you'll see a lot, and they have specific meanings in the Zooniverse.
- Project is pretty self-explanatory; Galaxy Zoo and Penguin Watch are examples of Zooniverse projects that could be built using the project builder.
- Workflows are sequences of tasks that volunteers are asked to do.
- Subject sets are collections of data (typically images) that volunteers are asked to perform tasks on.
For more Zooniverse definitions, check out the Glossary page.
The tabs listed below are where you enter descriptive information for your project.
- Project Details: Here you can add information that generates a home page for your project. Start by naming and describing your project, add a logo and background image.
- About: Here you can add all sorts of additional pages, including Research, Team, Results, Education, and FAQ
- Collaborators: Add people to your team. You can specify their roles so that they have access to the tools they need (such as access to the project before it's public).
- Field Guide: A field guide is a place to store general project-specific information that volunteers will need to understand in order to complete classifications and talk about what they're seeing.
- Tutorial: This is where you create tutorials to show your users how to contribute to your project.
- Media: Add images you need for your project pages (not the images you want people to classify!)
- Visibility: Set your project's "state" - private or public, live or in development, and apply for review by the Zooniverse. You can also activate or deactivate specific workflows on this page.
- Talk: Create and manage discussion boards for your project.
- Data Exports: Access your raw and aggregated classification data, subject data, and comments from Talk.
A workflow is the sequence of tasks volunteers are asked to perform. For example, you might want to ask volunteers to answer questions about your images, or to mark features in your data, or both. The workflow tab is where you define those tasks and set the order in which volunteers are asked to do them. Your project might have multiple workflows (if you want to set different tasks for different image sets). See the detailed Workflow section for more information.
A subject is a unit of data to be analyzed. A single subject can include more than one image. A “subject set” consists of both the "manifest" (a list of the subjects and their properties), and the images themselves. Subjects can be grouped into different sets if useful for your research. See the Subject Details section for more on subjects.
Project building in detail
Detailed instructions on how to use the pages described above.
Name: The project name is the first thing people will see and it will show up in the project URL. Try to keep it short and sweet.
Avatar: Pick an avatar image for your project. This will represent your project on the Zooniverse home page. It can also be used as your project's brand. It's best if it's recognizable even as a small icon. To add an image, either drag and drop or click to open your file viewer. For best results, use a square image of not more than 50KB, but at minimum 100x100 pixels.
Background: This image will be the background for all of your project pages, including your project's front page. It should be relatively high resolution and you should be able to read text written across it. To add an image, either drag and drop or click to open your file viewer. For best results, use images of at least 1 megapixel, no larger than 256 KB. Most people's screens are not much bigger than 1300 pixels across and 750 pixels high, so if your image is a lot bigger than this you may find it doesn't look the way you expect. Feel free to experiment with different sizes on a "typical" desktop, laptop or mobile screen.
Description: This should be a one-line call to action for your project. This will display on your landing page and, if approved, on the Zooniverse home page. Some volunteers will decide whether to try your project based on reading this, so try to write short text that will make people actively want to join your project.
Introduction: Add a brief introduction to get people interested in your project. This will display on your project's front page. Note this field renders markdown, so you can format the text. You can make this longer than the Description, but it's still probably best to save much longer text for areas like the About, Research Case or FAQ tabs.
Workflow Description: A workflow is a set of tasks a volunteer completes to create a classification. Your project might have multiple workflows (if you want to set different tasks for different subject image sets). Add text here when you have multiple workflows and want to help your volunteers decide which one they should do.
Checkbox: Volunteers choose workflow: If you have multiple workflows, check this to let volunteers select which workflow they want to work on; otherwise, they'll be served randomly.
Researcher Quote: This text will appear on the project landing page alongside an avatar of the selected researcher. It’s a way of communicating information to your volunteers, highlighting specific team members, and getting volunteers enthusiastic about participating.
Announcement Banner: This text will appear as a banner at the top of all your project’s pages. Only use this when you’ve got a big important announcement to make! Many projects use this to signal the end of a beta review, or other major events in a project’s life cycle.
Discipline Tag: Enter or select one or more discipline tags to identify which field(s) of research your project belongs to. These tags will determine the categories your project will appear under on the main Zooniverse projects page, if your project becomes a full Zooniverse project.
Other Tags: Enter a list of additional tags to describe your project separated by commas to help users find your project.
External links: Adding an external link will make it appear as a new tab alongside the About, Classify, Talk, and Collect tabs. You can rearrange the displayed order by clicking and dragging on the left gray tab next to each link.
Social links: Adding a social link will append a media icon at the end of your project menu bar. You can rearrange the displayed order by clicking and dragging on the left gray tab next to each link.
Checkbox: Private project: On "private" projects, only users with specified project roles can see or classify on the project. We strongly recommend you keep your project private while you're still editing it. Share it with your team to get feedback by adding them in the Collaborators area (linked at the left-hand side of the Project Builder). Team members you add can see your project even if it's private. Once your project is public, anyone with the link can view and classify on it.
This section contains pages where you can enter further information for Research, Team, Results, Education and FAQ. All of these pages use Markdown to format text and display images.
Research: Use this section to explain your research to your audience in as much detail as you'd like. Explaining your motivation to volunteers is critical for the success of your project – please fill in this page (it will display even if you don’t)!
Team: Introduce the members of your team, and the roles they play in your project.
Results: Share results from your project with volunteers and the public here. This page will only display if you add content to it.
Education: On this page, you can provide resources for educators and students to use alongside your project, such as course syllabi, pedagogical tools, further reading, and instructions on how the project might be used in an educational context. This page will only display if you add content to it.
FAQ: Add details here about your research, how to classify, and what you plan to do with the classifications. This page can evolve as your project does so that your active community members have a resource to point new users to. This page will only display if you add content to it.
Here you can add people to your team. You can specify their roles so that they have access to the tools they need (such as access to the project before it's public).
Owner: The owner is the original project creator. There can be only one.
Collaborator: Collaborators have full access to edit workflows and project content, including deleting some or all of the project.
Expert: Experts can enter “gold mode” to make authoritative gold standard classifications that will be used to validate data quality.
Researcher: Members of the research team will be marked as researchers on “Talk".
Moderator: Moderators have extra privileges in the community discussion area to moderate discussions. They will also be marked as moderators on “Talk".
Tester: Testers can view and classify on your project to give feedback while it’s still private. They cannot access the project builder.
Translator: Translators will have access to the project builder as well as the translation site, so they can translate all of your project text into a different language.
A field guide is a place to store general project-specific information that volunteers will need to understand in order to complete classifications and talk about what they're seeing. It's available anywhere in your project, accessible via a tab on the right-hand side of the screen.
Information can be grouped into different sections, and each section should have a title and an icon. Content for each section is rendered with Markdown, so you can include any media you've uploaded for your project there.
In this section, you can create a step-by-step tutorial to show your users how to use your project. You can upload images and enter text to create each step of the tutorial. You can add as many steps as you want, but keep your tutorial as short as possible so volunteers can start classifying as soon as possible.
In some cases, you might have several different workflows, and will therefore need several different tutorials. In the Workflows tab, you can specify which tutorial shows for the workflow a volunteer is on.
You can upload your own media to your project (such as example images for your Help pages or Tutorial) so you can link to it without an external host. To start uploading, drop an image into the grey box (or click “Select files” to bring up your file browser and select a file). Once the image has uploaded, it will appear above the "Add an image" box. You can then copy the Markdown text beneath the image into your project, or add another image.
This page is where you decide whether your project is public and whether it's ready to go live.
Project State and Visibility: Set your project to “Private” or “Public”. Only the assigned collaborators can view a private project. Anyone with the URL can access a public project. Here, you can also choose whether your project is in “Development”, or “Live”. Note: in a live project, active workflows are locked and can no longer be edited.
Beta Status: Here, you will find a checklist of tasks that must be complete for your project to undergo beta review. Projects must complete review in order to launch as full Zooniverse projects and be promoted as such. Once these tasks are complete, click “Apply for review”.
Workflow Settings: You will see a list of all workflows created for the project. You can set the workflows to “Active”, choose what metric to measure for completeness statistics, and whether those statistics should be shown on your project’s Stats Page.For more information on the different project stages, see our Project Builder policies.
“Talk” is the name for the discussion boards attached to your project. On your Talk, volunteers will be able to discuss your project and subjects with each other, as well as with you and your project’s researchers. Maintaining a vibrant and active Talk is important for keeping your volunteers engaged with your project. Conversations on Talk also can lead to additional research discoveries.
You can use this page to set up the initial Talk boards for your project. We highly recommend first activating the default subject-discussion board, which hosts a single dedicated conversation for each subject. After that, you can add additional boards, where each board will host conversation about a general topic. Example boards might include: “Announcements,” “Project Discussion,” “Questions for the Research Team,” or “Technical Support.”
In this section you can request data exports for your Project Data (CSV format) and Talk Data (JSON format). Note that the Zooniverse will process at most 1 of each export within a 24-hour period and some exports may take a long time to process. We will email you when they are ready. For examples of how to work with the data exports see our Data Digging code repository.
Note that a workflow with fewer tasks is easier for volunteers to complete. We know from surveys of our volunteers that many people classify in their limited spare time, and sometimes they only have a few minutes. Longer, more complex workflows mean each classification takes longer, so if your workflow is very long you may lose volunteers.
Workflow title: Give your workflow a short, but descriptive name. If you have multiple workflows and give volunteers the option of choosing which they want to work on, this Workflow title will appear on a button instead of "Get started!"
Version: Version indicates which version of the workflow you are on. Every time you save changes to a workflow, you create a new version. Big changes, like adding or deleting questions, will change the version by a whole number: 1.0 to 2.0, etc. Smaller changes, like modifying the help text, will change the version by a decimal, e.g. 2.0 to 2.1. The version is tracked with each classification in case you need it when analyzing your data.
Tasks: There are two main types of tasks: questions and drawing. For question tasks, the volunteer chooses from a list of answers but does not mark or draw on the image. In drawing tasks, the volunteer marks or draws directly on the image using tools that you specify. They can also give sub-classifications for each mark. Note that you can set the first task from the drop-down menu.
Main Text: Describe the task, or ask the question, in a way that is clear to a non-expert. The wording here is very important, because you will in general get what you ask for. Solicit opinions from team members and testers before you make the project public: it often takes a few tries to reach the combination of simplicity and clarity that will guide your volunteers to give you the inputs you need. You can use markdown in the main text.
Help Text: Add text and images for a pop-up help window. This is shown next to the main text of the task in the main classification interface, when the volunteer clicks a button asking for help. You can use markdown in this text, and link to other images to help illustrate your description. The help text can be as long as you need, but you should try to keep it simple and avoid jargon. One thing that is useful in the help text is a concise description of why you are asking for this information.
Create tasks with the "Add a task" button. Delete tasks with the "Delete this task" button under the “Choices” box.
Tasks can be Questions, Drawings or Transcription. All types have "Main Text" boxes where you can ask your questions or tell users what to draw, as well as provide additional support for completing the task in the "Help Text" box.
Choices: This section contains all your answers. The key features of this section are:
Required: if you select this, the user has to answer the question before moving on.
Multiple: if you select this, the user can select more than one answer - use this for "select all that apply" type questions.
Next Task: The “Next task” selection (which appears below the text box for each answer) describes what task you want the volunteer to perform next after they give a particular answer. You can choose from among the tasks you’ve already defined. If you want to link a task to another you haven’t built yet, you can come back and do it later (don’t forget to save your changes).
This section contains all the different things people can mark. We call each separate option a "Tool" and you can specify a label, colour, and tool type for each option. Check out the Aggregation documents to understand how multiple volunteer answers are turned into final shapes for your data analysis. The tool types are:
bezier: an arbitrary shape made of point-to-point curves. The midpoint of each segment drawn can be dragged to adjust the curvature.
circle: a point and a radius.
column: a box with full height but variable width; this tool cannot be rotated.
ellipse: an oval of any size and axis ratio; this tool can be rotated.
line: a straight line at any angle.
point: X marks the spot.
polygon: an arbitrary shape made of point-to-point lines.
rectangle: a box of any size and length-width ratio; this tool cannot be rotated.
triangle: an equilateral triangle of any size and vertex distance from the center; this tool can be rotated.
grid table: cells which can be made into a table for consecutive annotations.
This section deals with projects which require user-generated text. Tasks can range from adding keywords or extracting metadata to full text transcriptions.
Keyword tagging is helpful when teams want to create a list of all of the things volunteers see in a given image, to make that object more discoverable in a database or online collection. In these cases diversity of opinion is helpful. Setting a retirement rate of 5 to 10 people will help capture diverse opinions.
Full text transcription is more cumbersome and diversity of opinion is less helpful. Teams are usually trying to capture exactly what is on a page, so it will help to set a relatively low retirement rate for each image (i.e. 3 or 5) and be very clear in the tutorial how you would like volunteers to transcribe. Should they preserve spelling and punctuation or modernize it?
Zooniverse does not currently offer aggregated classifications for text subjects. We can only report what each user transcribed for each subject. Before embarking on a transcription project be sure you have in-house expertise or access to expertise for combining multiple independent transcriptions into a single reading that you could use for research or to upload into a library or museum catalogue or content management system. For more information on Project Builder Data, please visit our Data Digging code repository as well as our Data processing Talk board.
Linking the workflow together
Now that all the tasks have been created, we've got to string them together by specifying what happens next. Set your first task using the "First Task" drop-down menu below the "Add Task" button. Then, using the “Next task” drop-down under the “Choices” box, specify what comes next. In question tasks, you can specify different "Next Tasks" for each available answer (provided users can only select one answer).
Multi-Image options: If your tasks require users to see multiple subjects per task (like on Snapshot Serengeti), decide how users will see them. The Flipbook option means users have to press a button to switch between subjects, while separate frames mean that each subject will be visible for the duration of the classification task.
Subject retirement: Decide how many people you want to complete each task. You can change this number at any point (particularly after beta review). We suggest starting out high, between 10 and 20.
On this page, you can add groups of data to be classified.
To do so, drag and drop items onto the drop zone in the browser and then upload. You can give each set a name so that you can easily distinguish between them.
Subject sets can be pretty powerful, and sometimes complex. You can have a single subject set that you add to over time, or have multiple subject sets, say, from different years or places. You can have different subject sets for different workflows, but you don't have to. You can even have multiple images in a given subject. For more details and advice on creating and structuring subject sets and associated manifests, check out https://www.zooniverse.org/help/example and scroll down to DETAILS - Subject sets and manifest details, a.k.a. “What is a manifest?”
If you'd like some further information, check out the documentation behind building Kitteh Zoo, that talks you through building this project in the Project Builder.\n\nIf this doesn't help, get in contact with the Zooniverse team via the contact page.