Package: analysis-engine
analysis_engineSoftware for portfolio management reporting and analysis in the UK Department for Transport, operated via command line
interface (CLI) prompts.InstallingPython must be installed on your computer. If not already installed, it can be installed via the python websitehere.IMPORTANTensure thatAdd Python to PATHis ticked when provided
with the option as part of the installation wizard.Open the command line terminal (Windows) or bash shell and install viapip install analysis_engine.Directories, file paths and poppler.In order to operate the correct directories and files must be set-up and saved on the user's computer.analysis_engineis able to handle different operating systems.Create the following directories in yourMy Documentsdirectory:|-- ipdc
    |-- core_data
        |-- json
    |-- input
    |-- output
|-- top250
    |-- core_data
        |-- json
    |-- input
    |-- outputEach reporting process e.g. ipdc and top250, respectivecore_datadirectorates require:excel master data files;excel project information file; and,A confi.ini file. This file lists and master data and project information file names.As a minimum theinputfolder should have the following documentssummary_temp.docx,summary_temp_landscape.docx. In additionipdc\inputshould have thedashboards_master.xlsxfile.All outputs from analysis_engine will be saved into theoutputdirectory.Thejsonfolder is where analysis_engine saves master data in an easily accessible
format (.json) and after setup can be ignored by the user.Unfortunately there is one further manual installation, related to a package within analysis_engine
which enables high quality rendering of graphical outputs to word documents. On Windows do the following:Download zip of poppler release from this linkhttps://github.com/oschwartz10612/poppler-windows/releases/download/v21.03.0/Release-21.03.0.zip.unzip and move the whole directory to My Documents.Add the poppler bin directory to PATH following these instructionshttps://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/Reboot computer.Mac users should follow instructions herehttps://pypi.org/project/pdf2image/Most Linux distributions should not require any manual installation.Operating analysis_engineTo operate analysis_engine the user must enter the initialcommandanalysisfollowed by asubcommandto specify the reporting process e.gipdcortop250and then finally an analytical outputargument, the options
for which are set out below.NOTEthe--helpoption is available throughout the entire command
line prompt construction process and the user should use it for guidance on what subcommands
and arguments are available for use.analysis_engine currently has the followingarguments:initiateThe user must enter this command
every time master data, contained in the core_data directory, is updated.
The initiate checks and validates the data in a number of ways.dashboardspopulates the IPDC PfM report dashboard. A blank template dashboard
must be saved in the ipdc/input directory. (Not currently available for top250.)dandelionproduces the portfolio dandelion info-graphic.costsproduces a cost profile trend graph and data. (Not currently available for top250.)milestonesproduces milestone schedule graphs and data.vfmproduces vfm data. (Not currently available for top250.)summariesproduces project summary reports.risksproduces risk data. (Not currently available for top250.)dcasproduces dca data. (Not currently available for top250.)speedialprints out changes in project dca ratings. (Not currently available for top250.)queryreturns (from master data) specific data required by the user.The default for each argument is to return outputs with current and last quarter data.Further to each argument the user can specify one or many
furtheroptional_argumentsto alter the analytical output produced. There are
many optional_arguments available, which vary for each argument,
and the user should use the--helpoption to specify those that are available.