Project

From emergent
(Redirected from project)
Jump to: navigation, search
Reference info for type ProjectBase: Wiki | Emergent Help Browser
Reference info for type BpProject: Wiki | Emergent Help Browser
Reference info for type LeabraProject: Wiki | Emergent Help Browser
Reference info for type CsProject: Wiki | Emergent Help Browser
Reference info for type SoProject: Wiki | Emergent Help Browser
Crystal Clear app display.png Using emergent

A Project is an overall container for all the other types of objects that make up a network simulation. A Project is a set of named Containers or collections, each of which holds objects of a specific type. Most of the containers enable you to create your own objects of that type, but some are prepackaged with a fixed set of items. The collections are explained in detail below.

The Project_window provides the main user interface for the project.

Getting started

Project templates

The Project templates provide a starting point for different projects, representing the specialized network algorithms available. Select one from the Startup Wizard or the File/New Project chooser.

You should immediately give the project a descriptive name, and then save it to a file:

  1. in the main menu or toolbar of the project, select File/Save As
  2. specify a file name, and press Ok

Recover Files (projects)

In an ideal world, software would never crash, unfortunately, in the real world, it sometimes does. You can help prevent loss of work by saving often - use File/Save or the toolbar button. In addition, emergent can detect most crashes and will automatically save the project in its current state to a separate recover file - the file will have the same base name as your project, with an added number; it is stored in the same folder as your project. When emergent starts, it will (in most cases) automatically detect that a crash occurred last time, and put the name of the recover file at the top of the File/Recent selections.

IMPORTANT: if you open a recover file, remember this is a separate project - if you want to accept the state of the project as it is in the recover file, you will need to re-save it over top of your previous project. You may want to make a copy of your main project file before overwriting it with the recover file.

Working with projects

Emergent keeps track of your most recently saved or opened projects - you can reopen a project from File/Recent.

Creating objects in containers

To create an object in any Container (e.g., a Group or List of objects, which form the structural hierarchy of the project).

  1. right click on the collection, ex. 'docs'
  2. from the menu, select New
  3. in the dialog, specify the exact type of the object you want (in many cases, there is only one choice)
  4. specify how many objects you want to create (often 1)
  5. click Ok

the new object is added to the collection

You may wish to give the object a descriptive name before proceeding.

  1. select the object in the tree view (if it is not already selected)
  2. in the edit panel, select the Properties view (if not already selected)
  3. edit the name of the object
  4. press Apply

Deleting objects

You can delete any object:

  1. select the object in the tree view
  2. right click, and select Delete from the menu

if Delete is not available, the object may not be deleted (ex. Wizards, etc.)

Copying an object

Sometimes you want to make a new object that is similar to an existing object. In this case, it is easier and faster to copy the object and then customize the new object.

To duplicate an object:

  1. select the object (or objects) you wish to duplicate
  2. right click, and select Duplicate from the menu (note that the new object(s) is given a default name)
  3. select the new object and give it a descriptive name
  4. make any other changes necessary to the new object

You can also copy/paste objects to duplicate them - this can be helpful when you want the new object in a different collection than the existing object.

To copy an object:

  1. select the object (or objects) you wish to copy
  2. right click, and select Copy from the menu
  3. navigate to the collection where you wish to place the copy (or copies)
  4. to paste at the end, click on the collection; to insert, click on the object where you would like the new object to be placed
  5. right click, and select Paste Into (when appending at the end of the collection) or Paste Here (when inserting inside the collection on an item)

Creating Groups

Many of the collections support Groups, which are similar to subfolders inside the main folder. Unless mentioned otherwise, there is no particular significance to groups, apart from helping you better organize objects, particularly in larger Containers.

To create a subgroup:

  1. select the collection (group) in which you want the new subgroup
  2. right click, and select New Group from the menu
  3. in the dialog, specify the number of subgroups (usually 1)
  4. specify the exact type (the indicated default is usually correct)
  5. press Ok

As for all new objects, it is generally a good idea to give the new subgroup a descriptive name.

Project Collections

Follow the links for detailed descriptions of the object types.

  • docs - a Doc object is a web-like document that can be used to document a model, provide instructions on operating it, and so on
  • wizards - a Wizard provides automated assistance in creating other objects, such as complete network simulations (note: you will never create these)
  • edits - a ControlPanel provides a way to gather properties from many other objects, to set them in one place - for example, you can collect various network parameters all in one place, to easily set them
  • data - holds datatables - the system automatically provides several subgroups to help organize your data, you can also add new subgroups of your own
  • data proc - holds pre-built DataProc objects - similar to Wizards, these provide various data services that operate on data (note: you will never create these)
  • programs - a Program controls network simulations, data processing, and other automated procedures - when you use a wizard to create a simulation, it automatically imports the required standard programs from the program library
  • viewers - holds 3D Viewer objects - every project gets a Default Viewer, which is created when the project is created, and opened automatically when the project is opened - you can also create additional viewers - you might want to do this for larger projects, to include lesser-used graphs or other 3D views - to open auxiliary views, right click the view and select View Window
  • networks - most network simulations use a single network, but you can create more than one, such as for example to experiment with different configurations

Converting a PDP++ Project

See PDP++ Project Conversion for detailed information on this process.