Warning

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

Files

This page describes the file system used in plans.

See also

Check out the Projects page for more details on how to setup a project.

The file system in plans is quite straight-forward. All files are always formatted in two ways:

• csv format for Table structure;

• GeoTIFF format for :ref:<io-raster>` (map) structure.

All files fall into these workflow categories:

1. Input Files: required and optional data files that users must provide by themselves. Input files lives in the data/ folder of a project.

2. Intermediate Files: data files generated by plans as intermediate step to final processing, like cached data. Users may also provide this files to skip intermediate steps. Like input files, intermediate files lives in the data/ folder of a project;

3. Output Files: data files generated by plans as results of final processing. Output files lives under outputs/ in the respective subfolder of the processing session.

Files Index

Check out the Files Index page for the full list of files and specifications.

Note

All files not listed in the Files Index is ignored by plans.

Data structures and formatting

Check out the Data Structures page for more details on how to format input data.

Input Files

An Input File is a data file that users must provide by themselves. Input Files lives in their respective subfolders under the data/ folder of a project.

Required Input Files

A Required Input File is an Input File that are necessary for a viable simulation run of plans. In other words: it is impossible to run without the file.

File	Name	Structure
basin.tif	Basin Area	Raster
climate_series.csv	Climate Series	Time Series
hand.tif	Height Above Nearest Drainage	Raster
ldd.tif	Local Drain Direction	Quali Raster
lulc_attributes.csv	Land Use Attributes	Attribute Table
lulc_{date}.tif	Land Use Map	Time Quali Raster
parameters_info.csv	Parameters Info	Info Table
project_info.csv	Project Info	Info Table
soils.tif	Soils Map	Quali Raster
soils_attributes.csv	Soils Attributes	Attribute Table
twi.tif	Topographic Wetness Index	Raster

Optional Input Files

An Optional Input File is an Input File that are used in plans for extra simulation or assessments. If not provided, plans may skip the extra simulation or parse default built-in data.

File	Name	Structure
dem.tif	Digital Elevation Model	Raster
flowacc.tif	Flow Accumulation	Raster
hillshade.tif	Hill Shade	Raster
qobs_series.csv	Streamflow Series	Time Series
slope.tif	Slope	Raster
uparea.tif	Upslope Area	Raster

Intermediate Files

An Intermediate File is a cached file: a data file that is generated by plans during setup processes prior to simulation or assessment main process. They are necessary for a viable simulation run of plans. Like Input Files, Intermediate File lives in under respective subfolders under the data/ folder of a project.

Skipping setup processes

Users can skip setup processes by providing Intermediate Files to a project, but it must be consistent with plans standards.

File	Name	Structure
climate_series_lulc_{lulc-scenario}.csv	Climate And Land Use Series	Time Series
dist_area_hist.csv	Distance Vs Area Histogram	Table
dto.tif	Distance To Outlet	Raster
lulc_series.csv	Land Use Series	Time Series
lulc_{date}_{parameter}.tif	Land Use Parameter Map	Time Raster
soils_{parameter}.tif	Soils Parameter Map	Raster
tsi.tif	Topographic Saturation Index	Raster

Output Files

An Output File is a data file generated by plans during simulation or assessment main process. Output Files lives in the respective process folder under outputs/ of a project.

File	Name	Structure
simulation_series.csv	Simulation Series	Time Series