Warning

Documentation website under active development. This is not a stable release.

Examples

This page show hands-on examples and tutorials for running plans.

Install plans

Check out Installation section in the User Guide.

Setting up projects

Import plans

import plans

New project

Set new project details in a python dict:

# [CHANGE THIS] setup specs dictionary
project_specs = {
    "folder_base": "C:/plans", # change this path
    "name": "newProject",
    "alias": "NPrj",
    "source": "Me",
    "description": "Just a test"
}

Then call plans.new_project()

plans.new_project(specs=project_specs)

This will make a new project in the base folder provided.

Warning

An error is raised if a project already exists with this name.

This syntax creates and load to a variable the plans.Project instance:

prj = plans.new_project(specs=project_specs)

Load project

Call plans.load_project()

prj = plans.load_project(project_folder="C:/plans/NewProject")