Project Management

Project Quick Start

Project and Project Manager Quick Start

You can work directly on project:

project1 = Project(project_name="mynewproj", project_path="/path/to/proj")

project1.rename("project", "mynewproj", "hello_project")
project1.import()
project1.authors = "OpenAlea Consortium and John Doe"
project1.description = "Test project concept with numpy"
project1.long_description = '''This project import numpy.
Then, it create and display a numpy eye.
We use it to test concept of Project.''

project1.add(category="scripts", name"hello.py", value="print 'Hello World'")
project1.description = "This project is used to said hello to everyone"

project1.add("startup", "begin_numpy.py", "import numpy as np")
project1.add("scripts", "eye.py", "print np.eye(2)")
project1.rename("scripts", "eye.py", "eye_numpy.py")

project1.save()

Or, you can create or load a project thanks to the project manager.

from openalea.vpltk.project.manager import ProjectManager
# Instanciate ProjectManager
project_manager = ProjectManager()
# Discover available projects
project_manager.discover()
print project_manager.projects

# Create project in default directory or in specific one
p1 = project_manager.create('project1')
p2 = project_manager.create('project2', '/path/to/project')
# Load project from default directory or in specific one
p3 = project_manager.load('project3')
p4 = project_manager.load('project4', '/path/to/project')

# Load
project2 = project_manager.load("numpy_project")
# Run startup
project2.import()
# Run script
project2.run_script("eye_numpy.py")

To search projects that are not located inside default directories:

project_manager.find_links.append('path/to/search/projects')
project_manager.discover()
print project_manager.projects

Various Views on Project Manager and Project

Project API

The Project is a structure which permit to manage different objects.

It store metadata (name, author, description, version, license, ...) and data (src, models, images, ...).

You have here the default architecture of the project named “project_name”, stored in your computer.

/project_name

oaproject.cfg (Configuration file) /src (Files sources, Script Python, LPy...) /control (Control, like color map or curve) /scene (scene, scene 3D) /cache (Intermediary saved objects) /data (Data files like images, .dat, ...) /startup (Preprocessing scripts) .py (Preprocessing scripts) *import.py (Libs and packages to import in preprocessing)

use:

project1 = Project(project_name="mynewproj", project_path="/path/to/proj")
project1.start()
project1.add(category="src", name"hello.py", value="print 'Hello World'")
project1.author = "John Doe"
project1.description = "This project is used to said hello to everyone"
project1.save()

class openalea.vpltk.project.project.Project(project_name, project_path, icon='', author='OpenAlea Consortium', author_email='', description='', long_description='', citation='', url='', dependencies=, []license='CeCILL-C', version='0.1')

add(category, name, value)

Add an object in the project

Parameters:

• category – type of object to add (“src”, “control”, “scene”, ...)
• name – filename of the object to add (path or str)
• value – to add (string)

See also

get() remove()

add_script(name, script)

Add a src in the project

Deprecated:

replace by add() method

Parameters:

• name – filename of the src to add (path or str)
• script – to add (string)

See also

add()

author

author_email

cache

citation

control

create()

Do the same thing that import method.

See also

start() load() load_manifest()

data

dependencies

description

doc

get(category, name)

Search an object inside project and return it.

Parameters:

• category – category of object to get
• name – name of object to get

Returns:

object named name in the category category if it exists. Else, None.

Use:

>>> get(category="src", name="myscript.py")

See also

add()

get_scene()

Returns:self.scene (dict)

icon

is_project()

Returns:True

is_script()

Returns:False

license

load()

Realize a total loading of project (contrary to load_manifest()).

1. Load manifest load_manifest()
2. Read data files listed in manifest and fill project object.

See also

start() load_manifest()

load_manifest()

Partially load a project from a manifest file.

1. Read manifest file (oaproject.cfg).
2. Load metadata inside project from manifest.
3. Load filenames of data files inside project from manifest.
4. Not load data ! If you want to load data, please use load().

Warning:load metadata and list of filenames but does not load files

See also

save_manifest() load()

long_description

name

ns

remove(category, name)

Remove an object in the project

Remove nothing on disk.

Parameters:

• category – category of object to remove (“src”, “control”, “scene”, ...) (str)
• name – filename of the src to remove (path or str)

remove_script(name)

Add a src in the project

Remove nothing on disk.

Deprecated:replace by remove() method Parameters:name – filename of the src to remove (path or str)

See also

remove()

rename(category, old_name, new_name)

Rename a src, a scene or a control in the project. If category is project, rename the entire project.

Parameters:

• category – Can be “src”, “control”, “scene” or “project” (str)
• old_name – current name of thing to rename (str)
• new_name – future name of thing to rename (str)

run_src(name)

Try to run the source file named name into current shell

save()

Save project on disk.

1. Save data files.
2. Save metadata and list on previously saved data into a manifest file (oaproject.cfg).

See also

save_manifest()

save_manifest()

Save a manifest file on disk. His name is “oaproject.cfg”.

It contains list of files that are inside project (manifest) and metadata (author, version, ...).

See also

load_manifest()

scene

src

start()

1. load() objects into project.
2. Import startup.
3. Run preprocessing.

See also

load() load_manifest()

startup

url

use_ipython()

Returns:True if project is instaciated with a shell IPython. Else, return False.

version

class openalea.vpltk.project.manager.ProjectManager

Object which manage projects: creation, loading, saving, searching, ...

It is a singleton.

clear()

Clear the list of projects.

close(project_name=None, project_path=None)

TODO:not yet implemented

create(project_name, project_path=None)

Create new project and return it.

Use:

>>> project1 = project_manager.create('project1')
>>> project2 = project_manager.create('project2', '/path/to/project')

Parameters:

• project_name – name of project to create (str)
• project_path – path where project will be saved. By default, project_path is the user path of all projects ($HOME/.openalea/projects/).

Returns:

Project

default()

Returns:a default empty project

discover()

Discover projects from your disk and put them in self.projects.

Projects are not loaded, only metadata are.

Use:

>>> project_manager.discover()
>>> print project_manager.projects

To discover new projects, you can add path into self.find_links

project_manager.find_links.append('path/to/search/projects')
project_manager.discover()

get_current()

Returns:

current active project

Use:

>>> project = project_manager.get_current()

instance = None

load(project_name, project_path=None)

Load existing project

Use:

>>> project1 = project_manager.load('project1')
>>> project2 = project_manager.load('project2', '/path/to/project')

Parameters:

• project_name – name of project to load. Must be a string.
• project_path – path of project to load. Must be a path (see module path.py). By default, the path is the openaelea.core.settings.get_project_dir() ($HOME/.openalea/projects/).

Returns:

Project

load_default()

Load default project if it exists, else create it.

Returns:the default loaded project

search(*args, **kwargs)

Search a specific project that match filters.

Use:

>>> project_manager.search(name="*mtg*", author="*Godin*")

TODO:

not implemented yet

openalea.vpltk.project.manager.main()