+ {% if post.link %} + {{ title }} Permalink + {% else %} + {{ title }} + {% endif %} +
+ {% if post.read_time %} + + {% endif %} + {% if post.excerpt %}{{ post.excerpt | markdownify | strip_html | truncate: 160 }}
{% endif %} +
+
+*Value="01/01/1990" = $1^{st}$ January 1990* +
*Value="05.07.1990" = $5^{st}$July 1990* +
*Value="15-11-1990" = $15^{st}$ November 1990* + +- **DtSec** is the simulation time interval in seconds. It has a value of 86400 for a daily time interval, 3600 for an hourly interval, etcetera. + +- **DtSecChannel** is the simulation time interval used by the kinematic wave channel routing (in seconds). Using a value that is smaller than **DtSec** may result in a better simulation of the overall shape the calculated hydrograph (at the expense of requiring more computing time). + +- **StepStart** is the date of the first time step in your simulation. + +- **StepEnd** is the date of the last time step in your simulation. + +**ReportSteps** defines the time step number(s) at which the model state (i.e. all maps that you would need to define the initial conditions of a succeeding model run) is written. +Note that this option only impacts the output frequency of the model state variables (activated by the "repStateMaps" option), not to the auxiliary variables. The full list of the affected variables is [here](../4_annex_state-variables). You can define this parameter in the following ways: + +1) **At specific time steps**. If you like to have the state maps being written at certain time steps you can define those in a (comma separated) list. For example if you like to have the state maps for the time steps 10, 20 and 40, you need to write: + +```xml +
++ **meteorological forcings**. These maps provide time series of values for each pixel of the computational domain. More specifically, the meteorological forcings provide the values of precipitation, temperature, reference values of evaporation from water surfaces, reference values of evaporation from open water bodies, reference values of evapotranspiration for each pixel of the modelled area. For each meteorological forcing, one map is required for each computational time step.
++ **static maps**. These maps provide information of morphological, physical, soil, and land use properties for each pixel of the computational domain. + + +### Meteorological forcings + +The meteorological forcing variables are defined in *map stacks*. A *map stack* is simply a series of maps, where each map represents the value of a variable at an individual time step.
It is recommented to use the netcdf format.
The users that prefer to prepare the meteorological forcings maps in pcraster format, must name the files according to the following rules: the name of each map is made up of a total of 11 characters: 8 characters, a dot and a 3-character suffix. Each map name starts with a *prefix*, and ends with the time step number. All character positions in between are filled with zeros ("0").
+ +Generally used prefixes for the meteorological forcings maps are:
++ tp : total precipitation; units: mm/day.
++ ta : average daily temperature at 2m; units: degrees Celsius or Kelvin (the units must be specified in the [settings file](../3_step3_preparing-setting-file/))
++ EW0 : reference value of evaporation from open water bodies; units: mm/day; these data can be prepared using [LISVAP](https://ec-jrc.github.io/lisflood-lisvap/).
++ ES0 : reference value of evaporation from bare soil; units: mm/day; these data can be prepared using [LISVAP](https://ec-jrc.github.io/lisflood-lisvap/).
++ ET0 : reference value of evapotranspiration; units: mm/day; these data can be prepared using [LISVAP](https://ec-jrc.github.io/lisflood-lisvap/).
+ + + +### Static maps +The section [Static Maps](../4_Static-Maps-introduction) provides detailed guidelines for the preparation of the static maps data set. The following paragraph provides an overview of the different piecies of information provided by the static maps. ++ [general maps](../4_Static-Maps_general-maps/): area mask; landuse mask; grid-cell length; grid-cell area. ++ [topography](../4_Static-Maps_topography/): local drain direction; gradient; standard deviation of elevation; upstream area. ++ [land use maps](../4_Static-Maps_land-use/): fraction of forest; fraction of irrigated crops; fraction of rice crops; fraction of inland water; fraction of sealed surfaces; fraction of other land uses. ++ [land use depending](../4_Static-Maps_land-use-depending/):crop coefficient; crop group number; Manning/s's surface roughness; soil depth. ++ [soil hydraulic properties](../4_Static-Maps_soil-hydraulic-properties/): saturated hydraulic conductivity; soil water content at saturation; residual soil water content; parameters alpha and lambda of Van Genuchten's equations. ++ [channel geometry](../4_Static-Maps_channel-geometry/): channels mask; channels side slope; channels length; channels gradient; Manning's rougheness coefficient of the channels; channels bottom width; floodplain width; bankfull channels depth. ++ [leaf area index](../4_Static-Maps_leaf-area-index/): evolution of vegetation over time (leaf area index) for land covers forest, irrigated areas, others. ++ [reservoirs and lakes](../4_Static-Maps_reservoirs-lakes/): lake mask; lakes ID points; reservoirs ID points. These maps are required only upon activation of the [lakes module](https://ec-jrc.github.io/lisflood-model/3_02_optLISFLOOD_lakes/) and/or of the [reservoirs module](https://ec-jrc.github.io/lisflood-model/3_03_optLISFLOOD_reservoirs/). ++ [rice calendar](../4_Static-Maps_rice-calendar/): rice calendar for planting and harvesting seasons. These maps are required only when activating the [rice irrigation module](https://ec-jrc.github.io/lisflood-model/2_17_stdLISFLOOD_irrigation/) ++ inflow points: locations and IDs of the points in which LISFLOOD adds an inflow hydrograph, as explained [here](https://ec-jrc.github.io/lisflood-model/3_09_optLISFLOOD_inflow-hydrograph/) ++ water demand maps: domestic, energetic, livestock, industrial water use. These maps represent the time series of spatially distributed values of water demand for domestic, energetic, livestock, and industrial water use. These maps are required only when activating the [water use module](https://ec-jrc.github.io/lisflood-model/2_18_stdLISFLOOD_water-use/) ++ outlet points: locations and IDs of the points for which LISFLOOD provides the time series of discharge values. + +#### Role of "mask" and "channels" maps + +The mask map (i.e. "area.map") defines the model domain. In order to avoid unexpected results, **it is vital that all maps that are related to topography, land use and soil are defined** (i.e. don't contain a missing value) for each pixel that is "true" (has a Boolean 1 value) on the mask map. The same applies for all meteorological input and the Leaf Area Index maps. Similarly, all pixels that are "true" on the channels map must have some valid (non-missing) value on each of the channel parameter maps. Undefined pixels can lead to unexpected behaviour of the model, output that is full of missing values, loss of mass balance and possibly even model crashes. Some maps needs to have values in a defined range e.g. the gradient map has to be greater than 0. + +#### Geometrical properties of the computational grid cell + +LISFLOOD needs to know the size properties of each grid cell (length, area) in order to calculate water *volumes* from meteorological forcing variables that are all defined as water *depths*. By default, LISFLOOD obtains this information from the location attributes of the input maps. This will only work if all maps are in an "equal area" (equiareal) projection, and the map co-ordinates (and cell size) are defined in meters. For datasets that use, for example, a latitude-longitude system, neither of these conditions is met. In such cases you can still run LISFLOOD if you provide two additional maps that contain the length and area of each grid cell + +##### Table: Optional maps that define grid size + +| **Map** | **Default name** | **Description** | +| --------------- | ------------------ | ------------------------------------------------------------ | +| PixelLengthUser | pixleng.map/nc | Map with pixel length
Unit: $[m]$,
*Range *of values: map \> 0* | +| PixelAreaUser | pixarea.map/nc | Map with pixel area
*Unit:* $[m^2]$,
*Range of values: map \> 0* | + +Both maps should be stored in the same directory where all other input maps are. The values on both maps may vary in space. A limitation is that a pixel is always represented as a square, so length and width are considered equal (no rectangles). In order to tell LISFLOOD to use the maps a, you need to activate the special option "*gridSboveizeUserDefined*", which involves adding the following line to the LISFLOOD settings file: + +```xml +
ThetaForestInit2Value | initial soil moisture content
upper soil layer (V/V)| set to soil moisture content
at field capacity | +| ThetaInit2Value /
ThetaForestInit2Value | initial soil moisture content
lower soil layer (V/V) | set to soil moisture content
at field capacity | +| LZInitValue /
LZForestInitValue | initial water in lower
groundwater zone (mm) | set to steady-state storage | +| TotalCrossSectionArea
InitValue | initial cross-sectional area
of water in channels | set to half of bankfull depth | +| PrevDischarge | Initial discharge | set to half of bankfull depth | + +$^1$ These special initialisation methods are activated by setting the value of each respective variable to a 'bogus' value of "-9999"* + +Note that the "-9999" 'bogus' value can *only* be used with the variables in the Table above; the use of the 'bogus' value for all the other variables will produce nonsense results! For this reason, the initialisation of the lower groundwater zone is necessary.
+ +*WARNING!* In areas with arid climate and very thick (~10^2) soils, the use of initial soil water content equal to field capacity creates nonrealistic large discharge values in the channels.
+ +To avoid nonrealistic results in such specific contexts, it is recommended to use the end states of the initialization run to initialize the soil and upper groundwater zone storages of the cold run.
+ +The following end states can be used for the initialization of the run: upper groundwater zone water content; water content of soil layers 1,2,3 for the all the land use categories (other, forest, irrigation).
+ +In summary, the initialization of the lower groundwater zone is always necessary (see paragraph below); the use of the end states to initialize the upper groundwater zone water content and the water content of soil layers 1,2,3 is optional.
+This optional, extensive initialization has been implemented in OS-LISFLOOD v4.0.0. The interested users can then use the provided templates as an example to prepare their own [initialization run](../media/lisfloodSettings_reference_prerun_optional_init_v4.0.0.xml) and run with [cold start](../media/lisfloodSettings_reference_coldstart_optional_init_v4.0.0.xml). Please note that the content of this paragraph does not apply to the runs with warm start!
+ +**Initialisation of the lower groundwater zone** +Even though the use of a sufficiently long warm-up period usually results in a correct initialisation, a complicating factor is that the time needed to initialise any storage component of the model is dependent on the average residence time of the water in it. For example, the moisture content of the upper soil layer tends to respond almost instantly to LISFLOOD's meteorological forcing variables (precipitation, evapo(transpi)ration). As a result, relatively short warm-up periods are sufficient to initialise this storage component. At the other extreme, the response of the lower groundwater zone is generally very slow (especially for large values of $T_{lz}$). Consequently, to avoid unrealistic trends in the simulations, very long warm-up periods may be needed. The Figure below shows a typical example for an 8-year simulation, in which a decreasing trend in the lower groundwater zone is visible throughout the whole simulation period. Because the amount of water in the lower zone is directly proportional to the baseflow in the channel, this will obviously lead to an unrealistic long-term simulation of baseflow. Assuming the long-term climatic input is more or less constant, the baseflow (and thus the storage in the lower zone) should be free of any long-term trends (although some seasonal variation is normal). In order to avoid the need for excessive warm-up periods, LISFLOOD is capable of calculating a 'steady-state' storage amount for the lower groundwater zone. This *steady state* storage is very effective for reducing the lower zone's warm-up time. The concept of *steady state* is explained in the [LISFLOOD model description](https://ec-jrc.github.io/lisflood-model/2_13_stdLISFLOOD_groundwater/), here we will show how it can be used to speed up the initialisation of a LISFLOOD run. + + +**Steady-state storage in practice** +An actual LISFLOOD simulation differs from the theoretical *steady state* in 2 ways. First, in any real simulation the inflow into the lower zone is not constant, but varies in time. This is not really a problem, since $LZ_{ss}$ can be computed from the *average* recharge. However, this is something we do not know until the end of the simulation! Also, the inflow into the lower zone is controlled by the availability of water in the upper zone, which, in turn, depends on the supply of water from the soil. Hence, it is influenced by any calibration parameters that control behaviour of soil- and subsoil (e.g. $T_{uz}$, $GW_{perc}$, $b$, and so on). This means that -when calibrating the model- the average recharge will be different for every parameter set. Note, however, that it will *always* be smaller than the value of $GW_{perc}$, which is used as an upper limit in the model. +As an alternative to using the internal initialization (and hence the bogus values), LZavin and AvgDis (LZInitValue and PrevDischarge) can be computed using an initialization run (or pre-run). The pre-run procedure must include a sufficiently long warm-up period to allow the computation of reliable values of LZavin and AvgDis. The set-up of the initialization run is explained below: the protocol differs slightly depending on the settings of the option split routing. + + +## What you need to do: + +### Option 1: If using Kinematic routing only (no split routing): + +1) Set initial state of all state variables to either 0,1 or -9999 (i.e. cold start with default values or internally initialized values) in Settings.XML file + +2) Activate the “InitLisfloodwithoutsplit” and the "InitLisflood" options in
+The examples in this user guide have been derived from the generation of the static input maps for the European and Global Flood Awareness Systems (EFAS and GloFAS) of the Copernicus Emergency Management Service. Users are encouraged to create their own static maps for their region of interest and using local, national or any other type of source data. Possible data sources, used as examples in this user guide, are listed in the [Appendix](../4_Static-Maps_appendix).
+Maps can be elaborated with any GIS/remote sensing software. Examples in this guide have been performed using CDO, GDAL, Python, and Google Earth Engine platform.
+ +## Projection and file type + +All static input maps for LISFLOOD need to have the same model domain, projection, resolution – same number of columns and rows, and same grid of coordinates (i.e. all 4 corners of each pixel must have exactly the same coordinates in degrees or in meters, depending on the reference system). This is a strict requirement of the [LISFLOOD model](https://github.com/ec-jrc/lisflood-code) (here and below ‘the LISFLOOD model’ refers to the version 3.1.0) that at present cannot accept input maps at different spatial resolution or geographical extension.
+All maps should be introduced in the model in NetCDF or PCRaster file format. +This user guide provides the examples for the European and Global domains that are being used in EFAS and GloFAS models, respectively. The static fields structure for EFAS and GloFAS is the following:
+ ++ Projection EPSG:4326 - WGS84: World Geodetic System 1984; ++ Examples of horizontal resolution: 1' (~1.86 km at the Equator) and 3' (~5.57 km at the Equator); ++ Examples of coverage and horizontal resolution: a) global domain: North = 90.00 N; South = 90.00 S; West = 180.00 W; East = 180.00 E; file size in grid-cells: 03' = 7200x3600; b) European domain: North = 72.25 N; South = 22.75 N; West = 25.25 W; East = 50.25 E; file size in grid-cells: 01' = 4530x2970; ++ NoData value: 1) for Byte (Int8) files = 0; 2) for Real (Float32) files = -999999.0. ++ Ocean masked with NoData (except, pixel length and pixel area maps). + + +### Authors of the version compiled in May 2021 +Margarita Choulga, Francesca Moschini, Christel Prudhomme, Cinzia Mazzetti and ECMWF team + +#### Acknowledgements +The authors thank Juliana Disperati (JRC), Stefania Grimaldi (JRC), Peter Salamon (JRC) and Ad De Roo (JRC) for invaluable help with examining the upgraded static map and guidance throughout the work and preparation of this user guide; Dai Yamazaki (The University of Tokyo) and Emanuel Dutra (IPMA) for useful discussions and comments; Damien Decremer (ECMWF) for expert help with file transformation technical work.
+Margarita Choulga, Francesca Moschini, Christel Prudhomme, and Cinzia Mazzetti were funded by Copernicus Emergency Management Service – Early Warning Systems – operational computational centre of EFAS (CEMS-Flood) project which received funding from European Commission Copernicus Emergency Management Service (CEMS) Framework Contract No 198702 awarded to ECMWF. + + diff --git a/docs/4_Static-Maps_appendix/index.md b/docs/4_Static-Maps_appendix/index.md new file mode 100644 index 00000000..a7ee800a --- /dev/null +++ b/docs/4_Static-Maps_appendix/index.md @@ -0,0 +1,55 @@ +# Appendix +## Short description of main possible data sources to create the static maps dataset + ++ **CaMa-Flood**: Global River Hydrodynamics Model maps +The [CaMa-Flood](http://hydro.iis.u-tokyo.ac.jp/~yamadai/cama-flood/index.html) (Catchment-based Macro-scale Floodplain) model is a global-scale distributed river model, which is driven by runoff forcing from a land surface model. In order to represent the process of floodplain inundation, the river channel and floodplain topography are represented by sub-grid-scale topographic parameters. The ground elevation, unit-catchment area, channel length and floodplain elevation profile are explicitly derived from fine-resolution flow direction maps and DEMs using the FLOW method.
+Basic map data and sample input data are provided by the model developers, namely: i) the global river map (i.e. river network map, river topography parameters, high-resolution (1 arc min) topography data) based on MERIT Hydro at 15min, 6min, 5min, 3min, 1min resolutions; ii) pre-processed Earth2Observe (E2O) runoff products (i.e. 0.25 degree, daily, 1980-2014, WRR2 version, 7 Land models) and the runoff climatology data; and iii) the river channel parameters, where the channel cross section parameters (i.e. channel width and channel depth) are derived empirically as a function of river discharge due to the lack of global-scale observations of channel cross sections.
+*Source: http://hydro.iis.u-tokyo.ac.jp/~yamadai/cama-flood/index.html*
+ ++ **MERIT DEM**: Multi-Error-Removed Improved-Terrain DEM
+The [MERIT DEM](http://hydro.iis.u-tokyo.ac.jp/~yamadai/MERIT_DEM/index.html): Multi-Error-Removed Improved-Terrain Digital Elevation Model is a high accuracy global DEM at 3 arc second resolution (~90 m at the Equator) covering land area 90N-60S (referenced to EGM96 geoid) with separated absolute bias, stripe noise, speckle noise and tree height bias (achieved by using the existing spaceborne DEMs (SRTM3 v2.1 and AW3D-30m v1) and filtering techniques). It also contains significant improvements in flat regions, where height errors are larger than topography variability, and landscapes such as river networks and hill-valley structures became clearly represented. +MERIT DEM was developed by processing the following products as baseline data (all are freely available from their web pages): i) NASA SRTM3 DEM v2.1; ii) JAXA AW3D-30m DEM v1; iii) Viewfinder Panoramas' DEM. In addition to the baseline DEMs, following products were used as supplementary data: i) NASA-NSIDC ICESat/GLAS GLA14 data; ii) U-Maryland Landsat forest cover data; iii) NASA Global Forest Height Data; iv) JAMSTEC/U-Tokyo G3WBM water body data.
+Initial data consists of 57 GeoTiff files 30x30 degree region each.
+*Source: http://hydro.iis.u-tokyo.ac.jp/~yamadai/MERIT_DEM/index.html*
+ ++ **CORINE Land Cover 2018** CLC2018
+The [CORINE](https://land.copernicus.eu/pan-european/corine-land-cover) (Coordination of Information on the Environment) Land Cove (CLC) inventory for 2018 (CLC2018) is one of the datasets produced within the Corine Land Cover frame programme referring to land cover / land use status of year 2018. It covers 39 countries with a total area of over 5.8 Mkm 2 . Satellite imagery provides the geometrical and thematic basis for mapping within situ data as essential ancillary information. The basic technical parameters of CLC (i.e. 44 classes in nomenclature, 25 hectares minimum mapping unit (MMU), and 100 meters minimum mapping width) have not changed since the beginning, therefore the results of the different inventories are comparable. The time period covered by CLC2018 asset is 2017 to 2018.
+*Source: https://developers.google.com/earth-engine/datasets/catalog/COPERNICUS_CORINE_V20_100m#description*
+ ++ **Copernicus Global Land Cover Layers: CGLS-LC100** collection 2 +The Dynamic Land Cover map [CGLS-LC100](https://developers.google.com/earth-engine/datasets/catalog/COPERNICUS_Landcover_100m_Proba-V-C3_Global#description) is a global land cover map at 100 m spatial resolution. The CGLS provides discrete classes of land cover, and continuous field layers for all basic land cover classes that provide percentage of a grid-cell covered by certain land cover type. Provided maps are derived from the PROBA-V 100 m time-series, a database of high quality land cover training sites and several ancillary datasets, reaching an accuracy of 80% at Level1 over all years.
+*Source: https://developers.google.com/earth-engine/datasets/catalog/COPERNICUS_Landcover_100m_Proba-V-C3_Global#description* + ++ **Global Lakes and Wetlands Database (GLWD)**: Large Lake Polygons (Level 1 & 2)
+The [Global Lakes and Wetlands Database (GLWD)](https://www.worldwildlife.org/pages/global-lakes-and-wetlands-database) has been created on the basis of existing maps, data and information, such as the Digital Chart of the World, World Conservation Monitoring Centre (WCMC) and others. It draws upon the best available maps, data and information to display lakes and wetlands on a global scale (1:1 to 1:3 million resolution). The application of GIS functionality enables the generation of a database which focuses in three coordinated levels on (1) large lakes and reservoirs, (2) smaller water bodies, and (3) wetlands.
+[Level 1 (GLWD-1)](https://www.worldwildlife.org/publications/global-lakes-and-wetlands-database-large-lake-polygons-level-1) comprises the shoreline polygons of the 3067 largest lakes (area ≥ 50 km2) and 654 largest reservoirs (storage capacity ≥ 0.5 km3) worldwide, and includes extensive attribute data. [Level 2 (GLWD-2)](https://www.worldwildlife.org/publications/global-lakes-and-wetlands-database-small-lake-polygons-level-2) comprises approximately 250,000 permanent open water bodies polygons (attributed as lakes, reservoirs and rivers) with a surface area ≥ 0.1 km2 excluding the water bodies contained in GLWD-1. GLWD-1 and GLWD-2 are delivered with global coverage in shapefile format. [Level 3 (GLWD-3)](https://www.worldwildlife.org/publications/global-lakes-and-wetlands-database-lakes-and-wetlands-grid-level-3) comprises lakes, reservoirs, rivers and different wetland types.
+*Source: http://www.fao.org/land-water/land/land-governance/land-resources-planning-toolbox/category/details/en/c/1043160/* + ++ **Spatial Production Allocation Model (SPAM)** - Global Spatially-Disaggregated Crop Production Statistics Data for 2010 (V 1.0)
+The [Spatial Production Allocation Model (SPAM)](https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/PRFF8V) is an effective way to map detailed patterns of crop production using much less specific (e.g. country, subnational provinces) input data. Using a variety of inputs, SPAM uses a cross-entropy approach to make plausible estimates of crop distribution for 42 crops (such as rice, cassava, potatoes, wheat, maize, etc.) and two production systems (i.e. irrigated and rainfed) within disaggregated units. Knowing where in the world individual crops are cultivated, their production patterns, and whether they are irrigated or rainfed is important for improving spatial understanding of crop production systems, and allows policymakers and donors to better target agricultural and rural development policies and investments, increasing food security and growth with minimal environmental impacts.
+*Source: https://nasaharvest.org/news/spam-2010-updated-global-crop-data-aid-food-policy-decisions*
+ ++ **RiceAtlas**, a spatial database of global rice calendars and production Version 3
+The [RiceAtlas](https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/JE6R2R) dataset has collected data on the start, peak, and end dates of sowing or transplanting, and the start, peak, and end dates of harvesting of rice for all seasons in all rice-growing countries. In cases where peak planting and harvesting dates were not available, dates were estimated to be at the midpoint between the start and end dates. Planting in a region is not done on a single date but the length of the planting window varies between regions. In the absence of information, the planting window was set to 30 days. Where available, additional data such as crop establishment method and seedling age for transplanted rice were recorded. Data is delivered with global coverage in shapefile format.
+*Source: https://www.ncbi.nlm.nih.gov/pmc/articles/PMC5448352/*
+ ++ **Copernicus Global Land Service LAI Collection** Version 2
+The [Copernicus Global Land Service (CGLS) LAI Collection](https://land.copernicus.vgt.vito.be/PDF/portal/Application.html#Browse;Root=512260;Collection=1000083;Time=NORMAL,NORMAL,-1,,,-1,,) 1km Version 2 product is derived from SPOT/VEGETATION and PROBA-V data. The product is provided every 10 days, with a temporal basis for compositing between ±15 and ±60 days depending on the number of available valid observations. The version 2 product is derived from top of canopy daily (S1-TOC) reflectance. The compositing step is performed at the biophysical variable level. This allows reducing sensitivity to missing observations and avoiding the use of a BRDF model. Smoothing and gap filling is achieved over a compositing temporal window that may be dissymmetric depending on the number of valid daily estimates. This version 2 product provides an improved continuity (no missing data in Version 2 due to climatological gap filling) and smoothness and include a Near Real Time computation. Version 2 product is delivered with global coverage in netCDF4 CF-1.6 format.
+Source: https://land.copernicus.eu/global/sites/cgls.vito.be/files/products/CGLOPS1_PUM_LAI1km-V2_I1.33.pdf
+ ++ **SoilGrids250m 2017**
+[SoilGrids](https://data.isric.org/geonetwork/srv/api/records/f36117ea-9be5-4afd-bb7d-7a3e77bf392a) +is a system for automated soil mapping based on global soil profile and covariate data ([Hengl et al. 2017](https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0169748). SoilGrids250m is a collection of soil property and class maps of the world (ca. 300 GeoTiffs) produced using machine learning and statistics. SoilGrids predictions are a global soil data product generated at ISRIC.
+Source: https://www.isric.org/explore/soilgrids/faq-soilgrids-2017
+ ++ **FAO Irrigation and Drainage Paper No. 56**: Crop Evapotranspiration (guidelines for computing crop water requirements) by Richard G. ALLEN, Luis S. PEREIRA, Dirk RAES, Martin SMITH
+FAO Irrigation and Drainage Paper No. 56: Crop Evapotranspiration ([guidelines for computing crop water requirements](http://www.fao.org/3/x0490e/x0490e00.htm)) presents an updated procedure for calculating reference and crop evapotranspiration from meteorological data and crop coefficients. Publication contains several pieces of information that were used in this research: i) Lengths of crop development stages for various planting periods and climatic regions (days) (Table 11); ii) Single (time-averaged) crop coefficients (Kc), and mean maximum plant heights for non stressed, well-managed crops in subhumid climates (RHmin ≈ 45%, u2 ≈ 2 m/s) (Table 12); iii) Ranges of maximum effective rooting depth (Zr), and soil water depletion fraction for no stress (p), for common crops (Table 22).
+*Source: https://www.researchgate.net/publication/284300773_FAO_Irrigation_and_drainage_paper_No_56*
+ ++ System description of the **Wofost 6.0 crop simulation model** implemented in CGMS. *Volume 1: Theory and Algorithms by I. Supit, A.A. Hoojer and C.A. Van Diepen*
+System description of the [Wofost 6.0 crop simulation model implemented in CGMS](https://op.europa.eu/en/publication-detail/-/publication/a99325a7-c776-11e6-a6db-01aa75ed71a1). Volume 1: Theory and Algorithms present results from the "Development, validation of crop specific agrometeorological simulation models" project. Projects objectives were "to develop, validate and test new or already existing agrometeorological simulation models for 10-day routine quantitative forecasting of national and NUTS-1 yields and for 10-day wise (regional), but qualitative monitoring of agricultural season conditions over the whole of the EC and for each of the following crops: wheat (spring and winter; hard and soft), barley (spring and winter), oats, maize (grain), rice, potato, sugar beet, pulses (human consumption), soybean, oilseed rape, sunflower, tobacco and cotton." Project has adapted the already existing WOrld FOod STudies (WOFOST) crop growth model to achieve its objectives. From this publication we used following information: i) Soil water depletion fraction (p) as a function of potential evapotranspiration of a closed crop canopy for different crop groups (Table 6.1, p. 87); ii) Example of crops in the different crop groups (Table 6.2, p. 87).
+*Source: System description of the Wofost 6.0 crop simulation model implemented in CGMS. Volume 1: Theory and Algorithms by I. Supit, A.A. Hoojer and C.A. Van Diepen*
+ ++ **OPEN-CHANNEL HYDRAULICS** by Ven Te Chow
+[OPEN-CHANNEL HYDRAULICS](http://web.ipb.ac.id/~erizal/hidrolika/Chow%20-%20OPEN%20CHANNEL%20HYDRAULICS.pdf) presents the knowledge of open-channel hydraulics, which is essential to the design of many hydraulic structures: Part I - basic principles, the type of flow in open channels is classified according to the variation in the parameters of flow with respect to space and time; Part II - on uniform flow; Part III - on gradually varied flow; Part IV - on rapidly varied flow; Part V - on unsteady flow. From this publication we used following information: Values of the roughness coefficient n (Table 5-6, p. 110).
+*Source: http://web.ipb.ac.id/~erizal/hidrolika/Chow%20-%20OPEN%20CHANNEL%20HYDRAULICS.pdf*
diff --git a/docs/4_Static-Maps_channel-geometry/index.md b/docs/4_Static-Maps_channel-geometry/index.md new file mode 100644 index 00000000..638e5b0a --- /dev/null +++ b/docs/4_Static-Maps_channel-geometry/index.md @@ -0,0 +1,170 @@ +# Channel geometry + +In the LISFLOOD model flow through the channel is simulated using the kinematic wave equations. Channel maps describe the sub grid information of the channel geometry, i.e. the length, slope, width and depth of the main channel inside a grid-cell.
++ The **channel mask** map is the Boolean field with '1' for all grid-cells with channels and NoData for all grid-cells with no channels.
++ The **channel side slope** map (referred as 's' in Figure 41) defines the slope of the channel banks.
++ The **channel length** map is the length of the river in each grid-cell, and the value can exceed grid-size to account for meandering rivers.
++ The **channel gradient** (or channel slope) map is the average gradient of the main river inside a cell.
++ The **Manning's roughness coefficient** map can be derived by an empirical relationship of the DEM and the upstream area according to [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf). The kinematic wave approach uses the Manning’s formula, an empirical formula for open channel flow or free-surface flow driven by gravity. The Manning’s roughness coefficient is reciprocal proportional to the cross-sectional average velocity (in m/s). A lower Manning’s coefficient results in a faster responding time at the outlet.
++ The **bottom width map** (referred as Wb in Figure 41) is the width of the bottom of the channel.
++ The **floodplain map** (referred as Wfp in Figure 41) is used to calculate water levels in the LISFLOOD model.
++ The **bankfull channel depth** map (referred as Dbf in Figure 41) is the difference between floodplain bottom level (referred as zfp in Figure 41) and the channel bottom level (referred as zbot in Figure 41.
+Channel characteristics, explained above, are shown in the Figure 41 below.
+ +
+ 
+ 
+
Type: Boolean | Units: -;
Range: NoData or 1 |Boolean map that identifies the channel grid-cells | +|Side slope |chans.nc;
Type: Float32 | Units: m;
Range>0 |Channel side slope| +|Channel length |chanlength.nc;
Type: Float32 | Units: m;
Range>0 |Channel length (value can exceed grid size, to account for meandering rivers)| +|Channel gradient |changrad.nc;
Type: Float32 |Units: m/m;
Range: [0-1] |Channel longitudinal gradient| +|Manning's roughness coefficient |chanman.nc;
Type: Float32 |Units: m1/3 s-1 |channels Manning's roughness coefficient | +|Bottom width |chanbw.nc;
Type: Float32 |Units: m;
Range>0 |Channel bottom width| +|Floodplain |chanflpn.nc;
Type: Float32 |Units: m;
Range>0 |Width of the area where the surplus of water is distributed when the water level in the channel exceeds the bankfull channel depth +|Bankfull channel depth |chanbnkf.nc;
Type: Float32 |Units: m;
Range>0 |Bankfull channel depth + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Channel width |[cama-flood](http://hydro.iis.u-tokyo.ac.jp/~yamadai/cama-flood/index.html) |2018 |Global, 1' and 3'| +|River lenght | [cama-flood](http://hydro.iis.u-tokyo.ac.jp/~yamadai/cama-flood/index.html) |2018 |Global, 1' and 3'| +|MERIT DEM: Multi-Error-Removed Improved-Terrain DEM|[MERIT-DEM](http://hydro.iis.u-tokyo.ac.jp/~yamadai/MERIT_DEM/index.html) |2018 |Global, 3" (at about 90 m)| +|Mask map |Can be prepared following [these instructions](../4_Static-Maps_general-maps#area-mask-and-land-use-mask-maps)|NA |Global, 1' and 3'| +|Local drain direction (ldd) |Can be prepared following [these instructions](../4_Static-Maps_topography#local-drain-direction-map)|NA |Global, 1' and 3'| +|Upstream area map |Can be prepared following [these instructions](../4_Static-Maps_topography#upstream-area)|NA |Global, 1' and 3'| + +## Methodology + +### Channel mask (chan) +The channel mask map is used to identify the cells that have channels. The grid-cells that have a channel length (see chanlength map creation below) above zero are assigned to the Boolean field '1', the grid-cells that have a channel length below or equal to zero are assigned with NoData. + +### Side slope (chans) +The channel side slope map is calculated by dividing the horizontal distance (referred as 'dx' in Figure 42) by vertical distance (referred as 'dy' in Figure 42); here ‘1’ was assigned to all the grid cells, which correspond to a 45° angle of the side slope. + +
+ 
+
+ +$ \small elevationDifference = elevationUpstreamCell-elevationDownstreamCell $ + +Then, the channel gradient is computed and assigned to the upstream grid-cell: + +$ changrad=\frac{elevationDifference}{chanlength} $ + +$changrad$ is set equal 0 where $ldd$ is 5. + +### Manning's roughness coefficient (chanman) +The Manning's roughness coefficient for channels can be derived by an empirical relationship between the elevation (in $m$) of the grid-cell and its upstream area (in $km^2$) following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf): + +$ chanman =$
+$ 0.025 + 0.015 \cdot \min(\frac{50}{upstreamArea} , 1) + 0.30 \cdot \min(\frac{elevation}{2000} , 1) $ + +### Bottom width (chanbw) +The channel bottom width map can be computed using empirical relationship that relate channel width of the grid-cell with its upstream area (in $km^2$); for example, following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf):
+ +$ chanbw = 0.0032 \cdot upstreamArea $ + +### Floodplain width (Wfp) +The floodplain width (in $m$) can be computed using the following equation from [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf):
+ +$ floodplainWidth = 3 \cdot chanbw $ + +### Bankfull channel depth (chanbnkf) +The channel bankfull depth can be computed in two steps. The first step uses the empirical relationship relating the channel bankfull depth of the grid-cell with its upstream area (in $km^2$) following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf):
+ +$ chanbnkf_{step1} = 0.27 \cdot upstreamArea^{0.33} $ + +The second step uses the Manning's equation following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf). The LISFLOOD model first needs to be run for the calibration period length with the initial channel bottom width and bankfull depth parameters to get a long-term average discharge ($avgdis$) which is then used in the Manning's equation:
+ +$ chanbnkf_{step2} =$
+$ 1.004 \cdot chanman^{0.6} \cdot (2 \cdot avgdis)^{0.6} \cdot chanbw^{-0.6} \cdot changrad^{-0.3} $ + + + +## Results (examples) + + +
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+The mask maps in the hydrological model are used to detect where model should perform computations and where it shouldn't (skip the grid-cell). Area and land use masks are both Boolean maps which define model boundaries and land use calculation domain respectively.
+ ++ **Grid-cell length & grid-cell area maps.**
+The grid-cell length and grid-cell area maps are used in LISFLOOD model to accurately compute the areal sums over grid-cells (e.g. the upstream area of the river when areas of all connected grid-cells are summed together or the rainfall amount over a certain grid-cell). If projection properties are in meters these maps become optional.
+ + +## Area mask and land use mask maps + +### General map information and possible source data + +| Map name | File name;type | Units; range | Description | +| :---| :--- | :--- | :--- | +| Mask map| area.nc;
Type: Float32 | Units: -;
Range: NoData or 1 | Boolean map that defines model boundaries| +| Land use mask| landuse.nc;
Type: Float32 | Units: -;
Range: NoData or 1 | Boolean map for land use calculations | + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Any available map of the region of interest
(e.g. digital elevation map, flow direction map)|NA|NA|Global, 1' and 3'| + +### Methodology + +To create a mask field (mask map or land use mask), source data (e.g. elevation or flow direction) values are changed to ‘1’ and the variable type is forced to be Byte for the mask map (area.nc), and Float32 for the land use mask (lusemask.nc).
+If the source data is at a higher resolution and/or is larger than the required model domain, it needs to be re-scaled to the required grid-cell resolution and/or clipped to the required model domain.
+ + +### Results (examples) + + +
+ 
+ 
+
+ 
+ 
+
Type: Float32|Units: -;
Range: >0 |Map with grid-cell (pixel) length along the latitude,
the only pixel size to change (along the longitude the length is constant)| +|Pixel area|pixarea.nc;
Type: Float32|Units: m2;
Range: >0 |Map with grid-cell (pixel) area| + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Mask map|Can be prepared following the instructions provided [here](../4_Static-Maps_general-maps#area-mask-and-land-use-mask-maps)|NA|Global, 1' and 3'| + +### Methodology + +To create the grid-cell area, the ee.Image.pixelArea() function in Google Earth Engine can be used, that computes the value of each grid-cell in square meters considering all curves of the Globe, and specify the needed grids resolution (e.g. 1 and 3 arc min) along the longitude in meters.
+Grid-cell length is computed dividing grid-cell area by its resolution along the longitude in meters.
+*Note: The pixel area and pixel length maps are given to the whole domain (i.e. not applying the ocean mask map).*
+ + +### Results (examples) + +
+ 
+ 
+
+ 
+ 
+
+The LISFLOOD hydrological model can distinguish dependencies for the forested (and also non-forested), irrigated crops (excluding rice), and other land cover type areas. Forest includes evergreen and deciduous needle leaf and broad leaf trees, irrigated crops - all possible crops excluding rice (is modelled separately), and other land cover type - agricultural areas, non-forested natural area, pervious surface of urban areas. Non-forest (also referred to as ’others‘) refers to any other land cover types apart from forest.
++ **Crop coefficient** for forest, irrigated crops and other land use type maps +Crop coefficient is a simple ratio between the potential (reference) evapotranspiration rate, in mm/day, and the potential evaporation rate of a specific crop. In the LISFLOOD model the crop coefficient for forest, irrigated crops and other land cover type maps are used in the computation of the transpiration rate for the forest, irrigated agriculture and other land cover type fractions respectively, e.g. in the computation of the [roots water uptake](https://ec-jrc.github.io/lisflood-model/2_07_stdLISFLOOD_plant-water-uptake/) to support plant transpiration.) ++ **Crop group number** for forest, irrigated crops and other land use type maps +The crop group number represents a vegetation type and is an indicator of its adaptation to dry climate. In the LISFLOOD model the crop group number for forest, irrigated crops and other land cover type maps are used in the computation of the critical amount of soil moisture [$wcrit$](https://ec-jrc.github.io/lisflood-model/2_07_stdLISFLOOD_plant-water-uptake/) below which water uptake from plants is reduced as they start closing their stomata. The crop group number for forest, irrigated crops and other land cover type are applied to the forest, irrigated agriculture and other land cover type fractions respectively. ++ **Manning’s surface roughness coefficient** for forest, irrigated crops and other land cover type maps +Manning's surface roughness coefficient represents the roughness or friction applied to the flow by the surface on which water is flowing. In the LISFLOOD model the Manning's surface roughness coefficients for forest, irrigated crops and other land cover type maps are used to compute surface runoff routing for the forest, irrigated agriculture and other [land cover type fractions](../4_Static-Maps_land-use/) respectively. ++ **Soil depth layers 1, 2 and 3** for forested and non-forested areas maps +Soil depth is used to compute the available water storage volume in the soil. In the LISFLOOD model, three soil layers are used to model the hydrological processes in the soil. The layers take into account forest and non-forest root depths to divide the total soil depth between topsoil (surface layer or layer 1, and middle layer or layer 2) and subsoil (bottom layer or layer 3) hydrological processes. + +## Crop coefficient, crop group number, Manning’s surface roughness coefficient for forest, irrigated crops and other land use type maps + +### General map information and possible source data + + +| Map name | File name;type | Units; range | Description | +| :---| :--- | :--- | :--- | +|Crop coefficient|cropcoef_**T**.nc; Type: Float32|Units: -;
Range: 0.20 .. 1.08| Averaged (by time and ecosystem type) crop coefficient for forest/ irrigated crops/ other land cover type| +|Crop group number|cropgrpn_**T**.nc; Type: Float32|Units: -;
Range: 1 .. 5| Averaged (by time and ecosystem type) crop group number for forest/ irrigated crops/ other land cover type| +|Manning's coefficient|mannings_**T**.nc; Type: Float32|Units: m1/3 s-1;
Range: 0.015 .. 0.200|Averaged (by ecosystem type) Manning’s roughness coefficient for forest/ irrigated crops/ other land cover type| + +*where **T** is the landcover type (**T** = ’f’ for forest, **T** = ’i’ for irrigated crops, **T** = ’o’ for other land cover type). + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Copernicus Global Land Cover Layers: CGLS-LC100 collection 2|[CGLS-LC100](https://developers.google.com/earth-engine/datasets/catalog/COPERNICUS_Landcover_100m_Proba-V-C3_Global#description)|2015|Global, 100m| +|Spatial Production Allocation Model (SPAM) - Global Spatially-Disaggregated Crop Production Statistics Data for 2010 (V 1.0)|[Spatial Production Allocation Model](https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/PRFF8V)|2010|Global, 5min (~10 km)| +|FAO Irrigation and Drainage Paper No. 56: Crop Evapotranspiration (guidelines for computing crop water requirements) by Richard G. ALLEN, Luis S. PEREIRA, Dirk RAES, Martin SMITH|[FAO Paper No.56](https://www.researchgate.net/publication/284300773_FAO_Irrigation_and_drainage_paper_No_56)|1998|Global, per crop type| +|System description of the Wofost 6.0 crop simulation model implemented in CGMS. Volume 1: Theory and Algorithms by I. Supit, A.A. Hoojer and C.A. Van Diepen|[Wofost 6.0 crop simulation model](https://op.europa.eu/en/publication-detail/-/publication/a99325a7-c776-11e6-a6db-01aa75ed71a1)|1994|Global, per crop type| +|OPEN-CHANNEL HYDRAULICS by Ven Te Chow|[OPEN-CHANNEL HYDRAULICS](http://web.ipb.ac.id/~erizal/hidrolika/Chow%20-%20OPEN%20CHANNEL%20HYDRAULICS.pdf)|1959|Global| + + +### Methodology + +First, different ecosystem type fraction maps are prepared:
+ ++ for **forest**
+The 'discrete_classification' dataset from Copernicus Global Land cover Layers, which provides values representing a dominant cover type per grid-cell (discrete information) can be used. Only tree cover types are selected (i.e. '111' - evergreen needleleaf closed forest, '112' - evergreen broadleaf closed forest, '113' - deciduous needleleaf closed forest, '114' - deciduous broadleaf closed forest, '115' - mixed closed forest, '116' - unknown closed forest, '121' - evergreen needleleaf open forest, '122' - evergreen broadleaf open forest, '123' - deciduous needleleaf open forest, '124' - deciduous broadleaf open forest, '125' - mixed open forest, '126' - unknown open forest). For each of these 12 tree cover types selected a map containing information about forest type was created, assigning '0' to the grid-cells with no forest and '1' to the grid-cells covered with forest type in question. Then, the resolution of these maps is reduced from native 100 m to the needed resolution, e.g. 1 arc min, with mean() reducer.
+ ++ for **irrigated crops**
+The 'spam2010v1r0_global_physical-area_CROP_i' dataset from SPAM dataset can be used. The files represent the actual area in hectares where each crop is grown, not considering how often its production is harvested, 'i' - denotes an irrigated portion of a crop. All 42 crop types are selected and single crop fraction maps are created, assigning '0' to the grid-cells with no crop and '1' to the grid-cells covered with crop type in question. Then, the resolution of these maps is changed from native to the needed resolution, e.g. 1 arc min.
+ ++ for **other** land cover type
+i) The 'discrete_classification' dataset from Copernicus Global Land cover Layers, providing values representing a dominant cover type per grid-cell (discrete information) can be used. Here, only the other land cover types are selected (i.e. '20' - shrubland, '30' - herbaceous vegetation, '40' - cropland, '60' - bare/sparse vegetation, '70' - snow & ice, '90' - herbaceous wetland, '100' - moss & lichen). For other land cover types, 7 fraction maps where created – each map contains information only about one other land cover type ('0' - grid-cell has no other land cover type in question, '1' - grid-cell is covered with other land cover type in question). Then, the resolution of these maps is reduced from native 100 m to the needed resolution, e.g. 1 arc min, with mean() reducer.
+ii) The 'spam2010v1r0_global_physical-area_CROP_r' dataset from the SPAM dataset can be used. The files represent the actual area in hectares where each crop is grown, not considering how often its production is harvested, 'r' - denotes a rainfed portion of a crop. All 42 crop types are selected and 42 fraction maps containing information only about one crop type ('0' - grid-cell has no crop type in question, '1' - grid-cell is covered with crop type in question) are created. Then, the resolution of these maps is changed from native to the needed resolution, e.g. 1 arc min.
+Next, land cover depending parameters are computed according to the formulas in the table below.
+ + +| Parameter| Equation* | Notes | +| :---| :--- | :--- | +|Crop coefficient| $$Kc=\frac{fraction1 \cdot height1 \cdot Kc1 + fraction2 \cdot height2 \cdot Kc2 + .. + fractionN \cdot heightN \cdot KcN}{fraction1 \cdot height1 + fraction2 \cdot height2 + .. + fractionN \cdot heightN}$$|Considers different cover type fractions, default crop coefficient values and default crop height values from [FAO56](https://www.researchgate.net/publication/284300773_FAO_Irrigation_and_drainage_paper_No_56)| +|Crop height|$$H=\frac{fraction1 \cdot height1 + fraction2 \cdot height2 + .. + fractionN \cdot heightN}{fraction1 + fraction2 + .. + fractionN }$$|Considers different cover type fractions, default crop coefficient values and default crop height values from [FAO56](https://www.researchgate.net/publication/284300773_FAO_Irrigation_and_drainage_paper_No_56)| +|Crop root depth|$$R=\frac{fraction1 \cdot root1 + fraction2 \cdot root2 + .. + fractionN \cdot rootN}{fraction1 + fraction2 + .. + fractionN}$$|Considers different cover type fractions and default crop root depth values from [FAO56](https://www.researchgate.net/publication/284300773_FAO_Irrigation_and_drainage_paper_No_56)| +|Crop group number|$$Kg=\frac{fraction1 \cdot Kg1 + fraction2 \cdot Kg2 + .. + fractionN \cdot KgN}{fraction1 + fraction2 + .. + fractionN}$$|Considers different cover type fractions and default
crop group number values from the [Supit et al., 1994](https://op.europa.eu/en/publication-detail/-/publication/a99325a7-c776-11e6-a6db-01aa75ed71a1)| +|Manning's coefficient|$$Km=\frac{fraction1 \cdot Km1 + fraction2 \cdot Km2 + .. + fractionN \cdot KmN}{fraction1 + fraction2 + .. + fractionN}$$|Considers different cover type fractions and default Manning's surface roughness coefficient values from the [OPEN-CHANNEL HYDRAULICS](http://web.ipb.ac.id/~erizal/hidrolika/Chow%20-%20OPEN%20CHANNEL%20HYDRAULICS.pdf)| + +*where for forest **N**=12; for irrigated crops **N**=42; for other land cover type **N**=7 and for ‘40’ ‘cropland’ height, Kc, Kg and Km are for rainfed crops. + + +The LISFLOOD model does not accept missing values for Kc, Kg and Km thus all zero values are filled with field’s global mean values (computed by excluding all nil Kc, Kg and Km values, respectively).
+ +
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
Type: Float32| Units: mm;
Range: ≥ 50**|Forested/ other (non-forested) area soil depth
for soil layer 1 (surface layer)/ 2 (middle layer)/ 3 (bottom layer)| + +*where **N** is the number of soil depth layer (**N**= ’1’ for surface layer, **N** = ’2’ for middle layer, **N** = ’3’ for bottom layer), and **T** is the landcover type (**T** = ’f’ for forested areas, **T** = ’o’ for non-forested areas or others). +**where range for soil layer 1 (surface layer) equals 50 mm, and for soil layer 2 (middle layer) and 3 (bottom layer) equals ≥ 50 mm. + +| Source data| Access |Temporal coverage|Spatial information| +| :---| :--- | :--- | :---| +|SoilGrids250m 2017 |[SoilGrids](https://data.isric.org/geonetwork/srv/api/records/f36117ea-9be5-4afd-bb7d-7a3e77bf392a)|2017|Global, 250m| +|Copernicus Global Land Cover Layers: collection 2|[CGLS-LC100](https://developers.google.com/earth-engine/datasets/catalog/COPERNICUS_Landcover_100m_Proba-V-C3_Global#description)|2015|Global, 100m| +|Spatial Production Allocation Model (SPAM)
Global Spatially-Disaggregated Crop Production Statistics Data
for 2010 (V 1.0)|[SPAM](https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/PRFF8V)|2010|Global, 5' (~10 km)| +|FAO Irrigation and Drainage Paper No. 56:
Crop Evapotranspiration (guidelines for computing crop water requirements)
by Richard G. ALLEN, Luis S. PEREIRA, Dirk RAES, Martin SMITH |[FAO Paper No.56](https://www.researchgate.net/publication/284300773_FAO_Irrigation_and_drainage_paper_No_56)|1998|Global, per crop type| + +### Methodology + +The methodology for the computation of the depth of the three soil layers has been adapted from [Burek et al., 2014](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf). Here, total soil depth is taken as the 'absolute depth to bedrock' from [SoilGrids250m (2017)](https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0169748) and 'root depth' for the fractions forest and non-forest is computed following methodology explained [above](../4_Static-Maps_land-use-depending#crop-coefficient,-crop-group-number,-manning’s-surface-roughness-coefficient-for-forest,-irrigated-crops-and-other-land-use-type-maps). Soil depth is expressed in mm.
+Soil depth layer 1 (surface) for forest/non-forest ($SD_1$) is assumed constant, equal to 50 mm all over the world: + +$$ +SD_1 = 50 mm +$$ + +Soil depth layers 2 (middle, $SD_2$) and 3 (bottom, $SD_3$) for forest/non-forest are computed in several steps – first at native resolution of the input dataset, then at required resolution. First step is following: + ++ for soil depth layer 2 (middle, $SD_2$) + +| Absolute depth to bedrock | Equation | +| :---| :--- | +| ≤300 mm | $SD_2 = \frac{absolutedepth-SD_1}{2}$ | +| >300 mm | $SD_2 = \min(rootdepth,(absolutedepth - 300mm - SD_1))$ | + +If the computed value of $SD_2$ is lower than 50mm, then it is used $SD_2$ = $50 mm$ (in order to account for data uncertainty). + ++ for soil depth layer 3 (bottom layer, $SD_3$) + +$$ +SD_3 = absolutedepth - (SD_1 +SD_2) +$$ + +Second step is to reduce the resolution of the resulting field from native to the required one (e.g. from 250 m to 1 arc min) as follows. Firstly, resolution is reduced to 1, 3, 15 arc min and 1, 3, 15, 60 degrees with mean.unweighted() reducer, and then all different resolutions are assembled to create a field with no missing values. For each resolution (going from the highest to the coarsest), grid-cells with missing values are identified and filled with the value of the corresponding grid-cell with non-missing value from the next resolution down map (e.g. using 3 arc min to fill in 1 arc min missing values). If the corresponding grid-cell is masked (has a missing value), then the value of the corresponding non-masked grid-cell from the next resolution down map is used, until all resolution maps are explored. If the corresponding grid-cell value of the coarsest resolution (here 60 degree) is still missing, a zero value is used.
+ + +### Results (examples) + +
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ ++ **Fraction of inland water map**
+Inland water map includes information on rivers, freshwater and saline lakes, ponds and other permanent water bodies over the continents. In the LISFLOOD model the inland water fraction map is used to identify the fraction of the pixel covered by open water bodies where the most prominent hydrological process is evaporation. +Considering that LISFLOOD does not distinguish oceans from inland water it is recommended to verify consistency between water fractions and computational area mask, especially in the coastal areas. Pixels included in the computational area mask cannot be fully covered with ocean. If this happens in coastal areas, then the fraction of inland water must be set to 1 and the [lake mask](../4_Static-Maps_reservoirs-lakes#lake-mask-map) should be changed accordingly.
+ ++ **Fraction of sealed surface map**
+Here, the sealed surface map describes urban areas, characterizing the human impact on the environment. In the LISFLOOD model the sealed surface fraction map is used to identify impervious areas where there is no water infiltration into the soil, meaning water is accumulated in the surface depression, yet evaporates, but once depression is full - water is transported by a surface runoff.
+ ++ **Fraction of forest map**
+Forest map describes land use composed of evergreen and deciduous needle leaf and broad leaf trees. In the LISFLOOD model the forest fraction is used to identify forested areas where main hydrological processes are canopy interception, evapotranspiration from canopies, canopies drainage and evapotranspiration.
+ ++ **Fraction of irrigated crops map**
+Irrigated crops map includes all possible crops excluding rice (is modelled separately). In the LISFLOOD model the irrigated crops fraction map is used to identify part of the pixel which is used by agriculture - water is abstracted from ground water and surface water bodies to irrigate the fields; main hydrological process connected with the irrigated crops are canopy interception, evapotranspiration from canopies, canopies drainage and evapotranspiration.
+ ++ **Fraction of other land cover type map**
+Other land cover type map includes agricultural areas, non-forested natural area, pervious surface of urban areas. In the LISFLOOD model the other land cover type fraction map is used in the following hydrological processes: canopy interception, evaporation from the canopies, canopy drainage, plant evapotranspiration, evaporation from the soil. The relative importance of these processes depends on the Leaf Area Index.
+ + +## Fraction of inland water +### General map information and possible source data + +| Map name | File name;type | Units; range | Description | +| :---| :--- | :--- | :--- | +|Fraction of inland water | fracwater.nc;
Type: Float32 | Units: -;
Range: [0-1] |Inland water fraction for each grid-cell;
values range from 0 (grid-cell has no inland water) to 1 (grid-cell is fully covered with inland water) | + + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Copernicus Global Land Cover Layers: CGLS-LC100 collection 2 |[CGLS-LC100](https://developers.google.com/earth-engine/datasets/catalog/COPERNICUS_Landcover_100m_Proba-V-C3_Global#description) |2015 |Global, 100 m| + +### Methodology + +To create the fraction of inland water, the 'water-permanent-coverfraction' layer can be used. It gives the percentage values of permanent inland water covering each grid-cell, ranging from 0 - grid-cell has no inland water - to 100% - grid-cell is fully covered with inland water. Values are translated into fractions per grid-cell, and then high initial resolution reduced to the needed resolution, e.g. 1 arc min, with mean() reducer. +Note: Inland water fraction field should be checked for consistency with all other fractions. + +### Results (example) + +
+ 
+ 
+
Type: Float32 | Units: -;
Range: [0-1] |Urban surface fraction for each grid-cell;
values range from 0 (grid-cell has no urban surface) to 1 (grid-cell is fully covered with urban surface) | + + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Copernicus Global Land Cover Layers: CGLS-LC100 collection 2 |[CGLS-LC100](https://developers.google.com/earth-engine/datasets/catalog/COPERNICUS_Landcover_100m_Proba-V-C3_Global#description) |2015 |Global, 100 m| + +### Methodology + +To create the fraction of sealed surface map, the 'urban-coverfraction' layer can be used. It gives the percentage values of urban surface covering each grid-cell, ranging from 0 % - grid-cell has no urban surface to 100 % - grid-cell is fully covered with urban surface. Values are translated into fractions per grid-cell and multiplied by 0.75 to account for urban permeable part (it is assumed that in general all urban areas have part which allows water to infiltrate, e.g. trees along the road, bushes along the fence, grass or moss between concrete tiles or cobble stones, and on average it covers 25 % of the area at a kilometre scale), and then high native resolution is reduced to the needed resolution, e.g. 1 arc min, with mean() reducer.
+Note: Sealed surface fraction field should be checked for consistency with all other fractions. + +### Results (example) + +
+ 
+ 
+
Type: Float32 | Units: -;
Range: [0-1] |Forest fraction for each grid-cell;
values range from 0 (grid-cell has no forest) to 1 (grid-cell is fully covered with forest) | + + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Copernicus Global Land Cover Layers: CGLS-LC100 collection 2 |[CGLS-LC100](https://developers.google.com/earth-engine/datasets/catalog/COPERNICUS_Landcover_100m_Proba-V-C3_Global#description) |2015 |Global, 100 m| + +### Methodology + +To create the fraction of forest map, the 'tree-coverfraction' layer can be used. It gives the percentage values of forest covering each grid-cell, ranging from 0 % - grid-cell has no forest to 100 % - grid-cell is fully covered with forest. Values are translated into fractions per grid-cell, and then high native resolution is reduced to the needed resolution, e.g. 1 arc min, with mean() reducer.
+Note: Forest fraction field should be checked for consistency with all other fractions. + +### Results (example) + +
+ 
+ 
+
Type: Float32 | Units: -;
Range: [0-1] |Irrigated crop (except rice) fraction for each grid-cell;
values range from 0 (grid-cell has no irrigated crops) to 1 (grid-cell is fully covered with irrigated crops)| + + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Spatial Production Allocation Model (SPAM) - Global Spatially-Disaggregated Crop Production Statistics Data for 2010 (V 1.0) |[Spatial Production Allocation Model](https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/PRFF8V) |2018 |Global, 5 arcmin (approx 10 km)| +|CORINE Land Cover 2018 CLC2018 |[CLC2018 ](https://land.copernicus.eu/pan-european/corine-land-cover) |2018 |European, 100 m| + +### Methodology + +To create the fraction of irrigated crops map, multiple data sources can be used, for example when more accurate information could be found regionally compared with a global dataset. We describe here the process when using two datasets.
+For a global coverage, the 'spam2010v1r0_global_physical-area_CROP_i' files from the SPAM dataset are used. They describe the area (in hectares) where each crop is grown (one file per crop), not considering how often its production is harvested, with 'i' denoting a portion of the crop is irrigated. The area of all irrigated crops globally (except rice – modelled separately) is summed and resulting values translated from hectares to fractions per grid-cell, and the native resolution is changed to the highest resolution of all datasets used, here CORINE dataset 100 m resolution.
+For a regional coverage (here Europe), the '212' - ‘Permanently irrigated land, excluding rice’ value from the CORINE dataset is used (discrete classification where each grid-cell is fully covered with a certain land cover), assigning grid-cells covered with irrigated crops fraction 1.
+Finally, the generated fields are merged, with priority given to the high quality dataset (here from CORINE) over its geographical domain (here over the European domain), and the merged field resolution is reduced to the needed resolution, e.g. 1 arc min, with mean() reducer.
+Note: Irrigated crops fraction field should be checked for consistency with all other fractions. + +### Results (example) + +
+ 
+ 
+
Type: Float32 | Units: -;
Range: [0-1] |Irrigated rice fraction for each grid-cell;
values range from 0 (grid-cell has no irrigated rice) to 1 (grid-cell is fully covered with irrigated rice)| + + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Spatial Production Allocation Model (SPAM) - Global Spatially-Disaggregated Crop Production Statistics Data for 2010 (V 1.0) |[Spatial Production Allocation Model](https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/PRFF8V) |2018 |Global, 5 arcmin (approx 10 km)| +|CORINE Land Cover 2018 CLC2018 |[CLC2018](https://land.copernicus.eu/pan-european/corine-land-cover) |2018 |European, 100 m| + +### Methodology + +To create the fraction of irrigated rice map, multiple data sources can be used, for example when more accurate information could be found regionally compared with a global dataset. We describe here the process when using two datasets.
+For a global coverage, the 'spam2010v1r0_global_physical-area_rice_i' file from the SPAM dataset is used. It describes the area (in hectares) where crop is grown, not considering how often its production is harvested, with 'i' denoting a portion of the crop is irrigated. The area of irrigated rice values translated from hectares to fractions per grid-cell, and the native resolution is changed to the highest resolution of all datasets used, here CORINE dataset 100 m resolution.
+For a regional coverage (here Europe), the '213' - ‘Rice field’ value from the CORINE dataset is used (discrete classification where each grid-cell is fully covered with a certain land cover), assigning grid-cells covered with irrigated rice fraction 1.
+Finally, the generated fields are merged, with priority given to the high quality dataset (here from CORINE) over its geographical domain (here over the European domain), and the merged field resolution is reduced to the needed resolution, e.g. 1 arc min, with mean() reducer.
+Note: Irrigated rice fraction field should be checked for consistency with all other fractions.
+ +### Results (example) + +
+ 
+ 
+
Type: Float32 | Units: -;
Range: [0-1] |Other (e.g. agricultural areas, non-forested natural areas, pervious surface of urban areas)
land cover type (not mentioned above) fraction for each grid-cell;
values range from 0 (grid-cell has no other land cover type) to 1 (grid-cell is fully covered with other land cover type);
computed in a following way: fraction_other = 1 - (fraction_inlandWater + fraction_urban + fraction_forest + fraction_irrigatedCrop + fraction_irrigatedRice + fraction_oceanWater)| + + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Fraction of inland water|It can be prepared by implementing [this methodology](../4_Static-Maps_land-use#fraction-of-inland-water)|NA|Global| +|Fraction of sealed surfaces|It can be prepared by implementing [this methodology](../4_Static-Maps_land-use#fraction-of-sealed-surfaces)|NA|Global| +|Fraction of forest|It can be prepared by implementing [this methodology](../4_Static-Maps_land-use#fraction-of-forest)|NA|Glonbal| +|Fraction of irrigated crops|It can be prepared by implementing [this methodology](../4_Static-Maps_land-use#fraction-of-irrigated-crops)|NA|Global| +|Fraction of rice|It can be prepared by implementing [this methodology](../4_Static-Maps_land-use#fraction-of-rice-crops)|NA|Global| + +### Methodology + +Here the other land cover type map is created based on all other fraction maps required by LISFLOOD model. It should be noted that: i) all fraction maps together (including fraction of other land cover type) should sum up to 1 in each grid-cell, and ii) consistency check for all fractions must be done because data come from different sources and it can happen that fractions summed can result to more than 1.
+The following procedures are recommended to check consistency between fraction maps. All fractions are summed up to compute the other land cover type fraction map. If the fraction sum is less than 1, then the other land cover type fraction is calculated as 1 minus all fraction sum, else other land cover type fraction is 0. For cases when the sum is greater than 1, a correction for forest, irrigated crops, rice, and sealed surface fractions is computed:
+ +$ \small fractionCorrectionFactor=\frac{fractionAllSum-1}{fractionForest+fractionIrrigated+fractionRice+fractionSealed}$ + +Finally, if data sources for forest, irrigated crops, rice, and sealed surfaces fractions have the same level of uncertainty, each of these fractions are corrected in the same way at the needed resolution (e.g. 1 and 3 arc min):
+ +$ \small fractionCorrectedX = fractionX - (fractionX \cdot fractionCorrectionFactor) $
+where X is Forest, Irrigated, Rice, Sealed. + +### Results (example) + +
+ 
+ 
+
+The LAI quantifies the thickness of the vegetation cover. The Global Climate Observing System ([GCOS](https://public.wmo.int/en/programmes/global-climate-observing-system)) recognises LAI as an Essential Climate Variable ([ECV](https://public.wmo.int/en/programmes/global-climate-observing-system/essential-climate-variables)). + +Here, forest includes evergreen and deciduous needle leaf and broad leaf trees, irrigated crops - all possible crops excluding rice (is modelled separately), and other land cover type - agricultural areas, non-forested natural area, pervious surface of urban areas. +In LISFLOOD LAI has an important role in water interception and evapotranspiration processes. + +### Leaf Area Index for land covers forest, irrigated crops, and other + +#### General map information and possible source data + +| Map name | File name;type | Units; range | Description | +| :---| :--- | :--- | :--- | +| LAI for forest | laif.nc; Float32 | Units: -; Range: 0 ..7 |10-day average (36 maps in total) Leaf Area Index for closed forested areas (forest fraction per grid-cell ≥ 0.7)| +| LAI for irrigated crops | laii.nc; Float32 | Units: -; Range: 0 ..7 |10-day average (36 maps in total) Leaf Area Index for irrigated crop areas (irrigated crop fraction per grid-cell ≥ 0.7)| +| LAI for other | laio.nc; Float32 | Units: -; Range: 0 ..7 |10-day average (36 maps in total) Leaf Area Index for mainly other land cover type areas (other land cover type fraction per grid-cell ≥ 0.7)| + + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +| Copernicus Global Land Service LAI Collection Version 2 | https://land.copernicus.eu/global/products/lai | 1 January 2010 - 31 December 2019 | Global, 1 km| +| Fraction of forest | It can be prepared by using [this methodology](../4_Static-Maps_land-use#fraction-of-forest)| NA | Global, 1' and 3'| +| Fraction of irrigated crops | It can be prepared by using [this methodology](../4_Static-Maps_land-use#fraction-of-irrigated-crops)| NA | Global, 1' and 3'| +| Fraction of other land cover type | It can be prepared by using [this methodology](../4_Static-Maps_land-use#fraction-of-other-land-use-type)|NA | Global, 1' and 3'| + +#### Methodology + +To create LAI for forest, irrigated crops and other land cover type, maps [Copernicus Global Land Service LAI Collection](https://land.copernicus.eu/global/products/lai) Version 2 can be used.
The dataset provides a 10-day average LAI information, 36 maps each year. Here, to normalise the climate over different regions of the globe, the 10-day average LAI maps are aggregated over a 10-year period (i.e. first 10-day average of years 2010-2019 are aggregated to compute a first 10-day climatological average). As a result 36 climatological LAI maps are calculated. +Then, fraction maps for forest, irrigated crops, and other land cover type are used to mask non-dense areas of the land cover type in question (i.e. fraction is less than 0.7) over the climatological LAI maps.
+The LAI map resolution of the resulting field is reduced from native to the required one (e.g. from 1 km to 1 arc min) as follows. Firstly, the resolution is reduced to 1, 3, 15 arc min and 1, 3, 15, 60 degrees with mean.unweighted() reducer, and then all different resolutions are assembled to create a field with no missing values. For each resolution (going from the highest to the coarsest), grid-cells with missing values are identified and filled with the value of the corresponding grid-cell with non-missing value from the next resolution down map (e.g. using 3 arc min to fill in 1 arc min missing values). If the corresponding grid-cell is masked (has a missing value), then the value of the corresponding non-masked grid-cell from the next resolution down map is used, until all resolution maps are explored. If the corresponding grid-cell value of the coarsest resolution (here 60 degree) is still missing, a zero value is given. + +#### Results (examples) + + + +
+ 
+ 
+
+ 
+ 
+
+ + Lake mask map +In the LISFLOOD model lake mask map represents the area covered by lakes and is used for computing evaporation from open water surfaces. + + Lakes & reservoirs maps +In the LISFLOOD model lakes and reservoirs maps represent only outflow location grid-cells (store lake/reservoir ID number in the morphological parameter look-up table) and are used for the lakes and reservoirs modelling. + + +## Lake mask map + +### General map information and possible source data + +| Map name | File name;type | Units; range | Description | +| :---| :--- | :--- | :--- | +| Lake mask| lakemask.nc;
Type: Float32 | Units: -;
Range: 0 or 1 | Map of the footprint of lakes| + + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Global Lakes and Wetlands Database (GLWD):
Large Lake Polygons (Level 1) |[GLWD leve1](https://www.worldwildlife.org/publications/global-lakes-and-wetlands-database-large-lake-polygons-level-1)|2004|Global, 1:1 to 1:3 million resolution| +|Global Lakes and Wetlands Database (GLWD):
Small Lake Polygons (Level 3) |[GLWD leve1](https://www.worldwildlife.org/publications/global-lakes-and-wetlands-database-large-lake-polygons-level-2)|2004|Global, 1:1 to 1:3 million resolution| +|Fraction of inland water| It can be prepared by using
the methodology explained [here](../4_Static-Maps_land-use#lend-use)|NA|Global| + +### Methodology + +Fraction of inland water map is adjusted to the LISFLOOD model – all grid-cells fully covered with ocean water that are considered during computations are filled with inland water.
+If a grid-cell has any fraction of inland water and is inside the GLWD Level 1 and GLWD level 2 lake shapefiles, it is marked as ‘1’ (fully covered), otherwise it is marked as ‘0’.
+ + +### Results (examples) + + +
+ 
+ 
+
Type: Float32|Units: -;
Range: integer ID number to identify each lake |Lake outflow location
(stores lake ID number in the morphological parameter look-up table)| +|Reservoirs|res.nc;
Type: Float32|Units: -;
Range: integer ID number to identify each reservoir |Reservoir outflow location
(stores reservoir ID number in the morphological parameter look-up table)| + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Lakes datase|NA|NA|European/Global, ASCII table| +|Reservoirs dataset|NA|NA|European/Global, ASCII table| +|Local Drain Direction (LDD) map| It can be prepared by following the methodology explained [here](../4_Static-Maps_topography)|NA|Global| + +### Methodology + +Any ASCII tables with lakes and reservoirs geographical location should be mapped on the local drain direction (ldd) map. + + + diff --git a/docs/4_Static-Maps_rice-calendar/index.md b/docs/4_Static-Maps_rice-calendar/index.md new file mode 100644 index 00000000..f10beae7 --- /dev/null +++ b/docs/4_Static-Maps_rice-calendar/index.md @@ -0,0 +1,60 @@ +# Rice calendar + +Rice is the world’s most important food crop. It is harvested from over 163 million hectares in more than 100 countries ([FAO](http://www.fao.org/faostat/en/#home)). It is grown in diverse cropping systems and environments - from single crop systems in temperate and tropical regions in both rainfed and irrigated conditions, to intensive monoculture in irrigated areas in the tropics where rice is grown two or three times per year ([Laborte et al, 2017](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC5448352/)). Rice fields strongly differ from other crop fields in water routing, so hydrological models (e.g. LISFLOOD) have a separate component that computes necessary parameters over the rice fields. + +### General map information and possible source data + +| Map name | File name;type | Units; range | Description | +| :---| :--- | :--- | :--- | +| Rice planting day | riceplantingday**N**.nc; Float32 | Units: calendar day number;
Range: 1 ..365 |Map with first/second rice season planting day | +| Rice harvest day | riceharvestday**N**.nc; Float32 | Units: calendar day number;
Range: 1 ..365 |Map with first/second rice season harvesting day| + +*where **N** is the number of season (N = ’1’ for first season, N = ’2’ for second season). With source data below it is possible to generate N = ’3’ third season. + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|RiceAtlas, a global database of rice calendars and production;
Version 3 |[RiceAtlas](https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/JE6R2R)| up to 2017 | Global, shapefiles| + +## Methodology + +For the rice calendar maps, the ‘country subdivision’ shapefiles and 'rice production' table from RiceAtlas can be used. The 'rice production' table provides the following information: 'peak' planting days (named as PLANT_PK1, PLANT_PK2, PLANT_PK3), 'peak' harvest days (named as HARV_PK1, HARV_PK2, HARV_PK3), and number of rice total seasons per year (named as NUM_CROP), seasons varying from 1 (minimum) to 3 (maximum).
+The rice seasons are ordered according to the plant starting date in increasing Julian day order (i.e. season 1 being the one starting the earliest in the calendar year). +Then, the rice planting and harvesting fields for season 1 and 2 are created based on the ordered seasons. If there is only one season then its dates are copied to season 2. To insure the absence of missing data, a fixed value of rice planting/harvesting is associated with each grid-cell corresponding to nil rice fraction as the pre-computed global mode.unweighted() values of the first rice season – here planting date equals 105, harvesting date equals 227.
+ +## Results (examples) + + + +
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+In the LISFLOOD model the relationship between soil moisture and suction pressure (water retention curve), and hydraulic conductivity and soil moisture is described by the Van Genuchten equation and requires the following parameters: saturated hydraulic conductivity, lambda, genu alpha, theta residual and theta saturated.
++ Theta saturated (thetas) is the saturated water content soil hydraulic property representing the maximum water content in the soil.
++ Theta residual (thetar) is the residual water content soil hydraulic property representing the minimum water content in the soil.
++ Lambda is the Van Genuchten parameter λ (also referred as ‘n-1’ in literature) soil hydraulic property representing the pore size index of the soil. ++ Genu alpha (genua) is the Van Genuchten parameter α soil hydraulic property.
++ K saturated (Ksat) is the saturated hydraulic conductivity soil hydraulic property describing the ease with which water moves through pore spaces of the soil.
+ +Moreover, LISFLOOD differentiates between the water dynamics of areas with topsoil covered by forest and topsoil covered by non-forest land types. Here, forest includes evergreen and deciduous needle leaf and broad leaf trees, and non-forest (also referred to as ’others‘) includes all the other land cover types apart from forest. According to [FAO_2008](http://www.fao.org/uploads/media/Harm-World-Soil-DBv7cv_1.pdf) topsoil represents the first 30 cm, in the LISFLOOD model the topsoil is represented by the first two soil layers of the model (surface and middle layers). As a result, two soil hydraulic parameters are assigned to each LISFLOOD soil depth layer (soil depth layers are explained [here](../4_Static-Maps_land-use-depending) that represent topsoil, one for forested and one for non-forested areas. The soil hydraulic parameters for the third soil layer (bottom layer) do not depend on the land cover type.
+Soil hydraulic parameters are often derived from pedotransfer functions (PTFs) which translate soil characteristics to soil hydraulic properties. It should be noted that the same set of PTFs should be used to compute all different soil hydraulic properties. This guide describes the implementation of the PTFs proposed by [Toth et al. (2015)](https://onlinelibrary.wiley.com/doi/full/10.1111/ejss.12192). Clearly, LISFLOOD users can decide to implement a different set of PTFs.
+ + +## Soil hydraulic parameters for layers 1,2,3, for forested and non-forested areas maps + +## General map information and possible source data + +In the following table the soil hydraulic parameters required by the LISFLOOD model are presented.
+ +| Map name | File name;type | Units; range | Description | +| :---| :--- | :--- | :--- | +|Theta saturated |thetas**N_T**.nc;
Type: Float32 |Units: m3/m3;
Range: > 0.000 & < 1.000 |Saturated volumetric soil moisture content for forested/non-forested (others) areas | +|Theta residual |thetar**N_T**.nc;
Type: Float32 |Units: m3/m3;
Range: > 0.000 & < 1.000 |Residual volumetric soil moisture content for forested/non-forested (others) areas | +|lambda |lambda**N_T**.nc;
Type: Float32 |Units: - ;
Range: > 0.000 & ≤ 0.42 |Pore size index (λ) for forested/non-forested (others) areas | +|Genu Alpha|genua**N_T**.nc;
Type: Float32 |Units: cm-1 ;
Range: > 0.000 & ≤ 0.055 |Van Genuchten parameter (α) for forested/non-forested (others) areas soil | +|K saturated|ksat**N_T**.nc;
Type: Float32 |Units: mm/day ;
Range: > 0.000 |Saturated conductivity for forested/non-forested (others) areas | + +*where **N** is the number of soil depth layer (**N** = ’1’ for surface layer, **N** = ’2’ for middle layer, **N** = ’3’ for bottom layer), and **T** is the landcover type (**T** = ’f’ for forested areas, **T** = ’o’ for non-forested areas or others). For **N** = ’3’ landcover type is not differentiated (forested areas and others are combined). + + +The table below lists the data required for the implementation of the PTFs proposed by [Toth et al. (2015)](https://onlinelibrary.wiley.com/doi/full/10.1111/ejss.12192). + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +| % of Clay (C)|[ISRIC](https://files.isric.org/soilgrids/latest/data/clay/), mean value |2020|Global, 250 m available depths (cm):
0-5, 5-15, 15-30, 30-60, 60-100, 100-200| +| % of Silt (S)|[ISRIC](https://files.isric.org/soilgrids/latest/data/silt/), - |2020|Global, 250 m available depths (cm):
0-5, 5-15, 15-30, 30-60, 60-100, 100-200| +| % organic carbon (OC)|[ISRIC](https://files.isric.org/soilgrids/latest/data/soc/), mean value|2020|Global, 250 m available depths (cm):
0-5, 5-15, 15-30, 30-60, 60-100, 100-200| +| Bulk Density (BD)|[ISRIC](https://files.isric.org/soilgrids/latest/data/bdod/), median value (Q0.5)|2020|Global, 250 m available depths (cm):
0-5, 5-15, 15-30, 30-60, 60-100, 100-200| +| Soil PH |[ISRIC](https://files.isric.org/soilgrids/latest/data/phh2o/), mean value|2020|Global, 250 m available depths (cm):
0-5, 5-15, 15-30, 30-60, 60-100, 100-200| +| Cation exchange capacity (CEC)|[ISRIC](https://files.isric.org/soilgrids/latest/data/cec/), mean value|2020|Global, 250 m available depths (cm):
0-5, 5-15, 15-30, 30-60, 60-100, 100-200| +| Soil depth map | It can be prepared by using the
methodology explained [here](../4_Static-Maps_land-use-depending)| NA | Global, 250 m | +| Fraction of forested
areas map | It can be prepared by using the
methodology explained [here](../4_Static-Maps_land-use)| NA| Global, 100 m | + +## Methodology + +The table below shows the PTFs developed in [Toth et al. (2015)](https://onlinelibrary.wiley.com/doi/full/10.1111/ejss.12192). The column on the right clarifies the conditions that must be considered when computing the soil hydraulic parameters, regardless of the selected PTF.
+ + +| Parameter | Pedotransfer function* | Condition | +| :---| :--- | :--- | +|Theta saturated |$Thetas = (0.83080 - 0.28217 \cdot D + 0.0002728 \cdot C + 0.000187 \cdot S)$ |$Thetas <1$ (hurdle) | +|Theta residual |$Sand = 100 -S-C$
$Thetar=0.179$ if Sand<2.0
$Thetar=0.041$ if Sand≥2.0 |Thetar < Thetas (hurdle) | +|Lambda |$log10(λ) =$
$ 0.22236 - 0.30189 \cdot BD - 0.05558 \cdot T - 0.005306 \cdot C - 0.003084 \cdot S - 0.01072 \cdot OC$ |lambda≤0.42 (recommended)| +|Genu Alpha | $log10(Alpha) =$
$ -0.43348 - 0.41729 \cdot D - 0.04762 \cdot OC + 0.21810 \cdot T - 0.01581 \cdot C - 0.01207 \cdot S$ |alpha≤0.055(recommended)| +|K saturated** | $log10(KSat) =$
$ 0.40220 + 0.26122 \cdot pH + 0.44565 \cdot T - 0.02329 \cdot C - 0.01265 \cdot S - 0.01038 \cdot CEC $| Ksat>0 (hurdle) | + +*where D is bulk density, C - % of clay, S - % of silt, OC - organic content, CEC - cation exchange capacity, pH - soil pH, and T is the topsoil and subsoil distinction. FAO_2008 (link) defines topsoil as 0-30 cm layer and subsoil as 30-100 cm layer. When soil depth is within the definition of topsoil then T = 1, otherwise T = 0. +**K saturated results for Toth equation are in cm/day, the LISFLOOD model requires mm/day. + + +In this example of application, soil hydraulic parameters are firstly computed at the ISRIC soil proprieties resolution (~250 m) and resampled horizontally at a second stage. +Because in the current LISFLOOD model version, the soil depth layer 1 (surface) is fixed to the uniform value of 50 mm (see Section 6.2), the soil hydraulic parameters for this layer are calculated by applying the PTFs to the ISRIC soil characteristics of the 0-5 cm depth.
+For soil depth layers 2 (middle) and 3 (bottom) each soil hydraulic parameter is computed in 2 steps.
+In the first step the soil hydraulic parameters are computed for each ISRIC depth by applying the PTFs to each of the depths of the ISRIC soil characteristics (i.e. Clay, Silt, etc.) defined according to the ISRIC database (see Figure 30, Step 1).
+The second step consists in computing the value of the soil hydraulic parameter for the specific depth of the LISFLOOD soil depth layers 2 and 3. Unlike soil depth layer 1, the depths of soil layer 2 and soil layer 3 vary spatially (see Figure 26 to Figure 29). Each parameter is calculated as the weighted average of the parameters computed in step 1, for the soil depth corresponding to the grid-cell. Only the parameters that are within specific soil depth layer are used in the averaging operation (see Figure 30, step 2). +The following equation is used to compute the soil hydraulic parameter for the LISFLOOD model:
+ +$ \small parameter = \frac{ID2 \cdot parameter_{ID2} + ID3 \cdot parameter_{ID3} + ID4 \cdot parameter_{ID4}}{ID2+ID3+ID4} $ + +where ID1, ID2 and ID3 are the depths of the input ISRIC soil characteristics. Only the ISRIC depths included in the soil depth layer are used to compute the parameter. In the example, showed in Figure 30, the soil depth for layer 2 is equal to 450 mm, and the LISFLOOD soil hydraulic parameter is computed as:
+ +$ \small parameter = \frac{100 \cdot parameter_{ID2} + 150 \cdot parameter_{ID3} + 200 \cdot parameter_{ID4}}{100+150+200} $ + +where 100 is the thickness of ISRIC layer [5-15], 150 is the thickness of ISRIC layer [15-30], 200 is the result of the difference between 300 mm thickness of ISRIC layer (30-60) minus the 100 mm that are not in the soil depth grid-cell (ISRIC layer depths are expressed in cm, but for computations values are translated in mm).
+If cell's soil depth starts at a greater depth than 2000 mm, then each parameter is computed by using the input variables for depth layer (100-200).
+ +
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
+ 
+ 
+
++ **Slope gradient map** +Elevation data and its derivate (e.g. slope) are used in hydrological models for snow processes and for routing of surface runoff. In the LISFLOOD model the slope gradient map is used for surface routing.
++ **Standard deviation of elevation map** +Elevation data and its derivate (e.g. standard deviation of elevation) are used in hydrological models (e.g. the LISFLOOD model) for snow processes and for routing of surface runoff.
++ **Map with upstream area** +The upstream area in a distributed hydrological model is the accumulated area of all connected water pixels that in a river network starts at the springs and goes to the river mouth. Springs grid-cells have lowest values, and river mouth grid-cells have the highest values on the map. Following links provide examples how upstream area map can be generated with [ArcGIS](https://desktop.arcgis.com/en/arcmap/10.3/tools/spatial-analyst-toolbox/flow-accumulation.htm) or [PCRaster](https://pcraster.geo.uu.nl/pcraster/4.3.0/documentation/pcraster_manual/sphinx/op_upstream.html).
+ +## Local drain direction map +### General map information and possible source data + +| Map name | File name;type | Units; range | Description | +| :---| :--- | :--- | :--- | +|Local drain direction (ldd) map | ldd.nc/ldd.map;
Type: Byte | Units: -;
Values: 1,2,3,4,5,6,7,8,9 |Local drain direction map - flow directions from each grid-cell to its steepest downslope neighbour; geographical directions are coded n a following way: N=8, NE=9, E=6, SE=3, S=2, SW=1, W=4, NW=7, and grid-cells with only inflow of water (pits) equal 5; the pit grid-cell at the end of the path is the outlet point of a catchment; NoData=255 | + + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Flow direction map |[cama-flood](http://hydro.iis.u-tokyo.ac.jp/~yamadai/cama-flood/index.html) |2018 |Global, 1' and 3'| + + +### Methodology + +It is suggested to use cautiously any file transforming commands as they might change file structure. Here it is suggested to use only CDO, GDAL and Python commands to preserve initial file structure as much as possible (especially latitude and longitude values) and be able to use it later as a Template for all other static maps.
+To create a local drain direction (ldd) field from a flow direction map, initial file values in a NetCDF format are changed in the following way for different geographical directions. Mouth: ‘-1’=>’5’, Inland: ‘0’=>’5’, North: ‘1’=>’8’, NE: ‘2’=>’9’, East: ‘3’=>’6’, SE: ‘4’=>’3’, South: ‘5’=>’2’, SW: ‘6’=>’1’, West: ‘7’=>’4’, NW: ‘8’=>’7’.
+Note: Obtaining a flow direction map from a digital elevation model is a complex process and is not described here. A good example of how to create a flow direction map can be found in [Yamazaki et al. (WRR, 2019)](https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2019WR024873). Note also that the created ldd file must be checked and corrected if needed, so that water is not flowing out of the region of interest. Finally, after all manipulations of the NetCDF file, latitude and longitude values from the native files must be copied to the newly generated file to insure identical structure of all static map files.
+ +### Results (example) + +
+ 
+ 
+
Type: Float32 | Units: -;
Range: >0 |Slope gradient | + + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +| MERIT DEM: Multi-Error-Removed Improved-Terrain DEM| [MERIT DEM](http://hydro.iis.u-tokyo.ac.jp/~yamadai/MERIT_DEM/index.html) | 2018 | Global, 3" (~90 m) | +|Local drain direction (ldd) map |It can be created using the methodology explained [here](../4_Static-Maps_topography#local-drain-direction-map) |NA |Global, 1' and 3'| + +### Methodology +The local drain direction (ldd) file can be used to extract the connectivity between grid-cells. The distance (in meters) between two connected grid-cells is calculated together with the absolute difference (in meters) of elevation between the two grid-cells.
+Gradient is assigned to the upstream grid-cell, and computed according to the following formula:
+ +$$ +gradient=\frac{elevation difference}{distance} +$$ + +$gradient$ is set equal 0 where $ldd$ is 5. + +### Results (examples) + +
+ 
+ 
+
Type: Float32 | Units: -;
Range: >=0 |Standard deviation of elevation (altitude difference elevation within a grid-cell) | + + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +| MERIT DEM: Multi-Error-Removed Improved-Terrain DEM| [MERIT DEM](http://hydro.iis.u-tokyo.ac.jp/~yamadai/MERIT_DEM/index.html) | 2018 | Global, 3" (~90 m) | + +### Methodology + +High resolution of initial elevation data is to be reduced to the needed coarser resolution i) by averaging elevation data with mean.unweighted() reducer to compute elevation field at required resolution, and ii) by computing standard deviation of all 90-meter grid-cells on the elevation field included into one e.g. 1 arc min grid-cell with stDev.unweighted() reducer. + +### Results (examples) + +
+ 
+ 
+
Type: Float32 | Units: $m^2$;
Range: >0 |Map with upstream area (based on ldd and pixarea maps) - the accumulated area of all connected water pixels that in a river network starts at the springs and goes to the river mouth| + + +| Source data| Reference/preparation | Temporal coverage | Spatial information | +| :---| :--- | :--- | :--- | +|Pixel area map |It can be created using the methodology explained [here](../4_Static-Maps_general-maps#grid-cell-length-and-grid-cell-area-maps) |NA |Global, 1' and 3'| +|Local drain direction (ldd) map |It can be created using the methodology explained [here](../4_Static-Maps_topography#local-drain-direction-map) |NA |Global, 1' and 3'| + +### Methodology + +To create an upstream area, pixel area and ldd maps are used with the PCRaster function accuflux. + +### Results (examples) + +
+ 
+ 
+
+ 
+
Range: 0 or 1 | Boolean map that defines model boundaries | +| **TOPOGRAPHY** | | | | +| Ldd | ldd.map | U.: flow directions
R.: 1 ≤ map ≤ 9 | local drain direction map (with value 1-9); this file contains flow directions from each cell to its steepest downslope neighbour. Ldd directions are coded according to the following diagram:
This resembles the numeric key pad of your PC's keyboard, except for the value 5, which defines a cell without local drain direction (pit). The pit cell at the end of the path is the outlet point of a catchment. | +| Grad | gradient.map | U.: $\frac{m}{m}$
R.: map > 0
| Slope gradient | +| Elevation Stdev | elvstd.map | U.: $m$
R.: map ≥ 0 | Standard deviation of elevation | +| **LAND USE -- fraction maps** | | | | +| Fraction of water | fracwater.map | U.: [-]
R.: 0 ≤ map ≤ 1 | Fraction of inland water for each cell. Values range from 0 (no water at all) to 1 (pixel is 100% water) | +| Fraction of sealed surface | fracsealed.map | U.: [-]
R.: 0 ≤ map ≤ 1 | Fraction of impermeable surface for each cell. Values range from 0 (100% permeable surface -- no urban at all) to 1 (100% impermeable surface). | +| Fraction of forest | fracforest.map | U.:[-]
R.: 0 ≤ map ≤ 1 | Forest fraction for each cell. Values range from 0 (no forest at all) to 1 (pixel is 100% forest) | +| Fraction of other land cover | fracother.map | U.: [-]
R.: 0 ≤ map ≤ 1 | Other (agricultural areas, non-forested natural area, pervious surface of urban areas) fraction for each cell. | +| **LAND COVER depending maps** | | | | +| Crop coef. for forest | cropcoef_forest.map | U.: [-]
R.: 0.8≤ map ≤ 1.2 | Crop coefficient for forest | +| Crop coef. for other | cropcoef_other.map | U.: [-]
R.: 0.8≤ map ≤ 1.2 | Crop coefficient for other | +| Crop group number for forest | crgrnum_forest.map | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for forest | +| Crop group number for forest | crgrnum_other.map | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for other | +| Manning for forest | mannings_forest.map | U.: $m^{-1/3} s$
R.: 0.2≤ map ≤ 0.4 | Manning's roughness for forest | +| Manning for other | mannings_other.map | U.: $m^{-1/3} s$
R.: 0.01≤ map ≤0.3 | Manning's roughness for other | +| Soil depth for forest for layer1a | soildep1a_forest.map | U.: $mm$
R.: map ≥ 50 | Forest soil depth for soil layer 1a | +| Soil depth for other for layer1a | soildep1a_other.map | U.: $mm$
R.: map ≥ 50 | Other soil depth for soil layer 1a | +| Soil depth for forest for layer1b | soildep1b_forest.map | U.: $mm$
R.: map ≥ 50 | Forest soil depth for soil layer 1b | +| Soil depth for other for layer1b | soildep1b_other.map | U.: $mm$
R.: map ≥ 50 | Other soil soil depth for soil layer 1b | +| Soil depth for forest for layer2 | soildep2_forest.map | U.: $mm$
R.: map ≥ 50 | Forest soil depth for soil layer 2 | +| Soil depth for other for layer2 | soildep2_other.map | U.: $mm$
R.: map ≥ 50 | Other soil soil depth for soil layer 2 | +| **SOIL HYDRAULIC PROPERTIES (depending on soil texture)** | | | | +| ThetaSat1a for forest | thetas1a_forest.map | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 1a | +| ThetaSat1a for other | thetas1a_other.map | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 1a | +| ThetaSat1b for forest | thetas1b_forest.map | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 1b | +| ThetaSat1b for other | thetas1b_other.map | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 1b | +| ThetaSat2 for forest and other | thetas2.map | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 2 | +| ThetaRes1a for forest | thetar1a_forest.map | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 1a | +| ThetaRes1a for other | thetar1a_other.map | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 1a | +| ThetaRes1b for forest | thetar1b_forest.map | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 1b | +| ThetaRes1b for other | thetar1b_other.map | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 1b | +| ThetaRes2 for forest and other | thetar2.map | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 2 | +| Lambda1a for forest | lambda1a_forest.map | U.: [-]
R.: map>0 | Pore size index (λ) layer 1a | +| Lambda1a for other | lambda1a_other.map | U.: [-]
R.: map>0 | Pore size index (λ) layer 1a | +| Lambda1b for forest | lambda1b_forest.map | U.: [-]
R.: map>0 | Pore size index (λ) layer 1b | +| Lambda1b for other | lambda1b_other.map | U.: [-]
R.: map>0 | Pore size index (λ) layer 1b +| Lambda2 for forest and other | lambda2.map | U.: [-]
R.: map>0 | Pore size index (λ) layer 2 | +| GenuAlpha1a for forest | alpha1a_forest.map | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 1a | +| GenuAlpha1a for other | alpha1a_other.map | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 1a | +| GenuAlpha1b for forest | alpha1b_forest.map | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 1b | +| GenuAlpha1b for other | alpha1b_other.map | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 1b | +| GenuAlpha2 for forest and other | alpha2.map | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 2 | +| Sat1a for forest | ksat1a_forest.map | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 1a | +| Sat1a for other | ksat1a_other.map | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 1a | +| Sat1b for forest | ksat1b_forest.map | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 1b | +| Sat1b for other | ksat1b_other.map | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 1b | +| Sat2 for forest and other | ksat2.map | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 2 | +| **CHANNEL GEOMETRY** | | | | +| Channels | chan.map | U.: [-]
R.: 0 or 1 | Map with Boolean 1 for all channel pixels, and Boolean 0 for all other pixels on MaskMap | +| ChanGrad | changrad.map | U.: $\frac{m} {m}$
R.: map > 0
!!! | Channel gradient | +| ChanMan | chanman.map | U.: $m^{-1/3} s$
R.: map > 0 | Manning's roughness coefficient for channels | +| ChanLength | chanleng.map | U.: $m$
R.: map > 0 | Channel length (can exceed grid size, to account for meandering rivers) | +| ChanBottomWidth | chanbw.map | U.: $m$
R.: map > 0 | Channel bottom width | +| ChanSdXdY | chans.map | U.: $\frac{m} {m}$
R.: map ≥ 0 | Channel side slope Important: defined as horizontal divided by vertical distance (dx/dy); this may be confusing because slope is usually defined the other way round (i.e. dy/dx)! | +| ChanDepthThreshold | chanbnkf.map | U.: $m$
R.: map > 0 | Bankfull channel depth | +| **METEOROLOGICAL VARIABLES** | | | | +| PrecipitationMaps | pr | U.: $\frac{mm} {day}$
R.: map ≥ 0 | Precipitation rate | +| TavgMaps | ta | U.: $°C$
R.:-50 ≤map ≤ +50 | Average daily temperature | +| E0Maps | e | U.: $\frac{mm} {day}$
R.: map ≥ 0 | Daily potential evaporation rate, free water surface | +| ES0Maps | es | U.: $\frac{mm} {day}$
R.: map ≥ 0 | Daily potential evaporation rate, bare soil | +| ET0Maps | et | U.: $\frac{mm} {day}$
R.: map ≥ 0 | Daily potential evapotranspiration rate, reference crop | +| **DEVELOPMENT OF VEGETATION OVER TIME** | | | | +| LAIMaps for forest | lai_forest | U.: $\frac{m^2} {m^2}$
R.: map ≥ 0 | Pixel-average Leaf Area Index for forest | +| LAIMaps for other | lai_other | U.: $\frac{m^2} {m^2}$
R.: map ≥ 0 | Pixel-average Leaf Area Index for other | +| **DEFINITION OF INPUT/OUTPUT TIMESERIES** | | | | +| Gauges | outlets.map | U.: [-]
R.: For each station an individual number | Nominal map with locations at which discharge timeseries are reported (usually correspond to gauging stations) | +| Sites | sites.map | U.: [-]
R.: For each station an individual number | Nominal map with locations (individual pixels or areas) at which timeseries of intermediate state and rate variables are reported (soil moisture, infiltration, snow, etcetera) | + + + +***Table:*** *Optional maps that define grid size.* + +| Map | Default name | Units, range | Description | +| --------------- | ------------ | ------------------------ | --------------------- | +| PixelLengthUser | pixleng.map | U.: $m$
R.: map > 0 | Map with pixel length | +| PixelAreaUser | pixarea.map | U.: $m$
R.: map > 0 | Map with pixel area | + + + +## Tables + +In the previous version of LISFLOOD a number of model parameters are read through tables that are linked to the classes on the land use and soil (texture) maps. +Those tables are replaced by maps (e.g. soil hydraulic property maps) in order to include the sub-grid variability of each parameter. + +Therefore only one default table is used in the standard LISFLOOD setting. The following table gives an overview: + +***Table:*** *LISFLOOD input tables.* + +| Table | Default name | Description | +| ---------------------- | ------------ | ---------------------------------------- | +| **LAND USE** | | | +| Day of the year -> LAI | LaiOfDay.txt | Lookup table: Day of the year -> LAI map | + +[🔝](#top) + diff --git a/docs/4_annex_output-files/index.md b/docs/4_annex_output-files/index.md new file mode 100644 index 00000000..2811aa3d --- /dev/null +++ b/docs/4_annex_output-files/index.md @@ -0,0 +1,191 @@ +# Output generated by LISFLOOD + +LISFLOOD can generate a wide variety of outputs. Output files can be time series at specific points (.tss files) or maps (NetCDF format). Reporting of output files can be switched on and off using options in the LISFLOOD settings file. A number of output files are specific to optional modules, such as the simulation of reservoirs. This page lists the most common output time series and maps (note that the file names can always be changed by the user, although this is not recommended). + +## Time Series + +***Table:*** *LISFLOOD output time series, some examples.* + +| Description | Units | File name | +| ------------------------------------------------------------ | ---------------- | --------------------- | +| **RATE VARIABLES AT GAUGES** | | | +| $^{1,2}$ channel discharge | $\frac{m^3} {s}$ | dis.tss | +| **NUMERICAL CHECKS** | | | +| $^2$ cumulative mass balance error | $m^3$ | mbError.tss | +| $^2$ cumulative mass balance error, expressed as mm water slice (average over catchment) | $mm$ | mbErrorMm.tss | +| $^2$ number of sub-steps needed for channel routing | - | NoSubStepsChannel.tss | + +$^1$ Output only if option 'InitLisflood' = 1 (pre-run) +$^2$ Output only if option 'InitLisflood' = 0 + +Output time series can be classified in the following categories: + +1. Time series with values of meteorological input variables, averaged over the area upstream of each gauge location; reporting of these time series can be activated using the option *repMeteoUpsGauges=1* +2. Time series with values of model state variables, averaged over area upstream of each gauge location; reporting of these time series can be activated using the option *repStateUpsGauges=1* +3. Time series with values of model rate variables, averaged over area upstream of each gauge location; reporting of these time series can be activated using the option *repRateUpsGauges=1* +4. Time series that are specific to other options (e.g. simulation of reservoirs). +5. Time series with values of model state variables at user-defined locations (sites); reporting of these time series can be activated using the option *repStateSites=1.* Note that 'sites' can be either individual pixels or larger areas (e.g. catchments, administrative areas, and so on). In case of larger areas the model reports the average value for each respective area. +6. Time series with values of model rate variables at user-defined locations (sites); reporting of these time series can be activated using the option *repRateSites=1* + +***Table:*** *LISFLOOD optional output time series (only 'InitLisflood' = 0).* + +| Description | Units | Settings variable | Default name | +| ------------------------------------------------------------ | -------------------------- | ---------------------- | ---------------------- | +| **STATE VARIABLES AT SITES** (option *repStateSites*) | | | | +| depth of snow cover on soil surface (pixel-average) | $mm$ | SnowCoverTS | snowCover.tss | +| depth of interception storage | $mm$ | CumInterceptionTS | cumInt.tss | +| soil moisture content superficial layer | $\frac{mm^3}{mm^3}$ | Theta1TS | th1a.tss | +| soil moisture content upper layer | $\frac{mm^3}{mm^3}$ | Theta2TS | th1b.tss | +| soil moisture layer bottom layer | $\frac{mm^3}{mm^3}$ | Theta3TS | th2.tss | +| storage in upper groundwater zone | $mm$ | UZTS | uz.tss | +| storage in lower groundwater zone | $mm$ | LZTS | lz.tss | +| number of days since last rain | $days$ | DSLRTS | dslr.tss | +| frost index | $\frac{°C}{days}$ | FrostIndexTS | frost.tss | +| **RATE VARIABLES AT SITES** (option *repRateSites*) | | | | +| rain (excluding snow) | $\frac{mm}{timestep}$ | RainTS | rain.tss | +| Snow | $\frac{mm}{timestep}$ | SnowTS | snow.tss | +| snow melt | $\frac{mm}{timestep}$ | SnowmeltTS | snowMelt.tss | +| actual evaporation | $\frac{mm}{timestep}$ | ESActTS | esAct.tss | +| actual transpiration | $\frac{mm}{timestep}$ | TaTS | tAct.tss | +| rainfall interception | $\frac{mm}{timestep}$ | InterceptionTS | interception.tss | +| evaporation of intercepted water | $\frac{mm}{timestep}$ | EWIntTS | ewIntAct.tss | +| leaf drainage | $\frac{mm}{timestep}$ | LeafDrainageTS | leafDrainage.tss | +| infiltration | $\frac{mm}{timestep}$ | InfiltrationTS | infiltration.tss | +| preferential (bypass) flow | $\frac{mm}{timestep}$ | PrefFlowTS | prefFlow.tss | +| percolation upper to lower soil layer | $\frac{mm}{timestep}$ | PercolationTS | dTopToSub.tss | +| percolation lower soil layer to subsoil | $\frac{mm}{timestep}$ | SeepSubToGWTS | dSubToUz.tss | +| surface runoff | $\frac{mm}{timestep}$ | SurfaceRunoffTS | surfaceRunoff.tss | +| outflow from upper zone | $\frac{mm}{timestep}$ | UZOutflowTS | qUz.tss | +| outflow from lower zone | $\frac{mm}{timestep}$ | LZOutflowTS | qLz.tss | +| total runoff | $\frac{mm}{timestep}$ | TotalRunoffTS | totalRunoff.tss | +| percolation from upper to lower zone | $\frac{mm}{timestep}$ | GwPercUZLZTS | percUZLZ.tss | +| loss from lower zone | $\frac{mm}{timestep}$ | GwLossTS | loss.tss | +| **TIME SERIES, AVERAGE UPSTREAM OF GAUGES** | | | | +| **METEOROLOGICAL INPUT VARIABLES** (option *repMeteoUpsGauges*) | | | | +| precipitation | $\frac{mm}{timestep}$ | PrecipitationAvUpsTS | precipUps.tss | +| potential reference evapotranspiration | $\frac{mm}{timestep}$ | ETRefAvUpsTS | etUps.tss | +| potential evaporation from soil | $\frac{mm}{timestep}$ | ESRefAvUpsTS | esUps.tss | +| potential open water evaporation | $\frac{mm}{timestep}$ | EWRefAvUpsTS | ewUps.tss | +| average daily temperature | $°C$ | TavgAvUpsTS | tAvgUps.tss | +| **STATE VARIABLES** (option *repStateUpsGauges*) | | | | +| depth of water on soil surface | $mm$ | WaterDepthAvUpsTS | wdepthUps.tss | +| depth of snow cover on | $mm$ | SnowCoverAvUpsTS | snowCoverUps.tss | +| depth of interception storage | $mm$ | CumInterceptionAvUpsTS | cumInterceptionUps.tss | +| soil moisture upper layer | $\frac{mm^3}{mm^3}$ | Theta1AvUpsTS | th1aAvUps.tss | +| soil moisture lower layer | $\frac{mm^3}{mm^3}$ | Theta2AvUpsTS | th1bAvUps.tss | +| soil moisture layer 2 | $\frac{mm^3}{mm^3}$ | Theta3AvUpsTS | th2AvUps.tss | +| groundwater upper zone | $mm$ | UZAvUpsTS | uzUps.tss | +| groundwater lower zone | $mm$ | LZAvUpsTS | lzUps.tss | +| number of days since last rain | $days$ | DSLRAvUpsTS | dslrUps.tss | +| frost index | $\frac{°C}{days}$ | FrostIndexAvUpsTS | frostUps.tss | +| **RATE VARIABLES** (option *repRateUpsGauges*) | | | | +| rain (excluding snow) | $\frac{mm}{timestep}$ | RainAvUpsTS | rainUps.tss | +| snow | $\frac{mm}{timestep}$ | SnowAvUpsTS | snowUps.tss | +| snow melt | $\frac{mm}{timestep}$ | SnowmeltAvUpsTS | snowMeltUps.tss | +| actual evaporation | $\frac{mm}{timestep}$ | ESActAvUpsTS | esActUps.tss | +| actual transpiration | $\frac{mm}{timestep}$ | TaAvUpsTS | tActUps.tss | +| rainfall interception | $\frac{mm}{timestep}$ | InterceptionAvUpsTS | interceptionUps.tss | +| evaporation of intercepted water | $\frac{mm}{timestep}$ | EWIntAvUpsTS | ewIntActUps.tss | +| leaf drainage | $\frac{mm}{timestep}$ | LeafDrainageAvUpsTS | leafDrainageUps.tss | +| infiltration | $\frac{mm}{timestep}$ | InfiltrationAvUpsTS | infiltrationUps.tss | +| preferential (bypass) flow | $\frac{mm}{timestep}$ | PrefFlowAvUpsTS | prefFlowUps.tss | +| percolation upper to lower soil layer | $\frac{mm}{timestep}$ | PercolationAvUpsTS | dTopToSubUps.tss | +| percolation lower soil layer to subsoil | $\frac{mm}{timestep}$ | SeepSubToGWAvUpsTS | dSubToUzUps.tss | +| surface runoff | $\frac{mm}{timestep}$ | SurfaceRunoffAvUpsTS | surfaceRunoffUps.tss | +| outflow from upper zone | $\frac{mm}{timestep}$ | UZOutflowAvUpsTS | qUzUps.tss | +| outflow from lower zone | $\frac{mm}{timestep}$ | LZOutflowAvUpsTS | qLzUps.tss | +| total runoff | $\frac{mm}{timestep}$ | TotalRunoffAvUpsTS | totalRunoffUps.tss | +| percolation upper to lower zone | $\frac{mm}{timestep}$ | GwPercUZLZAvUpsTS | percUZLZUps.tss | +| loss from lower zone | $\frac{mm}{timestep}$ | GwLossTS | lossUps.tss | +| **WATER LEVEL IN CHANNEL** (option *repWaterLevelTs*) | | | | +| water level in channel | $m$ (above channel bottom) | WaterLevelTS | waterLevel.tss | +| **OUTPUT RELATED TO LOWER ZONE INITIALISATION** (option *repLZAvInflowSites* and *repLZAvInflowUpsGauges*) | | | | +| average inflow into lower zone | $\frac{mm^3}{day}$ | LZAvInflowTS | lzAvIn.tss | +| average inflow into lower zone | $\frac{mm^3}{day}$ | LZAvInflowAvUpsTS | lzAvInUps.tss | + + + +## Maps + +Output maps can be classified according to the following categories: + +1. Maps of discharge at each time step; reporting of these maps can be activated using the option *repDischargeMaps=1*. +2. Maps with values of driving meteorological values at each time step. +3. Maps with values of model state variables at each time step. +4. Maps with values of model rate variables at each time step. +5. Maps that are specific to other options (e.g. simulation of reservoirs). + +In addition, some additional maps and time series may be reported for debugging purposes. In general these are not of any interest to the LISFLOOD user, so they are not documented here. + +Note the domains for which variables are valid: all *rate variables* are reported as pixel-average values. Soil moisture and groundwater storage are reported for the permeable fraction of each pixel only. The reported snow cover is the average of the snow depths in snow zones A, B and C. + + +***Table:*** *LISFLOOD initialization default output maps (Output only if option 'InitLisflood' = 1).* + +| Description | Units | File name | Domain | +| ------------------------------------------------------------ | ------------------- | ----------------- | ------------------------------------ | +| **AVERAGE RECHARGE MAP (for lower groundwater zone and channel discharge)** (option *InitLisflood*) | | | | +| average inflow to lower zone | $mm$ | lzavin.nc | whole pixel | +| average channel discharge (if option 'SplitRouting' = 1) | $\frac{m}{s}$ | avgdis.nc| channel | + +LISFLOOD can also generate optional output end-files to allow the initialization of the soil moisture of the three soil layers and the water content of the upper groundwater zone. To achieve this aim is necessary to set 'repEndMaps' = 1 (with 'InitLisflood' = 1). More details are provided here https://ec-jrc.github.io/lisflood-code/3_step5_model-initialisation/ +To speed up the pre-run and to prevent that results are taken from the pre-run, all additional output is disabled if option 'InitLisflood' = 1 is chosen. + +### *LISFLOOD state maps. These maps can be used to define the initial conditions of another simulation.* +These maps are written in output when 'repStateMaps' = 1. +LISFLOOD writes the results for each computational time step. +The complete list of state maps is available here https://ec-jrc.github.io/lisflood-code/4_annex_state-variables/ . +The users should be aware that some state maps are generated only if the relevant option has been set to 1. For instance, LakePrevInflowState and LakePrevOutflowState can be generated only when 'simulateLakes' = 1. + + +***Table:*** *LISFLOOD optional output maps* + +| Description | Option | Units | Settings variable | Prefix | +| --------------------------------------- | ---------------------- | -------------------------- | -------------------------------------------------- | --------------- | +| **DISCHARGE** | | | | | +| discharge | repDischargeMaps | $\frac{m^3}{s}$ | DischargeMaps | dis | +| **METEOROLOGICAL INPUT VARIABLES** | | | | | +| precipitation | repPrecipitationMaps | $mm$ | PrecipitationMaps | pr | +| potential reference evapotranspiration | repETRefMaps | $mm$ | ETRefMaps | et | +| potential evaporation from soil | repESRefMaps | $mm$ | ESRefMaps | es | +| potential open water evaporation | repEWRefMaps | $mm$ | EWRefMaps | ew | +| average daily temperature | repTavgMaps | $mm$ | TavgMaps | tav | +| **VOLUME VARIABLES** | | | | | +| depth of water on soil surface | repWaterDepthMaps | $mm$ | WaterDepthMaps | wdep | +| depth of snow cover on soil surface | repSnowCoverMaps | $mm$ | SnowCoverMaps | scov | +| depth of interception storage | repCumInterceptionMaps | $mm$ | CumInterceptionMaps (other fraction)
CumInterceptionForestMaps
CumInterceptionIrrigationMaps
CumIntSealedMaps | cum
cumf
cumi
cums | +| soil moisture content of the three soil layers | repThetaMaps | $\frac{mm^3}{mm^3}$ | Theta1Maps
Theta1ForestMaps
Theta1IrrigationMaps
Theta2Maps
Theta2ForestMaps
Theta2IrrigationMaps
Theta3Maps
Theta3ForestMaps
Theta3IrrigationMaps | tha
thfa
thia
thb
thfb
thib
thc
thfc
thic| +| storage in upper groundwater zone | repUZMaps | $mm$ | UZMaps
UZForestMaps
UZIrrigationMaps | uz
uzf
uzi | +| storage in lower groundwater zone | repLZMaps | $mm$ | LZMaps | lz | +| number of days since last rain | repDSLRMaps | $days$ | DSLRMaps
DSLRForestMaps | dslr
dslF | +| frost index | repFrostIndexMaps | $\frac{°C}{days}$ | FrostIndexMaps | frost | +| Total Water Storage | repTotalWaterStorageMaps | $mm$ | TotalWaterStorageMaps | tws | +| **RATE VARIABLES** | | | | | +| rain (excluding snow) | repRainMaps | $\frac{mm}{timestep}$ | RainMaps | rain | +| snow | repSnowMaps | $\frac{mm}{timestep}$ | SnowMaps | snow | +| snow melt | repSnowMeltMaps | $\frac{mm}{timestep}$ | SnowMeltMaps | smelt | +| actual evaporation | repESActMaps | $\frac{mm}{timestep}$ | ESActMaps | esact | +| actual transpiration | repTaMaps | $\frac{mm}{timestep}$ | TaMaps | tact | +| rainfall interception | repInterceptionMaps | $\frac{mm}{timestep}$ | InterceptionMaps
InterceptionForestMaps | int
intF | +| evaporation of intercepted water | repEWIntMaps | $\frac{mm}{timestep}$ | EWIntMaps | ewint | +| leaf drainage | repLeafDrainageMaps | $\frac{mm}{timestep}$ | LeafDrainageMaps
LeafDrainageForestMaps | ldra
draF | +| infiltration | repInfiltrationMaps | $\frac{mm}{timestep}$ | InfiltrationMaps
InfiltrationForestMaps | inf
infF | +| preferential (bypass) flow | repPrefFlowMaps | $\frac{mm}{timestep}$ | PrefFlowMaps
PrefFlowtherMaps
PrefFlowForestMaps
PrefFlowIrrigationMaps | pflowpixel
pflow
pflowF
pflowi | +| percolation upper to lower soil layer | repPercolationMaps | $\frac{mm}{timestep}$ | Percolation1ato1bOtherMaps
Percolation1ato1bForestMaps
Percolation1ato1bIrrigationMaps
Percolation1bto2OtherMaps
Percolation1bto2ForestMaps
Percolation1bto2IrrigationMaps | Percolation1ato1bOther
Percolation1ato1bForest
Percolation1ato1bIrrigation
Percolation1bto2Other
Percolation1bto2Forest
Percolation1bto2Irrigation | +| percolation lower soil layer to subsoil | repSeepSubToGWMaps | $\frac{mm}{timestep}$ | SeepSubToGWMaps
SeepSubToGWotherMaps
SeepSubToGWforestMaps
SeepSubToGWoirrigationMaps | sgwPixel
sgwOther
sgwForest
sgwIrrigation | +| surface runoff | repSurfaceRunoffMaps | $\frac{mm}{timestep}$ | SurfaceRunoffMaps | srun | +| outflow from upper zone | repUZOutflowMaps | $\frac{mm}{timestep}$ | UZOutflowMaps, UZOutflowForestMaps
UZOutflowIrrigationMaps | quzPixel
quz
quzF
quzi | +| outflow from lower zone | repLZOutflowMaps | $\frac{mm}{timestep}$ | LZOutflowMaps | qlz | +| total runoff | repTotalRunoffMaps | $\frac{mm}{timestep}$ | TotalRunoffMaps | trun | +| percolation upper to lower zone | repGwPercUZLZMaps | $\frac{mm}{timestep}$ | GwPercUZLZMaps
GwPercUZLZOtherMaps
GwPercUZLZForestMaps
GwPercUZLZIrrigationMaps | uz2lzPixel
uz2lz
uz2lzF
uz2lzi | +| loss from lower zone | repGwLossMaps | $\frac{mm}{timestep}$ | GwLossMaps | loss | + +**Note** + +Some cumulative stoarges and volumes are computed internally by LISFLOOD. Some relevant exmaple is described below: +- Total Water Storage is the total water volume stored in channels, lakes, reservoirs, snow cover, sealed surfaces depressions, surface runoff, canopy interception, uppper and lower groundwater zones. +- Surface runoff is the sum of direct runoff (from sealed and water fractions) and runoff generated by the pervious land cover fractions (forest, irrigation, other). +- Total runoff is the sum of surface runoff and sub-surface runoff. Sub-surface runoff is the outflow from upper and lower groundwater zones. + + +[🔝](#top) diff --git a/docs/4_annex_parameters/index.md b/docs/4_annex_parameters/index.md new file mode 100644 index 00000000..717541ec --- /dev/null +++ b/docs/4_annex_parameters/index.md @@ -0,0 +1,18 @@ +**Table:** *Parameters range and default values.* + +| ParameterName | MinValue | MaxValue | DefaultValue | +| :----------------------------- | -----------------: | -----------------: | -----------------: | +| UpperZoneTimeConstant | 0.01 | 40 | 10 | +| LowerZoneTimeConstant | 40 | 1000 | 100 | +| GwPercValue | 0.01 | 2 | 0.8 | +| LZThreshold | 0 | 30 | 10 | +| b_Xinanjiang | 0.01 | 5 | 0.5 | +| PowerPrefFlow | 0.5 | 8 | 4 | +| SnowMeltCoef | 2.5 | 6.5 | 4 | +| CalChanMan1 | 0.5 | 2 | 1 | +| CalChanMan2 | 0.5 | 5 | 1 | +| LakeMultiplier | 0.5 | 2 | 1 | +| adjust_Normal_Flood | 0.01 | 0.99 | 0.8 | +| ReservoirRnormqMult | 0.25 | 2 | 1 | +| QSplitMult | 0 | 20 | 2 | +| GwLoss | 0 | 0.5 | 0 | \ No newline at end of file diff --git a/docs/4_annex_settings_and_options/index.md b/docs/4_annex_settings_and_options/index.md new file mode 100644 index 00000000..378c9bc6 --- /dev/null +++ b/docs/4_annex_settings_and_options/index.md @@ -0,0 +1,891 @@ +The Tables below presents a comprehensive list of setting options, inputs, and outputs. + + + +**Table:** *LISFLOOD Settings.* + +| section (XML) | group (XML) | module | eqz | KEY | cold | warm | Type | I/O | Description | +| --------------- | ------------------------------------------------------------ | ---------------------------------- | ------ | ------------------------------- | ------------------------------------------------- | ------------------------------------------------- | --------------- | ---------------------- | ------------------------------------------------------------ | +| lfoptions | | SETTINGS | | TemperatureInKelvin | | | switch | input | Use temperature data in C (=0) or in K (=1) | +| lfoptions | | SETTINGS | | gridSizeUserDefined | | | switch | input | Get grid size attributes (length, area) from user-defined maps (instead of using map location attributes directly) | +| lfoptions | | DYNAMIC WAVE | | dynamicWave | | | switch | input | Activate dynamic wave routing | +| lfoptions | | INFLOW | | inflow | | | switch | input | Use inflow hydrographs | +| lfoptions | | SOIL | | simulatePF | | | switch | input | Calculate pF values from soil moisture | +| lfoptions | | LAKES | | simulateLakes | | | switch | input | Simulate unregulated lakes (kin. wave only) | +| lfoptions | | POLDERS | | simulatePolders | | | switch | input | Simulate polders (dyn. wave only) | +| lfoptions | | RESERVOIRS | | simulateReservoirs | | | switch | input | Simulate retention and hydropower reservoirs (kin. wave only) | +| lfoptions | | WATER LEVELS | | simulateWaterLevels | | | switch | input | Activate computation of water level maps / time series (does not affect routing) | +| lfoptions | | LANDUSE CHANGE | | TransientLandUseChange | | | switch | input | Activate reading of time changing land use description | +| lfoptions | | WATER ABSTRACTION | | TransientWaterDemandChange | | | switch | input | Activate reading of time changing water demand | +| lfoptions | | WATER ABSTRACTION | | useWaterDemandAveYear | | | switch | input | Use "average" year for water demand and loop it over years | +| lfoptions | | TRANSMISSION LOSS | | TransLoss | | | switch | input | Activate transmission loss | +| lfoptions | | DOUBLE KINEMATIC WAVE | | SplitRouting | | | switch | input | Activate double kinematic wave routing | +| lfoptions | | WATER ABSTRACTION | | wateruse | | | switch | input | Activate water use computation | +| lfoptions | | GROUNDWATER | | groundwaterSmooth | | | switch | input | Activate smoothing for groundwater to correct error by using windowtotal, based on groundwater bodies and catchments | +| lfoptions | | WATER ABSTRACTION | | wateruseRegion | | | switch | input | Use water regions in water use module | +| lfoptions | | IRRIGATION | | drainedIrrigation | | | switch | input | Use map of drainage systems to determine return flow (if drained, all percolation to channel within day; if not, all normal soil processes) | +| lfoptions | | IRRIGATION | | riceIrrigation | | | switch | input | Activate computation for paddy rice irrigation and abstraction | +| lfoptions | | EVAPO | | openwaterevapo | | | switch | input | Compute evaporation from open water | +| lfoptions | | EVAPO | | varfractionwater | | | switch | input | Compute the fraction of pixel that is open water | +| lfoptions | | INDICATOR | | indicator | | | switch | input | Activate computation of indicators (such as WEI, e-flow, etc) | +| lfoptions | | SETTINGS | | MonteCarlo | | | switch | input | Activate MonteCarlo simulation | +| lfoptions | | SETTINGS | | EnKF | | | switch | input | Activate EnKF simulation | +| lfoptions | | SETTINGS | | InitLisflood | | | switch | input | Run LISFLOOD initialization run | +| lfoptions | | SETTINGS | | InitLisfloodwithoutSplit | | | switch | input | Run LISFLOOD initialization run to compute Lzavin.map and skip completely the routing component | +| lfoptions | | IO | | readNetcdfStack | | | switch | input | Read meteorological data in NetCDF format (Precip, Tavg, ET0, E0,ES0) | +| lfoptions | | IO | | writeNetcdfStack | | | switch | input | Write NetCDF stacks for output files (the pr.nc is read to get the metadata like projection) | +| lfoptions | | IO | | writeNetcdf | | | switch | input | Write NetCDF files for END files (single netcdf) | +| lfoptions | | DISCHARGE | | repDischargeTs | | | switch rep tss | input | Report discharge time series at gauges | +| lfoptions | | LOG | | repInternalCom | | | switch rep tss | input | Report internal number of sub step for soil, channel routing, water use | +| lfoptions | | LOG | | repMBTs | | | switch rep tss | input | Report timeseries of absolute cumulative mass balance error | +| lfoptions | | STATE | | repStateSites | | | switch rep tss | input | Report state variables at sites | +| lfoptions | | STATE | | repRateSites | | | switch rep tss | input | Report state variables rates at sites | +| lfoptions | | STATE | | repStateUpsGauges | | | switch rep tss | input | Report timeseries of model variables, averaged over contributing area of each gauging station | +| lfoptions | | STATE | | repRateUpsGauges | | | switch rep tss | input | Report timeseries of model rate variables, averaged over contributing area of each gauging station | +| lfoptions | | METEO | | repMeteoUpsGauges | | | switch rep tss | input | Report timeseries of meteo input data | +| lfoptions | | INFLOW | | repLZAvInflowSites | | | switch rep tss | input | Report time serie of average percolation rate from upper to lower groundwater zone at sites | +| lfoptions | | INFLOW | | repLZAvInflowUpsGauges | | | switch rep tss | input | Report time serie of average percolation rate from upper to lower groundwater zone at gauges | +| lfoptions | | WATER ABSTRACTION | | repwateruseGauges | | | switch rep tss | input | Report water use ts at gauges | +| lfoptions | | WATER ABSTRACTION | | repwateruseSites | | | switch rep tss | input | Report water use ts at sistes | +| lfoptions | | WATER LEVELS | | repWaterLevelTs | | | switch rep tss | input | Report water level ts | +| lfoptions | | SOIL | | repPFUpsGauges | | | switch rep tss | input | Report PF ts at gauges | +| lfoptions | | SOIL | | repPFSites | | | switch rep tss | input | Report PF ts at sistes | +| lfoptions | | LAKES | | repsimulateLakes | | | switch rep tss | input | Report time series of lakes | +| lfoptions | | RESERVOIRS | | repsimulateReservoirs | | | switch rep tss | input | Report time series of reservoirs | +| lfoptions | | POLDERS | | repsimulatePolders | | | switch rep tss | input | Report time series of polders | +| lfoptions | | LOG | | repBal1 | | | switch rep tss | input | Report water balance TS | +| lfoptions | | STATE | | repStateMaps | | | switch rep maps | input | Report maps of model state variables (as defined by "ReportSteps" variable) | +| lfoptions | | STATE | | repEndMaps | | | switch rep maps | input | Report maps of model state variables (at last time step) | +| lfoptions | | METEO | | repPrecipitationMaps | | | switch rep maps | input | Report precipitation | +| lfoptions | | METEO | | repTavgMaps | | | switch rep maps | input | Report average temperature maps | +| lfoptions | | EVAPO | | repETRefMaps | | | switch rep maps | input | Report reference evapo-transpiration | +| lfoptions | | EVAPO | | repESRefMaps | | | switch rep maps | input | Report reference soil evaporation | +| lfoptions | | EVAPO | | repEWRefMaps | | | switch rep maps | input | Report reference evaporation of intercepted water | +| lfoptions | | DISCHARGE | | repAverageDis | | | switch rep maps | input | Report average discharge | +| lfoptions | | ROUTING | | repChanCrossSectionMaps | | | switch rep maps | input | Report total cross-section area for channels | +| lfoptions | | INTERCEPTION | | repCumInterCeptionMaps | | | switch rep maps | input | Report cumulative interception | +| lfoptions | | DISCHARGE | | repDischargeMaps | | | switch rep maps | input | Report maps of discharge (for each time step) | +| lfoptions | | METEO | | repDSLRMaps | | | switch rep maps | input | Report maps with number of days since the last rainfall event | +| lfoptions | | EVAPO | | repESActMaps | | | switch rep maps | input | Report actual soil evaporation | +| lfoptions | | EVAPO | | repEWIntMaps | | | switch rep maps | input | Report evaporation of intercepted water | +| lfoptions | | SNOW | | repFrostIndexMaps | | | switch rep maps | input | Report frost index maps | +| lfoptions | | GROUNDWATER | | repGwLossMaps | | | switch rep maps | input | Report groundwater loss maps | +| lfoptions | | GROUNDWATER | | repGwPercUZLZMaps | | | switch rep maps | input | Report maps of percolation from upper to lower ground water zone (for each time step) | +| lfoptions | | INFILTRATION | | repInfiltrationMaps | | | switch rep maps | input | Report infiltration maps | +| lfoptions | | INTERCEPTION | | repInterceptionMaps | | | switch rep maps | input | Report interception maps | +| lfoptions | | LEAF | | repLeafDrainageMaps | | | switch rep maps | input | Report leaf drainage maps | +| lfoptions | | GROUNDWATER | | repLZAvInflowMap | | | switch rep maps | input | Report lower groundwater zone inflow maps | +| lfoptions | | GROUNDWATER | | repLZMaps | | | switch rep maps | input | Report maps of lower groundwater zone storage (for each time step) | +| lfoptions | | GROUNDWATER | | repLZOutflowMaps | | | switch rep maps | input | Report lower groundwater zone outflow maps | +| lfoptions | | PERCOLATION | | repPercolationMaps | | | switch rep maps | input | Report percolation maps | +| lfoptions | | SOIL | | repPFMaps | | | switch rep maps | input | Report pF and vegetation stress due to low soil moisture | +| lfoptions | | SOIL | | repPFForestMaps | | | switch rep maps | input | Report pF and vegetation stress due to low soil moisture for forest fraction | +| lfoptions | | SOIL | | repPrefFlowMaps | | | switch rep maps | input | Report preferential flow (rapid bypass soil matrix) | +| lfoptions | | METEO | | repRainMaps | | | switch rep maps | input | Report rain excluding snow | +| lfoptions | | GROUNDWATER | | repSeepSubToGWMaps | | | switch rep maps | input | Report flux between sub soil and GW | +| lfoptions | | SNOW | | repSnowCoverMaps | | | switch rep maps | input | Report maps of snow cover (for each time step) | +| lfoptions | | SNOW | | repSnowMaps | | | switch rep maps | input | Report maps of snow (for each time step) | +| lfoptions | | SNOW | | repSnowMeltMaps | | | switch rep maps | input | Report maps of snowmelt (for each time step) | +| lfoptions | | SURFACE | | repSurfaceRunoffMaps | | | switch rep maps | input | Report maps of surface runoff (for each time step) | +| lfoptions | | TRANSPIRATION | | repTaMaps | | | switch rep maps | input | Report transpiration maps | +| lfoptions | | SOIL | | repThetaMaps | | | switch rep maps | input | Reporting of *individual* model state variables as maps THETA | +| lfoptions | | SOIL | | repThetaForestMaps | | | switch rep maps | input | Reporting of *individual* model state variables as maps THETA FOREST | +| lfoptions | | SOIL | | repThetaIrrigationMaps | | | switch rep maps | input | Report irrigation mapsrE | +| lfoptions | | SOIL | | repTotalRunoffMaps | | | switch rep maps | input | Report total runoff | +| lfoptions | | GROUNDWATER | | repUZMaps | | | switch rep maps | input | Report maps of upper groundwater zone storage (for each time step) | +| lfoptions | | GROUNDWATER | | repUZOutflowMaps | | | switch rep maps | input | Report maps for upper groundwater zone outflow | +| lfoptions | | ROUTING | | repWaterDepthMaps | | | switch rep maps | input | Report water depth on soil surface | +| lfoptions | | ROUTING | | repWaterLevelMaps | | | switch rep maps | input | Report water level in channels | +| lfoptions | | EVAPO | | ETActMaps | | | switch rep maps | input | Report actual evapo-transpiration | +| lfoptions | | ROUTING | | repFastRunoffMaps | | | switch rep maps | input | Report fast runoff = surface + UZ | +| lfoptions | | WATER STRESS | | repRWS | | | switch rep maps | input | Report soil transpiration reduction factor RWP | +| lfoptions | | WATER STRESS | | repStressDays | | | switch rep maps | input | Report soil transpiration reduction factor RWP for forest | +| lfoptions | | SOIL | | repPF1Maps | | | switch rep maps | input | Report PF1 maps | +| lfoptions | | SOIL | | repPF2Maps | | | switch rep maps | input | Report PF2 maps | +| lfoptions | | WATER ABSTRACTION | | repTotalAbs | | | switch rep maps | input | Report total water abstraction | +| lfoptions | | WATER ABSTRACTION | | repTotalWUse | | | switch rep maps | input | Report total water use | +| lfoptions | | INDICATOR | | repWIndex | | | switch rep maps | input | Report indexes and indicators | +| lfuser | AREA AND OUTLETS | SETTINGS | | PathRoot | /perm/ma/ma9/xdom/data/staticData/lisflood | /perm/ma/ma9/xdom/data/staticData/lisflood | path | input | Root directory | +| lfuser | AREA AND OUTLETS | SETTINGS | | MaskMap | /perm/ma/ma9/xdom/data/staticData/lisflood/area | /perm/ma/ma9/xdom/data/staticData/lisflood/area | map | input | Clone map used to set computation area for Lisflood model It can be 5 values separated by a blank space: col row cellsize xupleft yupleft (3600 1500 0.1 -180 90 -> World) or a map in pcraster format or netcdf If a map is used, information are read from the map. | +| lfuser | AREA AND OUTLETS | SETTINGS | | Gauges | $(PathMaps)/outlets.map | $(PathMaps)/outlets.map | map | input | Nominal map with gauge locations (i.e cells for which simulated discharge is written to file(1,2,3 etc) lat lon (lat2 lon2 ...) or pcraster maps or netcdf maps | +| lfuser | AREA AND OUTLETS | SETTINGS | | netCDFtemplate | $(PathMaps)/elvstd.nc | $(PathMaps)/elvstd.nc | map | input | netcdf template used to copy metadata information for writing netcdf $(PathEvapo)/$(PrefixE0) | +| lfuser | TIMESTEP RELATED PARAMETERS | SETTINGS | | CalendarDayStart | 1/2/1990 6:00 | 1/2/2015 6:00 | date | input | Reference Calendar day of the model. It is used inside LISFLOOD code as the reference date for time step id numbers. It MUST be <= first simulation start date. It MUST be a date as string, see code
Toggle
+ +
+
+```text
+
+(lisflood) [master]user@Enki:~/projects/lisflood-code $ pytest tests/
+================================ test session starts ================================
+platform linux -- Python 3.7.8, pytest-5.2.1, py-1.8.0, pluggy-0.13.0
+cachedir: .pytest_cache
+rootdir: /home/user/projects/lisflood-code, inifile: pytest.ini
+plugins: env-0.6.2, cov-2.8.1, mock-2.0.0
+
+tests/test_dates_steps.py::TestStepsDates::test_dates_steps_daily PASSED [ 2%]
+tests/test_dates_steps.py::TestStepsDates::test_dates_steps_6h PASSED [ 4%]
+tests/test_options.py::TestOptions::test_basic PASSED [ 6%]
+tests/test_options.py::TestOptions::test_split_routing_only PASSED [ 8%]
+tests/test_options.py::TestOptions::test_reservoirs_only PASSED [ 11%]
+tests/test_options.py::TestOptions::test_lakes_only PASSED [ 13%]
+tests/test_options.py::TestOptions::test_rice_only PASSED [ 15%]
+tests/test_options.py::TestOptions::test_pf_only PASSED [ 17%]
+tests/test_options.py::TestOptions::test_waterabstraction_only PASSED [ 20%]
+tests/test_options.py::TestWrongTimestepInit::test_raisexc PASSED [ 22%]
+tests/test_reported_maps.py::TestReportedMaps::test_prerun PASSED [ 24%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_dischargemaps PASSED [ 26%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_dischargemaps_not_called PASSED [ 28%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_lakes PASSED [ 31%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_lakes_not_called PASSED [ 33%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_reservoirs PASSED [ 35%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_reservoirs_not_called PASSED [ 37%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_snowmaps PASSED [ 40%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_snowmaps_not_called PASSED [ 42%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_pfmaps PASSED [ 44%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_pfmaps_not_called PASSED [ 46%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_lzmaps PASSED [ 48%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_lzmaps_not_called PASSED [ 51%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_uzmaps PASSED [ 53%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_uzmaps_not_called PASSED [ 55%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_gwpercuzlzmaps PASSED [ 57%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_gwpercuzlzmaps_not_called PASSED [ 60%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_totalabs PASSED [ 62%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_totalabs_not_called PASSED [ 64%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_totalwuse PASSED [ 66%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_totalwuse_not_called PASSED [ 68%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_windex PASSED [ 71%]
+tests/test_reported_maps.py::TestReportedMaps::test_rep_windex_not_called PASSED [ 73%]
+tests/test_reported_tss.py::TestReportedTSS::test_rep_dischargetss PASSED [ 75%]
+tests/test_reported_tss.py::TestReportedTSS::test_rep_dischargetss_not_called PASSED [ 77%]
+tests/test_reported_tss.py::TestReportedTSS::test_rep_stateupgaugestss PASSED [ 80%]
+tests/test_reported_tss.py::TestReportedTSS::test_rep_stateupgaugestss_not_called PASSED [ 82%]
+tests/test_reported_tss.py::TestReportedTSS::test_rep_rateupgaugestss PASSED [ 84%]
+tests/test_reported_tss.py::TestReportedTSS::test_rep_rateupgaugestss_not_called PASSED [ 86%]
+tests/test_reported_tss.py::TestReportedTSS::test_rep_meteoupgaugestss PASSED [ 88%]
+tests/test_reported_tss.py::TestReportedTSS::test_rep_meteoupgaugestss_not_called PASSED [ 91%]
+tests/test_state_end_maps.py::TestRepMaps::test_no_reported PASSED [ 93%]
+tests/test_state_end_maps.py::TestRepMaps::test_end_reported PASSED [ 95%]
+tests/test_state_end_maps.py::TestRepMaps::test_state_reported PASSED [ 97%]
+tests/test_state_end_maps.py::TestRepMaps::test_end_state_reported PASSED [100%]
+
+----------- coverage: platform linux, python 3.7.8-final-0 -----------
+Name Stmts Miss Cover
+----------------------------------------------------------------------------------
+src/lisflood/Lisflood_EnKF.py 21 12 43%
+src/lisflood/Lisflood_dynamic.py 89 16 82%
+src/lisflood/Lisflood_initial.py 108 8 93%
+src/lisflood/Lisflood_monteCarlo.py 11 4 64%
+src/lisflood/__init__.py 13 1 92%
+src/lisflood/global_modules/__init__.py 0 0 100%
+src/lisflood/global_modules/add1.py 634 261 59%
+src/lisflood/global_modules/checkers.py 36 21 42%
+src/lisflood/global_modules/decorators.py 16 9 44%
+src/lisflood/global_modules/default_options.py 4 0 100%
+src/lisflood/global_modules/errors.py 26 7 73%
+src/lisflood/global_modules/output.py 190 59 69%
+src/lisflood/global_modules/settings.py 395 64 84%
+src/lisflood/global_modules/stateVar.py 93 79 15%
+src/lisflood/global_modules/zusatz.py 237 172 27%
+src/lisflood/hydrological_modules/__init__.py 42 31 26%
+src/lisflood/hydrological_modules/evapowater.py 72 24 67%
+src/lisflood/hydrological_modules/frost.py 18 0 100%
+src/lisflood/hydrological_modules/groundwater.py 54 3 94%
+src/lisflood/hydrological_modules/indicatorcalc.py 106 4 96%
+src/lisflood/hydrological_modules/inflow.py 58 28 52%
+src/lisflood/hydrological_modules/kinematic_wave_parallel.py 105 9 91%
+src/lisflood/hydrological_modules/lakes.py 120 14 88%
+src/lisflood/hydrological_modules/landusechange.py 28 7 75%
+src/lisflood/hydrological_modules/leafarea.py 35 0 100%
+src/lisflood/hydrological_modules/miscInitial.py 94 10 89%
+src/lisflood/hydrological_modules/opensealed.py 20 0 100%
+src/lisflood/hydrological_modules/polder.py 25 6 76%
+src/lisflood/hydrological_modules/readmeteo.py 30 5 83%
+src/lisflood/hydrological_modules/reservoir.py 128 5 96%
+src/lisflood/hydrological_modules/riceirrigation.py 49 0 100%
+src/lisflood/hydrological_modules/routing.py 178 8 96%
+src/lisflood/hydrological_modules/snow.py 63 0 100%
+src/lisflood/hydrological_modules/soil.py 177 0 100%
+src/lisflood/hydrological_modules/soilloop.py 172 3 98%
+src/lisflood/hydrological_modules/structures.py 15 0 100%
+src/lisflood/hydrological_modules/surface_routing.py 64 0 100%
+src/lisflood/hydrological_modules/transmission.py 29 11 62%
+src/lisflood/hydrological_modules/waterabstraction.py 230 16 93%
+src/lisflood/hydrological_modules/waterbalance.py 77 62 19%
+src/lisflood/hydrological_modules/waterlevel.py 27 9 67%
+src/lisflood/hydrological_modules/wateruse.py 8 3 62%
+src/lisflood/main.py 88 37 58%
+----------------------------------------------------------------------------------
+TOTAL 3985 1008 75%
+
+
+============ 45 passed, 10 deselected in 90.49s (0:01:30) ============
+
+```
+
+
+" | remove: "
" %} +{% else %} + {% assign title = post.title %} +{% endif %} + +
+
+ {% if include.type == "grid" and teaser %}
+
+ {% endif %}
+
+
\ No newline at end of file
diff --git a/docs/_includes/author-profile-custom-links.html b/docs/_includes/author-profile-custom-links.html
new file mode 100644
index 00000000..cf86521a
--- /dev/null
+++ b/docs/_includes/author-profile-custom-links.html
@@ -0,0 +1,7 @@
+
\ No newline at end of file
diff --git a/docs/_includes/author-profile.html b/docs/_includes/author-profile.html
new file mode 100644
index 00000000..bd560f71
--- /dev/null
+++ b/docs/_includes/author-profile.html
@@ -0,0 +1,263 @@
+{% assign author = page.author | default: page.authors[0] | default: site.author %}
+{% assign author = site.data.authors[author] | default: author %}
+
+
+
+ {% if author.avatar %}
+
diff --git a/docs/_includes/base_path b/docs/_includes/base_path
new file mode 100644
index 00000000..36826c4f
--- /dev/null
+++ b/docs/_includes/base_path
@@ -0,0 +1,5 @@
+{% if site.url %}
+ {% assign base_path = site.url | append: site.baseurl %}
+{% else %}
+ {% assign base_path = site.github.url %}
+{% endif %}
\ No newline at end of file
diff --git a/docs/_includes/breadcrumbs.html b/docs/_includes/breadcrumbs.html
new file mode 100644
index 00000000..82fe2cc4
--- /dev/null
+++ b/docs/_includes/breadcrumbs.html
@@ -0,0 +1,39 @@
+{% case site.category_archive.type %}
+ {% when "liquid" %}
+ {% assign path_type = "#" %}
+ {% when "jekyll-archives" %}
+ {% assign path_type = nil %}
+{% endcase %}
+
+{% if page.collection != 'posts' %}
+ {% assign path_type = nil %}
+ {% assign crumb_path = '/' %}
+{% else %}
+ {% assign crumb_path = site.category_archive.path %}
+{% endif %}
+
+
diff --git a/docs/_includes/browser-upgrade.html b/docs/_includes/browser-upgrade.html
new file mode 100644
index 00000000..ec6ad0ac
--- /dev/null
+++ b/docs/_includes/browser-upgrade.html
@@ -0,0 +1,3 @@
+
diff --git a/docs/_includes/category-list.html b/docs/_includes/category-list.html
new file mode 100644
index 00000000..7cffdb76
--- /dev/null
+++ b/docs/_includes/category-list.html
@@ -0,0 +1,26 @@
+{% case site.category_archive.type %}
+ {% when "liquid" %}
+ {% assign path_type = "#" %}
+ {% when "jekyll-archives" %}
+ {% assign path_type = nil %}
+{% endcase %}
+
+{% if site.category_archive.path %}
+ {% comment %}
+
+
+ {% endcomment %}
+ {% capture page_categories %}{% for category in page.categories %}{{ category | downcase }}#{{ category }}{% unless forloop.last %},{% endunless %}{% endfor %}{% endcapture %}
+ {% assign category_hashes = page_categories | split: ',' | sort %}
+
+
+ {% if author.avatar contains "://" %}
+ {% assign author_src = author.avatar %}
+ {% else %}
+ {% assign author_src = author.avatar | relative_url %}
+ {% endif %}
+
+ {% if author.home %}
+ {% if author.home contains "://" %}
+ {% assign author_link = author.home %}
+ {% else %}
+ {% assign author_link = author.home | relative_url %}
+ {% endif %}
+
+ 
+
+ {% else %}
+
+ {% endif %}
+
+ {% endif %}
+
+
+
+
++ {{ site.data.ui-text[site.locale].categories_label | default: "Categories:" }} + + {% for hash in category_hashes %} + {% assign keyValue = hash | split: '#' %} + {% capture category_word %}{{ keyValue[1] | strip_newlines }}{% endcapture %} + {{ category_word }}{% unless forloop.last %}, {% endunless %} + {% endfor %} + +
+{% endif %} \ No newline at end of file diff --git a/docs/_includes/comment.html b/docs/_includes/comment.html new file mode 100644 index 00000000..7b33f46d --- /dev/null +++ b/docs/_includes/comment.html @@ -0,0 +1,22 @@ +
+ 
+
+
+
+
++ {% unless include.url == blank %} + {{ include.name }} + {% else %} + {{ include.name }} + {% endunless %} +
++ {% if include.date %} + {% if include.index %}{% endif %} + + {% if include.index %}{% endif %} + {% endif %} +
+{{ include.message | markdownify }}
+
+ {% capture comments_label %}{{ site.data.ui-text[site.locale].comments_label | default: "Comments" }}{% endcapture %}
+ {% case site.comments.provider %}
+ {% when "discourse" %}
+ Loading Google+ Comments ...
+
+
+ -->
+ {% when "staticman_v2" %}
+
+ {% if site.repository and site.staticman.branch %}
+
+
+ {% when "staticman" %}
+
+ {% if site.repository and site.staticman.branch %}
+
+
+ {% when "custom" %}
+
+ {% endcase %}
+
\ No newline at end of file
diff --git a/docs/_includes/documents-collection.html b/docs/_includes/documents-collection.html
new file mode 100644
index 00000000..13b4006e
--- /dev/null
+++ b/docs/_includes/documents-collection.html
@@ -0,0 +1,19 @@
+{% assign entries = site[include.collection] %}
+
+{% if include.sort_by == 'title' %}
+ {% if include.sort_order == 'reverse' %}
+ {% assign entries = entries | sort: 'title' | reverse %}
+ {% else %}
+ {% assign entries = entries | sort: 'title' %}
+ {% endif %}
+{% elsif include.sort_by == 'date' %}
+ {% if include.sort_order == 'reverse' %}
+ {% assign entries = entries | sort: 'date' | reverse %}
+ {% else %}
+ {% assign entries = entries | sort: 'date' %}
+ {% endif %}
+{% endif %}
+
+{%- for post in entries -%}
+ {% include archive-single.html %}
+{%- endfor -%}
diff --git a/docs/_includes/feature_row b/docs/_includes/feature_row
new file mode 100644
index 00000000..89dfc1b4
--- /dev/null
+++ b/docs/_includes/feature_row
@@ -0,0 +1,53 @@
+{% if include.id %}
+ {% assign feature_row = page[include.id] %}
+{% else %}
+ {% assign feature_row = page.feature_row %}
+{% endif %}
+
+{{ comments_label }}
+ + {% when "disqus" %} +{{ comments_label }}
+ + {% when "facebook" %} +{{ comments_label }}
+ + {% when "google-plus" %} +{{ comments_label }}
+
+ {% if site.data.comments[page.slug] %}
+
+
+
+
+ {{ site.data.ui-text[site.locale].comments_title | default: "Comments" }}
+ {% assign comments = site.data.comments[page.slug] | sort %} + + {% for comment in comments %} + {% assign email = comment[1].email %} + {% assign name = comment[1].name %} + {% assign url = comment[1].url %} + {% assign date = comment[1].date %} + {% assign message = comment[1].message %} + {% include comment.html index=forloop.index email=email name=name url=url date=date message=message %} + {% endfor %} + {% endif %} +
+
+
+ {% if site.reCaptcha.siteKey %}{% endif %}
+ {% endif %}
+ {{ site.data.ui-text[site.locale].comments_label | default: "Leave a Comment" }}
+{{ site.data.ui-text[site.locale].comment_form_info | default: "Your email address will not be published. Required fields are marked" }} *
+ +
+ {% if site.data.comments[page.slug] %}
+
+
+
+
+ {{ site.data.ui-text[site.locale].comments_title | default: "Comments" }}
+ {% assign comments = site.data.comments[page.slug] | sort %} + + {% for comment in comments %} + {% assign email = comment[1].email %} + {% assign name = comment[1].name %} + {% assign url = comment[1].url %} + {% assign date = comment[1].date %} + {% assign message = comment[1].message %} + {% include comment.html index=forloop.index email=email name=name url=url date=date message=message %} + {% endfor %} + {% endif %} +
+
+
+ {% endif %}
+ {{ site.data.ui-text[site.locale].comments_label | default: "Leave a Comment" }}
+{{ site.data.ui-text[site.locale].comment_form_info | default: "Your email address will not be published. Required fields are marked" }} *
+ +
+
+ {% for f in feature_row %}
+
+ {% if f.url contains "://" %}
+ {% capture f_url %}{{ f.url }}{% endcapture %}
+ {% else %}
+ {% capture f_url %}{{ f.url | relative_url }}{% endcapture %}
+ {% endif %}
+
+
\ No newline at end of file
diff --git a/docs/_includes/figure b/docs/_includes/figure
new file mode 100644
index 00000000..3fb15c0f
--- /dev/null
+++ b/docs/_includes/figure
@@ -0,0 +1,12 @@
+
+
+ {% endfor %}
+
+
+ {% if f.image_path %}
+
+ {% endif %}
+
+
+
+ {% if f.title %}
+
+ {{ f.title }}
+ {% endif %} + + {% if f.excerpt %} +
+ {{ f.excerpt | markdownify }}
+
+ {% endif %}
+
+ {% if f.url %}
+ {{ f.btn_label | default: site.data.ui-text[site.locale].more_label | default: "Learn More" }}
+ {% endif %} +" | remove: "
" }}" | remove: "
" }}
+
diff --git a/docs/_includes/nav_list b/docs/_includes/nav_list
new file mode 100644
index 00000000..b1d06c30
--- /dev/null
+++ b/docs/_includes/nav_list
@@ -0,0 +1,47 @@
+{% assign navigation = site.data.navigation[include.nav] %}
+
+
\ No newline at end of file
diff --git a/docs/_includes/page__hero.html b/docs/_includes/page__hero.html
new file mode 100644
index 00000000..61d4cf41
--- /dev/null
+++ b/docs/_includes/page__hero.html
@@ -0,0 +1,61 @@
+{% if page.header.image contains "://" %}
+ {% capture img_path %}{{ page.header.image }}{% endcapture %}
+{% else %}
+ {% capture img_path %}{{ page.header.image | relative_url }}{% endcapture %}
+{% endif %}
+
+{% if page.header.cta_url contains "://" %}
+ {% capture cta_path %}{{ page.header.cta_url }}{% endcapture %}
+{% else %}
+ {% capture cta_path %}{{ page.header.cta_url | relative_url }}{% endcapture %}
+{% endif %}
+
+{% if page.header.overlay_image contains "://" %}
+ {% capture overlay_img_path %}{{ page.header.overlay_image }}{% endcapture %}
+{% elsif page.header.overlay_image %}
+ {% capture overlay_img_path %}{{ page.header.overlay_image | relative_url }}{% endcapture %}
+{% endif %}
+
+{% if page.header.overlay_filter contains "rgba" %}
+ {% capture overlay_filter %}{{ page.header.overlay_filter }}{% endcapture %}
+{% elsif page.header.overlay_filter %}
+ {% capture overlay_filter %}rgba(0, 0, 0, {{ page.header.overlay_filter }}){% endcapture %}
+{% endif %}
+
+{% if page.header.image_description %}
+ {% assign image_description = page.header.image_description %}
+{% else %}
+ {% assign image_description = page.title %}
+{% endif %}
+
+{% assign image_description = image_description | markdownify | strip_html | strip_newlines | escape_once %}
+
+{{ site.title }}
+
+
+
+
+
+ {% if page.header.overlay_color or page.header.overlay_image %}
+ 
+ {% endif %}
+ {% if page.header.caption %}
+ {{ page.header.caption | markdownify | remove: "
diff --git a/docs/_includes/page__hero_video.html b/docs/_includes/page__hero_video.html
new file mode 100644
index 00000000..8586a95a
--- /dev/null
+++ b/docs/_includes/page__hero_video.html
@@ -0,0 +1,4 @@
+{% capture video_id %}{{ page.header.video.id }}{% endcapture %}
+{% capture video_provider %}{{ page.header.video.provider }}{% endcapture %}
+
+{% include video id=video_id provider=video_provider %}
diff --git a/docs/_includes/page__taxonomy.html b/docs/_includes/page__taxonomy.html
new file mode 100644
index 00000000..75c76c81
--- /dev/null
+++ b/docs/_includes/page__taxonomy.html
@@ -0,0 +1,7 @@
+{% if site.tag_archive.type and page.tags[0] %}
+ {% include tag-list.html %}
+{% endif %}
+
+{% if site.category_archive.type and page.categories[0] %}
+ {% include category-list.html %}
+{% endif %}
\ No newline at end of file
diff --git a/docs/_includes/paginator.html b/docs/_includes/paginator.html
new file mode 100644
index 00000000..592a2cfc
--- /dev/null
+++ b/docs/_includes/paginator.html
@@ -0,0 +1,69 @@
+{% if paginator.total_pages > 1 %}
+
+{% endif %}
diff --git a/docs/_includes/post_pagination.html b/docs/_includes/post_pagination.html
new file mode 100644
index 00000000..a93c6279
--- /dev/null
+++ b/docs/_includes/post_pagination.html
@@ -0,0 +1,14 @@
+{% if page.previous or page.next %}
+
+{% endif %}
\ No newline at end of file
diff --git a/docs/_includes/posts-category.html b/docs/_includes/posts-category.html
new file mode 100644
index 00000000..98be3e96
--- /dev/null
+++ b/docs/_includes/posts-category.html
@@ -0,0 +1,3 @@
+{%- for post in site.categories[include.taxonomy] -%}
+ {% include archive-single.html %}
+{%- endfor -%}
diff --git a/docs/_includes/posts-tag.html b/docs/_includes/posts-tag.html
new file mode 100644
index 00000000..180a2f31
--- /dev/null
+++ b/docs/_includes/posts-tag.html
@@ -0,0 +1,3 @@
+{%- for post in site.tags[include.taxonomy] -%}
+ {% include archive-single.html %}
+{%- endfor -%}
diff --git a/docs/_includes/read-time.html b/docs/_includes/read-time.html
new file mode 100644
index 00000000..df88d529
--- /dev/null
+++ b/docs/_includes/read-time.html
@@ -0,0 +1,15 @@
+{% assign words_per_minute = site.words_per_minute | default: 200 %}
+
+{% if post.read_time %}
+ {% assign words = post.content | strip_html | number_of_words %}
+{% elsif page.read_time %}
+ {% assign words = page.content | strip_html | number_of_words %}
+{% endif %}
+
+{% if words < words_per_minute %}
+ {{ site.data.ui-text[site.locale].less_than | default: "less than" }} 1 {{ site.data.ui-text[site.locale].minute_read | default: "minute read" }}
+{% elsif words == words_per_minute %}
+ 1 {{ site.data.ui-text[site.locale].minute_read | default: "minute read" }}
+{% else %}
+ {{ words | divided_by:words_per_minute }} {{ site.data.ui-text[site.locale].minute_read | default: "minute read" }}
+{% endif %}
\ No newline at end of file
diff --git a/docs/_includes/scripts.html b/docs/_includes/scripts.html
new file mode 100644
index 00000000..144c38cb
--- /dev/null
+++ b/docs/_includes/scripts.html
@@ -0,0 +1,28 @@
+{% if site.footer_scripts %}
+ {% for script in site.footer_scripts %}
+ {% if script contains "://" %}
+ {% capture script_path %}{{ script }}{% endcapture %}
+ {% else %}
+ {% capture script_path %}{{ script | relative_url }}{% endcapture %}
+ {% endif %}
+
+ {% endfor %}
+{% else %}
+
+
+{% endif %}
+
+{% if site.search == true or page.layout == "search" %}
+ {%- assign search_provider = site.search_provider | default: "lunr" -%}
+ {%- case search_provider -%}
+ {%- when "lunr" -%}
+ {% include search/lunr-search-scripts.html %}
+ {%- when "google" -%}
+ {% include search/google-search-scripts.html %}
+ {%- when "algolia" -%}
+ {% include search/algolia-search-scripts.html %}
+ {%- endcase -%}
+{% endif %}
+
+{% include analytics.html %}
+{% include /comments-providers/scripts.html %}
\ No newline at end of file
diff --git a/docs/_includes/search/algolia-search-scripts.html b/docs/_includes/search/algolia-search-scripts.html
new file mode 100644
index 00000000..1ec021df
--- /dev/null
+++ b/docs/_includes/search/algolia-search-scripts.html
@@ -0,0 +1,54 @@
+
+
+
+
+
+
diff --git a/docs/_includes/search/google-search-scripts.html b/docs/_includes/search/google-search-scripts.html
new file mode 100644
index 00000000..4af7423b
--- /dev/null
+++ b/docs/_includes/search/google-search-scripts.html
@@ -0,0 +1,30 @@
+
\ No newline at end of file
diff --git a/docs/_includes/search/lunr-search-scripts.html b/docs/_includes/search/lunr-search-scripts.html
new file mode 100644
index 00000000..574c3900
--- /dev/null
+++ b/docs/_includes/search/lunr-search-scripts.html
@@ -0,0 +1,10 @@
+{% assign lang = site.locale | slice: 0,2 | default: "en" %}
+{% case lang %}
+{% when "gr" %}
+ {% assign lang = "gr" %}
+{% else %}
+ {% assign lang = "en" %}
+{% endcase %}
+
+
+
\ No newline at end of file
diff --git a/docs/_includes/search/search_form.html b/docs/_includes/search/search_form.html
new file mode 100644
index 00000000..329c30d1
--- /dev/null
+++ b/docs/_includes/search/search_form.html
@@ -0,0 +1,18 @@
+
+
+ {% else %}
+ + {% if paginator and site.paginate_show_page_num %} + {{ site.title }}{% unless paginator.page == 1 %} {{ site.data.ui-text[site.locale].page | default: "Page" }} {{ paginator.page }}{% endunless %} + {% else %} + {{ page.title | default: site.title | markdownify | remove: "
" | remove: "
" }} + {% endif %} + + {% if page.header.show_overlay_excerpt != false and page.excerpt %} +{{ page.excerpt | markdownify | remove: "
" | remove: "
" }} + {% endif %} + {% if site.read_time and page.read_time %} + + {% endif %} + {% if page.header.cta_url %} + + {% endif %} +" | remove: "
" }} + {% endif %} +
+{%- assign search_provider = site.search_provider | default: "lunr" -%}
+{%- case search_provider -%}
+ {%- when "lunr" -%}
+
+
+ {%- when "google" -%}
+
+
\ No newline at end of file
diff --git a/docs/_includes/seo.html b/docs/_includes/seo.html
new file mode 100644
index 00000000..2ac0b649
--- /dev/null
+++ b/docs/_includes/seo.html
@@ -0,0 +1,166 @@
+
+{%- if site.url -%}
+ {%- assign seo_url = site.url | append: site.baseurl -%}
+{%- endif -%}
+{%- assign seo_url = seo_url | default: site.github.url -%}
+
+{% if site.title_separator %}
+ {% assign title_separator = site.title_separator | default: '-' | replace: '|', '|' %}
+{% endif %}
+
+{%- if page.title -%}
+ {%- assign seo_title = page.title | append: " " | append: title_separator | append: " " | append: site.title -%}
+{%- endif -%}
+
+{%- if seo_title -%}
+ {%- assign seo_title = seo_title | markdownify | strip_html | strip_newlines | escape_once -%}
+{%- endif -%}
+
+{%- assign canonical_url = page.url | replace: "index.html", "" | absolute_url %}
+
+{%- assign seo_description = page.description | default: page.excerpt | default: site.description -%}
+{%- if seo_description -%}
+ {%- assign seo_description = seo_description | markdownify | strip_html | strip_newlines | escape_once -%}
+{%- endif -%}
+
+{%- assign author = page.author | default: page.authors[0] | default: site:author -%}
+{%- assign author = site.data.authors[author] | default: author -%}
+
+{%- if author.twitter -%}
+ {%- assign author_twitter = author.twitter | replace: "@", "" -%}
+{%- endif -%}
+
+{%- assign page_large_image = page.header.og_image | default: page.header.overlay_image | default: page.header.image -%}
+{%- unless page_large_image contains '://' -%}
+ {%- assign page_large_image = page_large_image | absolute_url -%}
+{%- endunless -%}
+{%- assign page_large_image = page_large_image | escape -%}
+
+{%- assign page_teaser_image = page.header.teaser | default: site.og_image -%}
+{%- unless page_teaser_image contains '://' -%}
+ {%- assign page_teaser_image = page_teaser_image | absolute_url -%}
+{%- endunless -%}
+{%- assign page_teaser_image = page_teaser_image | escape -%}
+
+{%- assign site_og_image = site.og_image -%}
+{%- unless site_og_image contains '://' -%}
+ {%- assign site_og_image = site_og_image | absolute_url -%}
+{%- endunless -%}
+{%- assign site_og_image = site_og_image | escape -%}
+
+{%- if page.date -%}
+ {%- assign og_type = "article" -%}
+{%- else -%}
+ {%- assign og_type = "website" -%}
+{%- endif -%}
+
+
+
+ {%- when "algolia" -%}
+
+
+{%- endcase -%}
+{{ site.data.ui-text[site.locale].share_on_label | default: "Share on" }}
+ {% endif %} + + Twitter + + Facebook + + Google+ + + LinkedIn ++ {{ site.data.ui-text[site.locale].tags_label | default: "Tags:" }} + + {% for hash in tag_hashes %} + {% assign keyValue = hash | split: '#' %} + {% capture tag_word %}{{ keyValue[1] | strip_newlines }}{% endcapture %} + {{ tag_word }}{% unless forloop.last %}, {% endunless %} + {% endfor %} + +
+{% endif %} \ No newline at end of file diff --git a/docs/_includes/toc b/docs/_includes/toc new file mode 100644 index 00000000..232d033c --- /dev/null +++ b/docs/_includes/toc @@ -0,0 +1,7 @@ + diff --git a/docs/_includes/toc.html b/docs/_includes/toc.html new file mode 100644 index 00000000..27023f71 --- /dev/null +++ b/docs/_includes/toc.html @@ -0,0 +1,75 @@ +{% capture tocWorkspace %} + {%- comment -%} + Version 1.0.2 + + "...like all things liquid - where there's a will, and ~36 hours to spare, there's usually a/some way" ~jaybe + + Usage: + {% include toc.html html=content sanitize=true class="inline_toc" id="my_toc" h_min=2 h_max=3 %} + + Parameters: + * html (string) - the HTML of compiled markdown generated by kramdown in Jekyll + + Optional Parameters: + * sanitize (bool) : false - when set to true, the headers will be stripped of any HTML in the TOC + * class (string) : '' - a CSS class assigned to the TOC + * id (string) : '' - an ID to assigned to the TOC + * h_min (int) : 1 - the minimum TOC header level to use; any header lower than this value will be ignored + * h_max (int) : 6 - the maximum TOC header level to use; any header greater than this value will be ignored + + Output: + An unordered list representing the table of contents of a markdown block. This snippet will only generate the table of contents and will NOT output the markdown given to it + {%- endcomment -%} + + {% capture my_toc %}{% endcapture %} + {% assign minHeader = include.h_min | default: 1 %} + {% assign maxHeader = include.h_max | default: 6 %} + {% assign nodes = include.html | split: '
+{% if video_provider == "vimeo" %}
+
+{% elsif video_provider == "youtube" %}
+
+{% endif %}
+
diff --git a/docs/_layouts/archive-taxonomy.html b/docs/_layouts/archive-taxonomy.html
new file mode 100644
index 00000000..6939122d
--- /dev/null
+++ b/docs/_layouts/archive-taxonomy.html
@@ -0,0 +1,15 @@
+---
+layout: default
+author_profile: false
+---
+
+
+ {% include sidebar.html %}
+
+
\ No newline at end of file
diff --git a/docs/_layouts/archive.html b/docs/_layouts/archive.html
new file mode 100644
index 00000000..08beb89a
--- /dev/null
+++ b/docs/_layouts/archive.html
@@ -0,0 +1,26 @@
+---
+layout: default
+---
+
+{% if page.header.overlay_color or page.header.overlay_image or page.header.image %}
+ {% include page__hero.html %}
+{% elsif page.header.video.id and page.header.video.provider %}
+ {% include page__hero_video.html %}
+{% endif %}
+
+{% if page.url != "/" and site.breadcrumbs %}
+ {% unless paginator %}
+ {% include breadcrumbs.html %}
+ {% endunless %}
+{% endif %}
+
+
+ {% include sidebar.html %}
+
+
\ No newline at end of file
diff --git a/docs/_layouts/categories.html b/docs/_layouts/categories.html
new file mode 100644
index 00000000..0c7521f3
--- /dev/null
+++ b/docs/_layouts/categories.html
@@ -0,0 +1,48 @@
+---
+layout: archive
+---
+
+{{ content }}
+
+
+ {% unless page.header.overlay_color or page.header.overlay_image %}
+
+{{ page.title }}
+ {% endunless %} + {{ content }} +-
+ {% assign categories_max = 0 %}
+ {% for category in site.categories %}
+ {% if category[1].size > categories_max %}
+ {% assign categories_max = category[1].size %}
+ {% endif %}
+ {% endfor %}
+ {% for i in (1..categories_max) reversed %}
+ {% for category in site.categories %}
+ {% if category[1].size == i %}
+
- + + {{ category[0] }} {{ i }} + + + {% endif %} + {% endfor %} + {% endfor %} +
{{ category[0] }}
+
+ {% for post in category.last %}
+ {% include archive-single.html type=page.entries_layout %}
+ {% endfor %}
+
+ {{ site.data.ui-text[site.locale].back_to_top | default: 'Back to Top' }} ↑
+
+ {% include posts-category.html taxonomy=page.taxonomy type=page.entries_layout %}
+
diff --git a/docs/_layouts/collection.html b/docs/_layouts/collection.html
new file mode 100644
index 00000000..3bcd916a
--- /dev/null
+++ b/docs/_layouts/collection.html
@@ -0,0 +1,9 @@
+---
+layout: archive
+---
+
+{{ content }}
+
+
+ {% include documents-collection.html collection=page.collection sort_by=page.sort_by sort_order=page.sort_order type=page.entries_layout %}
+
diff --git a/docs/_layouts/compress.html b/docs/_layouts/compress.html
new file mode 100644
index 00000000..550fa27b
--- /dev/null
+++ b/docs/_layouts/compress.html
@@ -0,0 +1,10 @@
+---
+# Jekyll layout that compresses HTML
+# v3.0.2
+# http://jch.penibelst.de/
+# © 2014–2015 Anatol Broder
+# MIT License
+---
+
+{% capture _LINE_FEED %}
+{% endcapture %}{% if site.compress_html.ignore.envs contains jekyll.environment %}{{ content }}{% else %}{% capture _content %}{{ content }}{% endcapture %}{% assign _profile = site.compress_html.profile %}{% if site.compress_html.endings == "all" %}{% assign _endings = "html head body li dt dd p rt rp optgroup option colgroup caption thead tbody tfoot tr td th" | split: " " %}{% else %}{% assign _endings = site.compress_html.endings %}{% endif %}{% for _element in _endings %}{% capture _end %}{% endcapture %}{% assign _content = _content | remove: _end %}{% endfor %}{% if _profile and _endings %}{% assign _profile_endings = _content | size | plus: 1 %}{% endif %}{% for _element in site.compress_html.startings %}{% capture _start %}<{{ _element }}>{% endcapture %}{% assign _content = _content | remove: _start %}{% endfor %}{% if _profile and site.compress_html.startings %}{% assign _profile_startings = _content | size | plus: 1 %}{% endif %}{% if site.compress_html.comments == "all" %}{% assign _comments = "" | split: " " %}{% else %}{% assign _comments = site.compress_html.comments %}{% endif %}{% if _comments.size == 2 %}{% capture _comment_befores %}.{{ _content }}{% endcapture %}{% assign _comment_befores = _comment_befores | split: _comments.first %}{% for _comment_before in _comment_befores %}{% if forloop.first %}{% continue %}{% endif %}{% capture _comment_outside %}{% if _carry %}{{ _comments.first }}{% endif %}{{ _comment_before }}{% endcapture %}{% capture _comment %}{% unless _carry %}{{ _comments.first }}{% endunless %}{{ _comment_outside | split: _comments.last | first }}{% if _comment_outside contains _comments.last %}{{ _comments.last }}{% assign _carry = false %}{% else %}{% assign _carry = true %}{% endif %}{% endcapture %}{% assign _content = _content | remove_first: _comment %}{% endfor %}{% if _profile %}{% assign _profile_comments = _content | size | plus: 1 %}{% endif %}{% endif %}{% assign _pre_befores = _content | split: "| Step | Bytes |
| raw | {{ content | size }}{% if _profile_endings %} |
| endings | {{ _profile_endings }}{% endif %}{% if _profile_startings %} |
| startings | {{ _profile_startings }}{% endif %}{% if _profile_comments %} |
| comments | {{ _profile_comments }}{% endif %}{% if _profile_collapse %} |
| collapse | {{ _profile_collapse }}{% endif %}{% if _profile_clippings %} |
| clippings | {{ _profile_clippings }}{% endif %} |
+ {{ content }}
+
+
+ {% if site.search == true %}
+
+ {% include search/search_form.html %}
+
+ {% endif %}
+
+
+
+ {% include scripts.html %}
+
+
+
\ No newline at end of file
diff --git a/docs/_layouts/home.html b/docs/_layouts/home.html
new file mode 100644
index 00000000..bcce92ab
--- /dev/null
+++ b/docs/_layouts/home.html
@@ -0,0 +1,11 @@
+---
+layout: archive
+---
+
+{{ site.data.ui-text[site.locale].recent_posts | default: "Recent Posts" }}
+ +{% for post in paginator.posts %} + {% include archive-single.html %} +{% endfor %} + +{% include paginator.html %} diff --git a/docs/_layouts/posts.html b/docs/_layouts/posts.html new file mode 100644 index 00000000..76d25f9d --- /dev/null +++ b/docs/_layouts/posts.html @@ -0,0 +1,29 @@ +--- +layout: archive +--- + +{{ content }} + +-
+ {% assign postsInYear = site.posts | group_by_exp: 'post', 'post.date | date: "%Y"' %}
+ {% for year in postsInYear %}
+
- + + {{ year.name }} {{ year.items | size }} + + + {% endfor %} +
{{ year.name }}
+
+ {% for post in year.items %}
+ {% include archive-single.html type=page.entries_layout %}
+ {% endfor %}
+
+ {{ site.data.ui-text[site.locale].back_to_top | default: 'Back to Top' }} ↑
+
+ {% include sidebar.html %}
+
+
\ No newline at end of file
diff --git a/docs/_layouts/single.html b/docs/_layouts/single.html
new file mode 100644
index 00000000..a8d88333
--- /dev/null
+++ b/docs/_layouts/single.html
@@ -0,0 +1,92 @@
+---
+layout: default
+---
+
+{% if page.header.overlay_color or page.header.overlay_image or page.header.image %}
+ {% include page__hero.html %}
+{% elsif page.header.video.id and page.header.video.provider %}
+ {% include page__hero_video.html %}
+{% endif %}
+
+{% if page.url != "/" and site.breadcrumbs %}
+ {% unless paginator %}
+ {% include breadcrumbs.html %}
+ {% endunless %}
+{% endif %}
+
+
+ {% unless page.header.overlay_color or page.header.overlay_image %}
+
+{{ page.title }}
+ {% endunless %} + + {{ content }} + + {%- assign search_provider = site.search_provider | default: "lunr" -%} + {%- case search_provider -%} + {%- when "lunr" -%} + + + {%- when "google" -%} + +
+
+ {%- when "algolia" -%}
+
+
+ {%- endcase -%}
+
+ {% include sidebar.html %}
+
+
+ {% if page.title %}{% endif %}
+ {% if page.excerpt %}{% endif %}
+ {% if page.date %}{% endif %}
+ {% if page.last_modified_at %}{% endif %}
+
+
+
+ {% comment %}{% endcomment %}
+ {% if page.id and page.related and site.related_posts.size > 0 %}
+
+ {% comment %}{% endcomment %}
+ {% elsif page.id and page.related %}
+
+ {% endif %}
+
diff --git a/docs/_layouts/splash.html b/docs/_layouts/splash.html
new file mode 100644
index 00000000..c9cc6998
--- /dev/null
+++ b/docs/_layouts/splash.html
@@ -0,0 +1,22 @@
+---
+layout: default
+---
+
+{% if page.header.overlay_color or page.header.overlay_image or page.header.image %}
+ {% include page__hero.html %}
+{% elsif page.header.video.id and page.header.video.provider %}
+ {% include page__hero_video.html %}
+{% endif %}
+
+
+
+
+
+
+
+
+
+
+
+
+ {% if page.toc %}
+
+ {% endif %}
+ {{ content }}
+ {% if page.link %}{% endif %}
+
+
+
+
+ {% if page.share %}{% include social-share.html %}{% endif %}
+
+ {% include post_pagination.html %}
+
+
+ {% if jekyll.environment == 'production' and site.comments.provider and page.comments %}
+ {% include comments.html %}
+ {% endif %}
+
+
+ {% if page.title %}{% endif %}
+ {% if page.excerpt %}{% endif %}
+ {% if page.date %}{% endif %}
+ {% if page.last_modified_at %}{% endif %}
+
+
+ {{ content }}
+
+
+
\ No newline at end of file
diff --git a/docs/_layouts/tag.html b/docs/_layouts/tag.html
new file mode 100644
index 00000000..5f83c2aa
--- /dev/null
+++ b/docs/_layouts/tag.html
@@ -0,0 +1,9 @@
+---
+layout: archive
+---
+
+{{ content }}
+
+
+ {% include posts-tag.html taxonomy=page.taxonomy type=page.entries_layout %}
+
diff --git a/docs/_layouts/tags.html b/docs/_layouts/tags.html
new file mode 100644
index 00000000..1c0e7023
--- /dev/null
+++ b/docs/_layouts/tags.html
@@ -0,0 +1,48 @@
+---
+layout: archive
+---
+
+{{ content }}
+
+-
+ {% assign tags_max = 0 %}
+ {% for tag in site.tags %}
+ {% if tag[1].size > tags_max %}
+ {% assign tags_max = tag[1].size %}
+ {% endif %}
+ {% endfor %}
+ {% for i in (1..tags_max) reversed %}
+ {% for tag in site.tags %}
+ {% if tag[1].size == i %}
+
- + + {{ tag[0] }} {{ i }} + + + {% endif %} + {% endfor %} + {% endfor %} +
{{ tag[0] }}
+
+ {% for post in tag.last %}
+ {% include archive-single.html type=page.entries_layout %}
+ {% endfor %}
+
+ {{ site.data.ui-text[site.locale].back_to_top | default: 'Back to Top' }} ↑
+
+ * #### Headline for the Notice
+ * Text for the notice
+ *
+ */
+
+@mixin notice($notice-color) {
+ margin: 2em 0 !important; /* override*/
+ padding: 1em;
+ color: $dark-gray;
+ font-family: $global-font-family;
+ font-size: $type-size-6 !important;
+ text-indent: initial; /* override*/
+ background-color: mix(#fff, $notice-color, 90%);
+ border-radius: $border-radius;
+ box-shadow: 0 1px 1px rgba($notice-color, 0.25);
+
+ h4 {
+ margin-top: 0 !important; /* override*/
+ margin-bottom: 0.75em;
+ }
+
+ @at-root .page__content #{&} h4 {
+ /* using at-root to override .page-content h4 font size*/
+ margin-bottom: 0;
+ font-size: 1em;
+ }
+
+ p {
+ &:last-child {
+ margin-bottom: 0 !important; /* override*/
+ }
+ }
+
+ h4 + p {
+ /* remove space above paragraphs that appear directly after notice headline*/
+ margin-top: 0;
+ padding-top: 0;
+ }
+
+ a {
+ color: $notice-color;
+
+ &:hover {
+ color: mix(#000, $notice-color, 40%);
+ }
+ }
+
+ code {
+ background-color: mix(#fff, $notice-color, 95%)
+ }
+
+ ul {
+ &:last-child {
+ margin-bottom: 0; /* override*/
+ }
+ }
+}
+
+/* Default notice */
+
+.notice {
+ @include notice($light-gray);
+}
+
+/* Primary notice */
+
+.notice--primary {
+ @include notice($primary-color);
+}
+
+/* Info notice */
+
+.notice--info {
+ @include notice($info-color);
+}
+
+/* Warning notice */
+
+.notice--warning {
+ @include notice($warning-color);
+}
+
+/* Success notice */
+
+.notice--success {
+ @include notice($success-color);
+}
+
+/* Danger notice */
+
+.notice--danger {
+ @include notice($danger-color);
+}
\ No newline at end of file
diff --git a/docs/_sass/minimal-mistakes/_page.scss b/docs/_sass/minimal-mistakes/_page.scss
new file mode 100644
index 00000000..0dcd8d5d
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/_page.scss
@@ -0,0 +1,520 @@
+/* ==========================================================================
+ SINGLE PAGE/POST
+ ========================================================================== */
+
+#main {
+ @include clearfix;
+ margin-left: 2em;
+ margin-top: 2em;
+ margin-right: 0;
+ padding-left: 1em;
+ padding-right: 1em;
+ -webkit-animation: $intro-transition;
+ animation: $intro-transition;
+ max-width: 100%;
+ -webkit-animation-delay: 0.15s;
+ animation-delay: 0.15s;
+
+ @include breakpoint($x-large) {
+ max-width: $x-large;
+ }
+}
+
+.page {
+ @include breakpoint($large) {
+ float: right;
+ width: calc(100% - #{$right-sidebar-width-narrow});
+ padding-right: $right-sidebar-width-narrow;
+ }
+
+ @include breakpoint($x-large) {
+ width: calc(100% - #{$right-sidebar-width});
+ padding-right: $right-sidebar-width;
+ }
+
+ .page__inner-wrap {
+ float: left;
+ margin-left: 0;
+ margin-right: 0;
+ width: 130%;
+ clear: both;
+
+ .page__content,
+ .page__meta,
+ .page__share {
+ position: relative;
+ float: left;
+ margin-left: 1em;
+ margin-right: 0;
+ width: 100%;
+ clear: both;
+ }
+ }
+}
+
+.page__title {
+ margin-top: 0;
+ line-height: 1;
+
+ & + .page__meta {
+ margin-top: -0.5em;
+ }
+}
+
+.page__lead {
+ font-family: $global-font-family;
+ font-size: $type-size-4;
+}
+
+.page__content {
+ h2 {
+ padding-bottom: 0.5em;
+ border-bottom: 1px solid $border-color;
+ }
+
+ p,
+ li,
+ dl {
+ font-size: 1em;
+ }
+
+ /* paragraph indents */
+ p {
+ margin: 0 0 $indent-var;
+
+ /* sibling indentation*/
+ @if $paragraph-indent == true {
+ & + p {
+ text-indent: $indent-var;
+ margin-top: -($indent-var);
+ }
+ }
+ }
+
+ a:not(.btn) {
+ &:hover {
+ text-decoration: underline;
+
+ img {
+ box-shadow: 0 0 10px rgba(#000, 0.25);
+ }
+ }
+ }
+
+ dt {
+ margin-top: 1em;
+ font-family: $sans-serif;
+ font-weight: bold;
+ }
+
+ dd {
+ margin-left: 1em;
+ font-family: $sans-serif;
+ font-size: $type-size-6;
+ }
+
+ .small {
+ font-size: $type-size-6;
+ }
+
+ /* blockquote citations */
+ blockquote + .small {
+ margin-top: -1.5em;
+ padding-left: 1.25rem;
+ }
+}
+
+.page__hero {
+ position: relative;
+ margin-bottom: 2em;
+ @include clearfix;
+ -webkit-animation: $intro-transition;
+ animation: $intro-transition;
+ -webkit-animation-delay: 0.25s;
+ animation-delay: 0.25s;
+
+ &--overlay {
+ position: relative;
+ margin-bottom: 2em;
+ padding: 3em 0;
+ @include clearfix;
+ background-size: cover;
+ background-repeat: no-repeat;
+ background-position: center;
+ -webkit-animation: $intro-transition;
+ animation: $intro-transition;
+ -webkit-animation-delay: 0.25s;
+ animation-delay: 0.25s;
+
+ a {
+ color: #fff;
+ }
+
+ .wrapper {
+ padding-left: 1em;
+ padding-right: 1em;
+
+ @include breakpoint($x-large) {
+ max-width: $x-large;
+ }
+ }
+
+ .page__title,
+ .page__meta,
+ .page__lead,
+ .btn {
+ color: #fff;
+ text-shadow: 1px 1px 4px rgba(#000, 0.5);
+ }
+
+ .page__lead {
+ max-width: $medium;
+ }
+
+ .page__title {
+ font-size: $type-size-2;
+
+ @include breakpoint($small) {
+ font-size: $type-size-1;
+ }
+ }
+ }
+}
+
+.page__hero-image {
+ width: 100%;
+ height: auto;
+ -ms-interpolation-mode: bicubic;
+}
+
+.page__hero-caption {
+ position: absolute;
+ bottom: 0;
+ right: 0;
+ margin: 0 auto;
+ padding: 2px 5px;
+ color: #fff;
+ font-family: $caption-font-family;
+ font-size: $type-size-7;
+ background: #000;
+ text-align: right;
+ z-index: 5;
+ opacity: 0.5;
+ border-radius: $border-radius 0 0 0;
+
+ @include breakpoint($large) {
+ padding: 5px 10px;
+ }
+
+ a {
+ color: #fff;
+ text-decoration: none;
+ }
+}
+
+/*
+ Social sharing
+ ========================================================================== */
+
+.page__share {
+ margin-top: 2em;
+ padding-top: 1em;
+ border-top: 1px solid $border-color;
+
+ @include breakpoint(max-width $small) {
+ .btn span {
+ border: 0;
+ clip: rect(0 0 0 0);
+ height: 1px;
+ margin: -1px;
+ overflow: hidden;
+ padding: 0;
+ position: absolute;
+ width: 1px;
+ }
+ }
+}
+
+.page__share-title {
+ margin-bottom: 10px;
+ font-size: $type-size-6;
+ text-transform: uppercase;
+}
+
+/*
+ Page meta
+ ========================================================================== */
+
+.page__meta {
+ margin-top: 2em;
+ color: $muted-text-color;
+ font-family: $sans-serif;
+ font-size: $type-size-6;
+
+ p {
+ margin: 0;
+ }
+
+ a {
+ color: inherit;
+ }
+}
+
+.page__meta-title {
+ margin-bottom: 10px;
+ font-size: $type-size-6;
+ text-transform: uppercase;
+}
+
+/*
+ Page taxonomy
+ ========================================================================== */
+
+.page__taxonomy {
+ .sep {
+ display: none;
+ }
+
+ strong {
+ margin-right: 10px;
+ }
+}
+
+.page__taxonomy-item {
+ display: inline-block;
+ margin-right: 5px;
+ margin-bottom: 8px;
+ padding: 5px 10px;
+ text-decoration: none;
+ border: 1px solid mix(#000, $border-color, 25%);
+ border-radius: $border-radius;
+
+ &:hover {
+ text-decoration: none;
+ color: $link-color-hover;
+ }
+}
+
+.taxonomy__section {
+ margin-bottom: 2em;
+ padding-bottom: 1em;
+
+ &:not(:last-child) {
+ border-bottom: solid 1px $border-color;
+ }
+
+ .archive__item-title {
+ margin-top: 0;
+ }
+
+ .archive__subtitle {
+ clear: both;
+ border: 0;
+ }
+
+ + .taxonomy__section {
+ margin-top: 2em;
+ }
+}
+
+.taxonomy__title {
+ margin-bottom: 0.5em;
+ color: lighten($text-color, 60%);
+}
+
+.taxonomy__count {
+ color: lighten($text-color, 50%);
+}
+
+.taxonomy__index {
+ display: grid;
+ grid-column-gap: 2em;
+ grid-template-columns: repeat(2, 1fr);
+ margin: 1.414em 0;
+ padding: 0;
+ font-size: 0.75em;
+ list-style: none;
+
+ @include breakpoint($large) {
+ grid-template-columns: repeat(3, 1fr);
+ }
+
+ a {
+ display: -webkit-box;
+ display: -ms-flexbox;
+ display: flex;
+ padding: 0.25em 0;
+ -webkit-box-pack: justify;
+ -ms-flex-pack: justify;
+ justify-content: space-between;
+ color: inherit;
+ text-decoration: none;
+ border-bottom: 1px solid $border-color;
+ }
+}
+
+.back-to-top {
+ display: block;
+ clear: both;
+ color: lighten($text-color, 50%);
+ font-size: 0.6em;
+ text-transform: uppercase;
+ text-align: right;
+ text-decoration: none;
+}
+
+/*
+ Comments
+ ========================================================================== */
+
+.page__comments {
+ float: left;
+ margin-left: 0;
+ margin-right: 0;
+ width: 100%;
+ clear: both;
+}
+
+.page__comments-title {
+ margin-top: 2rem;
+ margin-bottom: 10px;
+ padding-top: 2rem;
+ font-size: $type-size-6;
+ border-top: 1px solid $border-color;
+ text-transform: uppercase;
+}
+
+.page__comments-form {
+ -webkit-transition: $global-transition;
+ transition: $global-transition;
+
+ &.disabled {
+ input,
+ button,
+ textarea,
+ label {
+ pointer-events: none;
+ cursor: not-allowed;
+ filter: alpha(opacity=65);
+ box-shadow: none;
+ opacity: 0.65;
+ }
+ }
+}
+
+.comment {
+ @include clearfix();
+ margin: 1em 0;
+
+ &:not(:last-child) {
+ border-bottom: 1px solid $border-color;
+ }
+}
+
+.comment__avatar-wrapper {
+ float: left;
+ width: 60px;
+ height: 60px;
+
+ @include breakpoint($large) {
+ width: 100px;
+ height: 100px;
+ }
+}
+
+.comment__avatar {
+ width: 40px;
+ height: 40px;
+ border-radius: 50%;
+
+ @include breakpoint($large) {
+ width: 80px;
+ height: 80px;
+ padding: 5px;
+ border: 1px solid $border-color;
+ }
+}
+
+.comment__content-wrapper {
+ float: right;
+ width: calc(100% - 60px);
+
+ @include breakpoint($large) {
+ width: calc(100% - 100px);
+ }
+}
+
+.comment__author {
+ margin: 0;
+
+ a {
+ text-decoration: none;
+ }
+}
+
+.comment__date {
+ @extend .page__meta;
+ margin: 0;
+
+ a {
+ text-decoration: none;
+ }
+}
+
+/*
+ Related
+ ========================================================================== */
+
+.page__related {
+ @include clearfix();
+ float: left;
+ margin-top: 2em;
+ padding-top: 1em;
+ border-top: 1px solid $border-color;
+
+ @include breakpoint($large) {
+ float: right;
+ width: calc(100% - #{$right-sidebar-width-narrow});
+ }
+
+ @include breakpoint($x-large) {
+ width: calc(100% - #{$right-sidebar-width});
+ }
+
+ a {
+ color: inherit;
+ text-decoration: none;
+ }
+}
+
+.page__related-title {
+ margin-bottom: 10px;
+ font-size: $type-size-6;
+ text-transform: uppercase;
+}
+
+/*
+ Wide Pages
+ ========================================================================== */
+
+.wide {
+ .page {
+ @include breakpoint($large) {
+ padding-right: 0;
+ }
+
+ @include breakpoint($x-large) {
+ padding-right: 0;
+ }
+ }
+
+ .page__related {
+ @include breakpoint($large) {
+ padding-right: 0;
+ }
+
+ @include breakpoint($x-large) {
+ padding-right: 0;
+ }
+ }
+}
diff --git a/docs/_sass/minimal-mistakes/_print.scss b/docs/_sass/minimal-mistakes/_print.scss
new file mode 100644
index 00000000..b93f1d40
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/_print.scss
@@ -0,0 +1,252 @@
+/* ==========================================================================
+ PRINT STYLES
+ ========================================================================== */
+
+@media print {
+
+ [hidden] {
+ display: none;
+ }
+
+ * {
+ -moz-box-sizing: border-box;
+ -webkit-box-sizing: border-box;
+ box-sizing: border-box;
+ }
+
+ html {
+ margin: 0;
+ padding: 0;
+ min-height: auto !important;
+ font-size: 16px;
+ }
+
+ body {
+ margin: 0 auto;
+ background: #fff !important;
+ color: #000 !important;
+ font-size: 1rem;
+ line-height: 1.5;
+ -moz-osx-font-smoothing: grayscale;
+ -webkit-font-smoothing: antialiased;
+ text-rendering: optimizeLegibility;
+ }
+
+ h1,
+ h2,
+ h3,
+ h4,
+ h5,
+ h6 {
+ color: #000;
+ line-height: 1.2;
+ margin-bottom: 0.75rem;
+ margin-top: 0;
+ }
+
+ h1 {
+ font-size: 2.5rem;
+ }
+
+ h2 {
+ font-size: 2rem;
+ }
+
+ h3 {
+ font-size: 1.75rem;
+ }
+
+ h4 {
+ font-size: 1.5rem;
+ }
+
+ h5 {
+ font-size: 1.25rem;
+ }
+
+ h6 {
+ font-size: 1rem;
+ }
+
+ a,
+ a:visited {
+ color: #000;
+ text-decoration: underline;
+ word-wrap: break-word;
+ }
+
+ table {
+ border-collapse: collapse;
+ }
+
+ thead {
+ display: table-header-group;
+ }
+
+ table,
+ th,
+ td {
+ border-bottom: 1px solid #000;
+ }
+
+ td,
+ th {
+ padding: 8px 16px;
+ }
+
+ img {
+ border: 0;
+ display: block;
+ max-width: 100% !important;
+ vertical-align: middle;
+ }
+
+ hr {
+ border: 0;
+ border-bottom: 2px solid #bbb;
+ height: 0;
+ margin: 2.25rem 0;
+ padding: 0;
+ }
+
+ dt {
+ font-weight: bold;
+ }
+
+ dd {
+ margin: 0;
+ margin-bottom: 0.75rem;
+ }
+
+ abbr[title],
+ acronym[title] {
+ border: 0;
+ text-decoration: none;
+ }
+
+ table,
+ blockquote,
+ pre,
+ code,
+ figure,
+ li,
+ hr,
+ ul,
+ ol,
+ a,
+ tr {
+ page-break-inside: avoid;
+ }
+
+ h2,
+ h3,
+ h4,
+ p,
+ a {
+ orphans: 3;
+ widows: 3;
+ }
+
+ h1,
+ h2,
+ h3,
+ h4,
+ h5,
+ h6 {
+ page-break-after: avoid;
+ page-break-inside: avoid;
+ }
+
+ h1 + p,
+ h2 + p,
+ h3 + p {
+ page-break-before: avoid;
+ }
+
+ img {
+ page-break-after: auto;
+ page-break-before: auto;
+ page-break-inside: avoid;
+ }
+
+ pre {
+ white-space: pre-wrap !important;
+ word-wrap: break-word;
+ }
+
+ a[href^='http://']:after,
+ a[href^='https://']:after,
+ a[href^='ftp://']:after {
+ content: " (" attr(href) ")";
+ font-size: 80%;
+ }
+
+ abbr[title]:after,
+ acronym[title]:after {
+ content: " (" attr(title) ")";
+ }
+
+ #main {
+ max-width: 100%;
+ }
+
+ .page {
+ margin: 0;
+ padding: 0;
+ width: 100%;
+ }
+
+ .page-break,
+ .page-break-before {
+ page-break-before: always;
+ }
+
+ .page-break-after {
+ page-break-after: always;
+ }
+
+ .no-print {
+ display: none;
+ }
+
+ a.no-reformat:after {
+ content: '';
+ }
+
+ abbr[title].no-reformat:after,
+ acronym[title].no-reformat:after {
+ content: '';
+ }
+
+ .page__hero-caption {
+ color: #000 !important;
+ background: #fff !important;
+ opacity: 1;
+
+ a {
+ color: #000 !important;
+ }
+ }
+
+/*
+ Hide the following elements on print
+ ========================================================================== */
+
+ .masthead,
+ .toc,
+ .page__share,
+ .page__related,
+ .pagination,
+ .ads,
+ .page__footer,
+ .page__comments-form,
+ .author__avatar,
+ .author__content,
+ .author__urls-wrapper,
+ .nav__list,
+ .sidebar,
+ .adsbygoogle {
+ display: none !important;
+ height: 1px !important;
+ }
+}
\ No newline at end of file
diff --git a/docs/_sass/minimal-mistakes/_reset.scss b/docs/_sass/minimal-mistakes/_reset.scss
new file mode 100644
index 00000000..2259fd0c
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/_reset.scss
@@ -0,0 +1,187 @@
+/* ==========================================================================
+ STYLE RESETS
+ ========================================================================== */
+
+* { box-sizing: border-box; }
+
+html {
+ /* apply a natural box layout model to all elements */
+ box-sizing: border-box;
+ background-color: $background-color;
+ font-size: 16px;
+
+ @include breakpoint($medium) {
+ font-size: 18px;
+ }
+
+ @include breakpoint($large) {
+ font-size: 20px;
+ }
+
+ @include breakpoint($x-large) {
+ font-size: 22px;
+ }
+
+ -webkit-text-size-adjust: 100%;
+ -ms-text-size-adjust: 100%;
+}
+
+/* Remove margin */
+
+body { margin: 0; }
+
+/* Selected elements */
+
+::-moz-selection {
+ color: #fff;
+ background: #000;
+}
+
+::selection {
+ color: #fff;
+ background: #000;
+}
+
+/* Display HTML5 elements in IE6-9 and FF3 */
+
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+hgroup,
+main,
+nav,
+section {
+ display: block;
+}
+
+/* Display block in IE6-9 and FF3 */
+
+audio,
+canvas,
+video {
+ display: inline-block;
+ *display: inline;
+ *zoom: 1;
+}
+
+/* Prevents modern browsers from displaying 'audio' without controls */
+
+audio:not([controls]) {
+ display: none;
+}
+
+a {
+ color: $link-color;
+}
+
+/* Apply focus state */
+
+a:focus {
+ @extend %tab-focus;
+}
+
+/* Remove outline from links */
+
+a:hover,
+a:active {
+ outline: 0;
+}
+
+/* Prevent sub and sup affecting line-height in all browsers */
+
+sub,
+sup {
+ position: relative;
+ font-size: 75%;
+ line-height: 0;
+ vertical-align: baseline;
+}
+
+sup {
+ top: -0.5em;
+}
+
+sub {
+ bottom: -0.25em;
+}
+
+/* img border in anchor's and image quality */
+
+img {
+ /* Responsive images (ensure images don't scale beyond their parents) */
+ max-width: 100%; /* part 1: Set a maximum relative to the parent*/
+ width: auto\9; /* IE7-8 need help adjusting responsive images*/
+ height: auto; /* part 2: Scale the height according to the width, otherwise you get stretching*/
+
+ vertical-align: middle;
+ border: 0;
+ -ms-interpolation-mode: bicubic;
+}
+
+/* Prevent max-width from affecting Google Maps */
+
+#map_canvas img,
+.google-maps img {
+ max-width: none;
+}
+
+/* Consistent form font size in all browsers, margin changes, misc */
+
+button,
+input,
+select,
+textarea {
+ margin: 0;
+ font-size: 100%;
+ vertical-align: middle;
+}
+
+button,
+input {
+ *overflow: visible; /* inner spacing ie IE6/7*/
+ line-height: normal; /* FF3/4 have !important on line-height in UA stylesheet*/
+}
+
+button::-moz-focus-inner,
+input::-moz-focus-inner { /* inner padding and border oddities in FF3/4*/
+ padding: 0;
+ border: 0;
+}
+
+button,
+html input[type="button"], // avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` and `video` controls
+input[type="reset"],
+input[type="submit"] {
+ -webkit-appearance: button; /* corrects inability to style clickable `input` types in iOS*/
+ cursor: pointer; /* improves usability and consistency of cursor style between image-type `input` and others*/
+}
+
+label,
+select,
+button,
+input[type="button"],
+input[type="reset"],
+input[type="submit"],
+input[type="radio"],
+input[type="checkbox"] {
+ cursor: pointer; /* improves usability and consistency of cursor style between image-type `input` and others*/
+}
+
+input[type="search"] { /* Appearance in Safari/Chrome*/
+ box-sizing: border-box;
+ -webkit-appearance: textfield;
+}
+
+input[type="search"]::-webkit-search-decoration,
+input[type="search"]::-webkit-search-cancel-button {
+ -webkit-appearance: none; /* inner-padding issues in Chrome OSX, Safari 5*/
+}
+
+textarea {
+ overflow: auto; /* remove vertical scrollbar in IE6-9*/
+ vertical-align: top; /* readability and alignment cross-browser*/
+}
\ No newline at end of file
diff --git a/docs/_sass/minimal-mistakes/_search.scss b/docs/_sass/minimal-mistakes/_search.scss
new file mode 100644
index 00000000..fe3c4367
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/_search.scss
@@ -0,0 +1,125 @@
+/* ==========================================================================
+ SEARCH
+ ========================================================================== */
+
+.layout--search {
+ .archive__item-teaser {
+ margin-bottom: 0.25em;
+ }
+}
+
+.search__toggle {
+ margin-left: 1rem;
+ margin-right: 1rem;
+ border: 0;
+ outline: none;
+ color: $muted-text-color;
+ background-color: transparent;
+ cursor: pointer;
+ -webkit-transition: 0.2s;
+ transition: 0.2s;
+
+ &:hover {
+ color: $text-color;
+ }
+}
+
+.search-icon {
+ width: 100%;
+ height: 100%;
+}
+
+.search-content {
+ display: none;
+ visibility: hidden;
+ padding-top: 1em;
+ padding-bottom: 1em;
+
+ &__inner-wrap {
+ width: 100%;
+ margin-left: auto;
+ margin-right: auto;
+ padding-left: 1em;
+ padding-right: 1em;
+ -webkit-animation: $intro-transition;
+ animation: $intro-transition;
+ -webkit-animation-delay: 0.15s;
+ animation-delay: 0.15s;
+
+ @include breakpoint($x-large) {
+ max-width: $x-large;
+ }
+ }
+
+ .search-input {
+ display: block;
+ margin-bottom: 0;
+ padding: 0;
+ border: none;
+ outline: none;
+ box-shadow: none;
+ background-color: transparent;
+ font-size: $type-size-3;
+
+ @include breakpoint($large) {
+ font-size: $type-size-2;
+ }
+
+ @include breakpoint($x-large) {
+ font-size: $type-size-1;
+ }
+ }
+
+ &.is--visible {
+ display: block;
+ visibility: visible;
+
+ &::after {
+ content: "";
+ display: block;
+ }
+ }
+
+ .results__found {
+ margin-top: 0.5em;
+ font-size: $type-size-6;
+ }
+
+ .archive__item {
+ margin-bottom: 2em;
+
+ @include breakpoint($large) {
+ width: 75%;
+ }
+
+ @include breakpoint($x-large) {
+ width: 50%;
+ }
+ }
+
+ .archive__item-title {
+ margin-top: 0;
+ }
+
+ .archive__item-excerpt {
+ margin-bottom: 0;
+ }
+}
+
+/* Algolia search */
+
+.ais-search-box {
+ max-width: 100% !important;
+ margin-bottom: 2em;
+}
+
+.archive__item-title .ais-Highlight {
+ color: $link-color;
+ font-style: normal;
+ text-decoration: underline;
+}
+.archive__item-excerpt .ais-Highlight {
+ color: $link-color;
+ font-style: normal;
+ font-weight: bold;
+}
diff --git a/docs/_sass/minimal-mistakes/_sidebar.scss b/docs/_sass/minimal-mistakes/_sidebar.scss
new file mode 100644
index 00000000..0a39e364
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/_sidebar.scss
@@ -0,0 +1,301 @@
+/* ==========================================================================
+ SIDEBAR
+ ========================================================================== */
+
+/*
+ Default
+ ========================================================================== */
+
+.sidebar {
+ @include clearfix();
+ margin-bottom: 1em;
+ padding-right: 1em;
+
+ @include breakpoint(max-width $large) {
+ /* fix z-index order of follow links */
+ position: relative;
+ z-index: 10;
+ -webkit-transform: translate3d(0, 0, 0);
+ transform: translate3d(0, 0, 0);
+ }
+
+ @include breakpoint($large) {
+ float: left;
+ width: calc(#{$right-sidebar-width-narrow} - 1em);
+ opacity: 0.75;
+ -webkit-transition: opacity 0.2s ease-in-out;
+ transition: opacity 0.2s ease-in-out;
+
+ &:hover {
+ opacity: 1;
+ }
+
+ &.sticky {
+ overflow-y: auto;
+ /* calculate height of nav list */
+ height: calc(
+ 100vh - 90px - 2em
+ ); // viewport height - approx. masthead height - main content top margin
+ }
+ }
+
+ @include breakpoint($x-large) {
+ width: calc(#{$right-sidebar-width} - 1em);
+ }
+
+ h2,
+ h3,
+ h4,
+ h5,
+ h6 {
+ margin-bottom: 0;
+ font-family: $sans-serif-narrow;
+ }
+
+ p,
+ li {
+ font-family: $sans-serif;
+ font-size: $type-size-6;
+ line-height: 1.5;
+ }
+
+ img {
+ width: 100%;
+ }
+}
+
+.sidebar__right {
+ margin-bottom: 1em;
+ //margin-top: 3em;
+
+ @include breakpoint($large) {
+ position: sticky !important;
+ float: right !important;
+ top: 0;
+ right: 0;
+ width: $right-sidebar-width-narrow;
+ margin-right: -1 * $right-sidebar-width-narrow;
+ padding-left: 1em;
+ padding-top: 3em !important;
+ z-index: 10;
+ }
+
+ @include breakpoint($x-large) {
+ width: $right-sidebar-width;
+ margin-right: -1 * $right-sidebar-width;
+ }
+}
+
+.splash .sidebar__right {
+ @include breakpoint($large) {
+ position: relative;
+ float: right;
+ margin-right: 0;
+ }
+
+ @include breakpoint($x-large) {
+ margin-right: 0;
+ }
+}
+
+/*
+ Author profile and links
+ ========================================================================== */
+
+.author__avatar {
+ display: table-cell;
+ vertical-align: top;
+ width: 36px;
+ height: 36px;
+
+ @include breakpoint($large) {
+ display: block;
+ width: auto;
+ height: auto;
+ }
+
+ img {
+ max-width: 110px;
+ border-radius: 50%;
+
+ @include breakpoint($large) {
+ padding: 5px;
+ border: 1px solid $border-color;
+ }
+ }
+}
+
+.author__content {
+ display: table-cell;
+ vertical-align: top;
+ padding-left: 15px;
+ padding-right: 25px;
+ line-height: 1;
+
+ @include breakpoint($large) {
+ display: block;
+ width: 100%;
+ padding-left: 0;
+ padding-right: 0;
+ }
+
+ a {
+ color: inherit;
+ text-decoration: none;
+ }
+}
+
+.author__name {
+ margin: 0;
+
+ @include breakpoint($large) {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ }
+}
+.sidebar .author__name {
+ font-family: $sans-serif;
+ font-size: $type-size-5;
+}
+
+.author__bio {
+ margin: 0;
+
+ @include breakpoint($large) {
+ margin-top: 10px;
+ margin-bottom: 20px;
+ }
+}
+
+.author__urls-wrapper {
+ position: relative;
+ display: table-cell;
+ vertical-align: middle;
+ font-family: $sans-serif;
+ z-index: 10;
+ position: relative;
+ cursor: pointer;
+
+ li:last-child {
+ a {
+ margin-bottom: 0;
+ }
+ }
+
+ @include breakpoint($large) {
+ display: block;
+ }
+
+ button {
+ margin-bottom: 0;
+
+ @include breakpoint($large) {
+ display: none;
+ }
+ }
+}
+
+.author__urls {
+ display: none;
+ position: absolute;
+ right: 0;
+ margin-top: 15px;
+ padding: 10px;
+ list-style-type: none;
+ border: 1px solid $border-color;
+ border-radius: $border-radius;
+ background: $background-color;
+ z-index: -1;
+ box-shadow: 0 2px 4px 0 rgba(#000, 0.16), 0 2px 10px 0 rgba(#000, 0.12);
+ cursor: default;
+
+ &.is--visible {
+ display: block;
+ }
+
+ @include breakpoint($large) {
+ display: block;
+ position: relative;
+ margin: 0;
+ padding: 0;
+ border: 0;
+ background: transparent;
+ box-shadow: none;
+ }
+
+ &:before {
+ display: block;
+ content: "";
+ position: absolute;
+ top: -11px;
+ left: calc(50% - 10px);
+ width: 0;
+ border-style: solid;
+ border-width: 0 10px 10px;
+ border-color: $border-color transparent;
+ z-index: 0;
+
+ @include breakpoint($large) {
+ display: none;
+ }
+ }
+
+ &:after {
+ display: block;
+ content: "";
+ position: absolute;
+ top: -10px;
+ left: calc(50% - 10px);
+ width: 0;
+ border-style: solid;
+ border-width: 0 10px 10px;
+ border-color: $background-color transparent;
+ z-index: 1;
+
+ @include breakpoint($large) {
+ display: none;
+ }
+ }
+
+ li {
+ white-space: nowrap;
+ }
+
+ a {
+ display: block;
+ margin-bottom: 5px;
+ padding-right: 5px;
+ padding-top: 2px;
+ padding-bottom: 2px;
+ color: inherit;
+ font-size: $type-size-5;
+ text-decoration: none;
+
+ &:hover {
+ text-decoration: underline;
+ }
+ }
+}
+
+/*
+ Wide Pages
+ ========================================================================== */
+
+.wide .sidebar__right {
+ margin-bottom: 1em;
+ @include breakpoint($large) {
+ position: initial;
+ top: initial;
+ right: initial;
+ width: initial;
+ margin-right: initial;
+ padding-left: initial;
+ z-index: initial;
+ }
+
+ @include breakpoint($x-large) {
+ width: initial;
+ margin-right: initial;
+ }
+}
+
diff --git a/docs/_sass/minimal-mistakes/_syntax.scss b/docs/_sass/minimal-mistakes/_syntax.scss
new file mode 100644
index 00000000..72652020
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/_syntax.scss
@@ -0,0 +1,324 @@
+/* ==========================================================================
+ Syntax highlighting
+ ========================================================================== */
+
+div.highlighter-rouge,
+figure.highlight {
+ position: relative;
+ margin-bottom: 1em;
+ background: $base00;
+ color: $base05;
+ font-family: $monospace;
+ font-size: $type-size-6;
+ line-height: 1.8;
+ border-radius: $border-radius;
+
+ > pre,
+ pre.highlight {
+ margin: 0;
+ padding: 1em;
+ }
+}
+
+.highlight table {
+ margin-bottom: 0;
+ font-size: 1em;
+ border: 0;
+
+ td {
+ padding: 0;
+ width: calc(100% - 1em);
+ border: 0;
+
+ /* line numbers*/
+ &.gutter,
+ &.rouge-gutter {
+ padding-right: 1em;
+ width: 1em;
+ color: $base04;
+ border-right: 1px solid $base04;
+ text-align: right;
+ }
+
+ /* code */
+ &.code,
+ &.rouge-code {
+ padding-left: 1em;
+ }
+ }
+
+ pre {
+ margin: 0;
+ }
+}
+
+.highlight pre {
+ width: 100%;
+}
+
+.highlight .hll {
+ background-color: $base06;
+}
+.highlight {
+ .c {
+ /* Comment */
+ color: $base04;
+ }
+ .err {
+ /* Error */
+ color: $base08;
+ }
+ .k {
+ /* Keyword */
+ color: $base0e;
+ }
+ .l {
+ /* Literal */
+ color: $base09;
+ }
+ .n {
+ /* Name */
+ color: $base05;
+ }
+ .o {
+ /* Operator */
+ color: $base0c;
+ }
+ .p {
+ /* Punctuation */
+ color: $base05;
+ }
+ .cm {
+ /* Comment.Multiline */
+ color: $base04;
+ }
+ .cp {
+ /* Comment.Preproc */
+ color: $base04;
+ }
+ .c1 {
+ /* Comment.Single */
+ color: $base04;
+ }
+ .cs {
+ /* Comment.Special */
+ color: $base04;
+ }
+ .gd {
+ /* Generic.Deleted */
+ color: $base08;
+ }
+ .ge {
+ /* Generic.Emph */
+ font-style: italic;
+ }
+ .gh {
+ /* Generic.Heading */
+ color: $base05;
+ font-weight: bold;
+ }
+ .gi {
+ /* Generic.Inserted */
+ color: $base0b;
+ }
+ .gp {
+ /* Generic.Prompt */
+ color: $base04;
+ font-weight: bold;
+ }
+ .gs {
+ /* Generic.Strong */
+ font-weight: bold;
+ }
+ .gu {
+ /* Generic.Subheading */
+ color: $base0c;
+ font-weight: bold;
+ }
+ .kc {
+ /* Keyword.Constant */
+ color: $base0e;
+ }
+ .kd {
+ /* Keyword.Declaration */
+ color: $base0e;
+ }
+ .kn {
+ /* Keyword.Namespace */
+ color: $base0c;
+ }
+ .kp {
+ /* Keyword.Pseudo */
+ color: $base0e;
+ }
+ .kr {
+ /* Keyword.Reserved */
+ color: $base0e;
+ }
+ .kt {
+ /* Keyword.Type */
+ color: $base0a;
+ }
+ .ld {
+ /* Literal.Date */
+ color: $base0b;
+ }
+ .m {
+ /* Literal.Number */
+ color: $base09;
+ }
+ .s {
+ /* Literal.String */
+ color: $base0b;
+ }
+ .na {
+ /* Name.Attribute */
+ color: $base0d;
+ }
+ .nb {
+ /* Name.Builtin */
+ color: $base05;
+ }
+ .nc {
+ /* Name.Class */
+ color: $base0a;
+ }
+ .no {
+ /* Name.Constant */
+ color: $base08;
+ }
+ .nd {
+ /* Name.Decorator */
+ color: $base0c;
+ }
+ .ni {
+ /* Name.Entity */
+ color: $base05;
+ }
+ .ne {
+ /* Name.Exception */
+ color: $base08;
+ }
+ .nf {
+ /* Name.Function */
+ color: $base0d;
+ }
+ .nl {
+ /* Name.Label */
+ color: $base05;
+ }
+ .nn {
+ /* Name.Namespace */
+ color: $base0a;
+ }
+ .nx {
+ /* Name.Other */
+ color: $base0d;
+ }
+ .py {
+ /* Name.Property */
+ color: $base05;
+ }
+ .nt {
+ /* Name.Tag */
+ color: $base0c;
+ }
+ .nv {
+ /* Name.Variable */
+ color: $base08;
+ }
+ .ow {
+ /* Operator.Word */
+ color: $base0c;
+ }
+ .w {
+ /* Text.Whitespace */
+ color: $base05;
+ }
+ .mf {
+ /* Literal.Number.Float */
+ color: $base09;
+ }
+ .mh {
+ /* Literal.Number.Hex */
+ color: $base09;
+ }
+ .mi {
+ /* Literal.Number.Integer */
+ color: $base09;
+ }
+ .mo {
+ /* Literal.Number.Oct */
+ color: $base09;
+ }
+ .sb {
+ /* Literal.String.Backtick */
+ color: $base0b;
+ }
+ .sc {
+ /* Literal.String.Char */
+ color: $base05;
+ }
+ .sd {
+ /* Literal.String.Doc */
+ color: $base04;
+ }
+ .s2 {
+ /* Literal.String.Double */
+ color: $base0b;
+ }
+ .se {
+ /* Literal.String.Escape */
+ color: $base09;
+ }
+ .sh {
+ /* Literal.String.Heredoc */
+ color: $base0b;
+ }
+ .si {
+ /* Literal.String.Interpol */
+ color: $base09;
+ }
+ .sx {
+ /* Literal.String.Other */
+ color: $base0b;
+ }
+ .sr {
+ /* Literal.String.Regex */
+ color: $base0b;
+ }
+ .s1 {
+ /* Literal.String.Single */
+ color: $base0b;
+ }
+ .ss {
+ /* Literal.String.Symbol */
+ color: $base0b;
+ }
+ .bp {
+ /* Name.Builtin.Pseudo */
+ color: $base05;
+ }
+ .vc {
+ /* Name.Variable.Class */
+ color: $base08;
+ }
+ .vg {
+ /* Name.Variable.Global */
+ color: $base08;
+ }
+ .vi {
+ /* Name.Variable.Instance */
+ color: $base08;
+ }
+ .il {
+ /* Literal.Number.Integer.Long */
+ color: $base09;
+ }
+}
+
+.gist {
+ th, td {
+ border-bottom: 0;
+ }
+}
\ No newline at end of file
diff --git a/docs/_sass/minimal-mistakes/_tables.scss b/docs/_sass/minimal-mistakes/_tables.scss
new file mode 100644
index 00000000..a2f85090
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/_tables.scss
@@ -0,0 +1,37 @@
+/* ==========================================================================
+ TABLES
+ ========================================================================== */
+
+table {
+ margin-bottom: 1em;
+ width: 100%;
+ font-family: $global-font-family;
+ font-size: $type-size-7;
+ border-collapse: collapse;
+
+ & + table {
+ margin-top: 1em;
+ }
+}
+
+thead {
+ background-color: $border-color;
+ border-bottom: 2px solid mix(#000, $border-color, 25%);
+}
+
+th {
+ padding: 0.5em;
+ font-weight: bold;
+ text-align: left;
+}
+
+td {
+ padding: 0.5em;
+ border-bottom: 1px solid mix(#000, $border-color, 25%);
+}
+
+tr,
+td,
+th {
+ vertical-align: middle;
+}
\ No newline at end of file
diff --git a/docs/_sass/minimal-mistakes/_utilities.scss b/docs/_sass/minimal-mistakes/_utilities.scss
new file mode 100644
index 00000000..d539dd12
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/_utilities.scss
@@ -0,0 +1,524 @@
+/* ==========================================================================
+ UTILITY CLASSES
+ ========================================================================== */
+
+/*
+ Visibility
+ ========================================================================== */
+
+/* http://www.456bereastreet.com/archive/200711/screen_readers_sometimes_ignore_displaynone/ */
+
+.hidden,
+.is--hidden {
+ display: none;
+ visibility: hidden;
+}
+
+/* for preloading images */
+
+.load {
+ display: none;
+}
+
+.transparent {
+ opacity: 0;
+}
+
+/* https://developer.yahoo.com/blogs/ydn/clip-hidden-content-better-accessibility-53456.html */
+
+.visually-hidden,
+.screen-reader-text,
+.screen-reader-text span,
+.screen-reader-shortcut {
+ position: absolute !important;
+ clip: rect(1px, 1px, 1px, 1px);
+ height: 1px !important;
+ width: 1px !important;
+ border: 0 !important;
+ overflow: hidden;
+}
+
+body:hover .visually-hidden a,
+body:hover .visually-hidden input,
+body:hover .visually-hidden button {
+ display: none !important;
+}
+
+/* screen readers */
+
+.screen-reader-text:focus,
+.screen-reader-shortcut:focus {
+ clip: auto !important;
+ height: auto !important;
+ width: auto !important;
+ display: block;
+ font-size: 1em;
+ font-weight: bold;
+ padding: 15px 23px 14px;
+ background: #fff;
+ z-index: 100000;
+ text-decoration: none;
+ box-shadow: 0 0 2px 2px rgba(0, 0, 0, 0.6);
+}
+
+/*
+ Skip links
+ ========================================================================== */
+
+.skip-link {
+ position: fixed;
+ z-index: 20;
+ margin: 0;
+ font-family: $sans-serif;
+ white-space: nowrap;
+}
+
+.skip-link li {
+ height: 0;
+ width: 0;
+ list-style: none;
+}
+
+/*
+ Type
+ ========================================================================== */
+
+.text-left {
+ text-align: left;
+}
+
+.text-center {
+ text-align: center;
+}
+
+.text-right {
+ text-align: right;
+}
+
+.text-justify {
+ text-align: justify;
+}
+
+.text-nowrap {
+ white-space: nowrap;
+}
+
+/*
+ Alignment
+ ========================================================================== */
+
+/* clearfix */
+
+.cf {
+ clear: both;
+}
+
+.wrapper {
+ margin-left: auto;
+ margin-right: auto;
+ width: 100%;
+}
+
+/*
+ Images
+ ========================================================================== */
+
+/* image align left */
+
+.align-left {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+
+ @include breakpoint($small) {
+ float: left;
+ margin-right: 1em;
+ }
+}
+
+/* image align right */
+
+.align-right {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+
+ @include breakpoint($small) {
+ float: right;
+ margin-left: 1em;
+ }
+}
+
+/* image align center */
+
+.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+/* file page content container */
+
+.full {
+ @include breakpoint($large) {
+ margin-right: -1 * span(2.5 of 12) !important;
+ }
+}
+
+/*
+ Icons
+ ========================================================================== */
+
+.icon {
+ display: inline-block;
+ fill: currentColor;
+ width: 1em;
+ height: 1.1em;
+ line-height: 1;
+ position: relative;
+ top: -0.1em;
+ vertical-align: middle;
+}
+
+/* social icons*/
+
+.social-icons {
+ .fas,
+ .fab,
+ .far,
+ .fal {
+ color: $text-color;
+ }
+
+ .fa-behance,
+ .fa-behance-square {
+ color: $behance-color;
+ }
+
+ .fa-bitbucket {
+ color: $bitbucket-color;
+ }
+
+ .fa-dribbble,
+ .fa-dribble-square {
+ color: $dribbble-color;
+ }
+
+ .fa-facebook,
+ .fa-facebook-square,
+ .fa-facebook-f {
+ color: $facebook-color;
+ }
+
+ .fa-flickr {
+ color: $flickr-color;
+ }
+
+ .fa-foursquare {
+ color: $foursquare-color;
+ }
+
+ .fa-github,
+ .fa-github-alt,
+ .fa-github-square {
+ color: $github-color;
+ }
+
+ .fa-gitlab {
+ color: $gitlab-color;
+ }
+
+ .fa-google-plus,
+ .fa-google-plus-square,
+ .fa-google-plus-g {
+ color: $google-plus-color;
+ }
+
+ .fa-instagram {
+ color: $instagram-color;
+ }
+
+ .fa-lastfm,
+ .fa-lastfm-square {
+ color: $lastfm-color;
+ }
+
+ .fa-linkedin,
+ .fa-linkedin-in {
+ color: $linkedin-color;
+ }
+
+ .fa-pinterest,
+ .fa-pinterest-p,
+ .fa-pinterest-square {
+ color: $pinterest-color;
+ }
+
+ .fa-rss,
+ .fa-rss-square {
+ color: $rss-color;
+ }
+
+ .fa-soundcloud {
+ color: $soundcloud-color;
+ }
+
+ .fa-stack-exchange,
+ .fa-stack-overflow {
+ color: $stackoverflow-color;
+ }
+
+ .fa-tumblr,
+ .fa-tumblr-square {
+ color: $tumblr-color;
+ }
+
+ .fa-twitter,
+ .fa-twitter-square {
+ color: $twitter-color;
+ }
+
+ .fa-vimeo,
+ .fa-vimeo-square,
+ .fa-vimeo-v {
+ color: $vimeo-color;
+ }
+
+ .fa-vine {
+ color: $vine-color;
+ }
+
+ .fa-youtube {
+ color: $youtube-color;
+ }
+
+ .fa-xing,
+ .fa-xing-square {
+ color: $xing-color;
+ }
+}
+
+/*
+ Navicons
+ ========================================================================== */
+
+.navicon {
+ position: relative;
+ width: $navicon-width;
+ height: $navicon-height;
+ background: #fff;
+ margin: auto;
+ -webkit-transition: 0.3s;
+ transition: 0.3s;
+
+ &:before,
+ &:after {
+ content: "";
+ position: absolute;
+ left: 0;
+ width: $navicon-width;
+ height: $navicon-height;
+ background: #fff;
+ -webkit-transition: 0.3s;
+ transition: 0.3s;
+ }
+
+ &:before {
+ top: (-2 * $navicon-height);
+ }
+
+ &:after {
+ bottom: (-2 * $navicon-height);
+ }
+}
+
+.close .navicon {
+ /* hide the middle line*/
+ background: transparent;
+
+ /* overlay the lines by setting both their top values to 0*/
+ &:before,
+ &:after {
+ -webkit-transform-origin: 50% 50%;
+ -ms-transform-origin: 50% 50%;
+ transform-origin: 50% 50%;
+ top: 0;
+ width: $navicon-width;
+ }
+
+ /* rotate the lines to form the x shape*/
+ &:before {
+ -webkit-transform: rotate3d(0, 0, 1, 45deg);
+ transform: rotate3d(0, 0, 1, 45deg);
+ }
+ &:after {
+ -webkit-transform: rotate3d(0, 0, 1, -45deg);
+ transform: rotate3d(0, 0, 1, -45deg);
+ }
+}
+
+/*
+ Sticky, fixed to top content
+ ========================================================================== */
+
+.sticky {
+ @include breakpoint($large) {
+ @include clearfix();
+ position: -webkit-sticky;
+ position: sticky;
+ top: 2em;
+
+ > * {
+ display: block;
+ }
+ }
+}
+
+/*
+ Wells
+ ========================================================================== */
+
+.well {
+ min-height: 20px;
+ padding: 19px;
+ margin-bottom: 20px;
+ background-color: #f5f5f5;
+ border: 1px solid #e3e3e3;
+ border-radius: $border-radius;
+ box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.05);
+}
+
+/*
+ Modals
+ ========================================================================== */
+
+.show-modal {
+ overflow: hidden;
+ position: relative;
+
+ &:before {
+ position: absolute;
+ content: "";
+ top: 0;
+ left: 0;
+ width: 100%;
+ height: 100%;
+ z-index: 999;
+ background-color: rgba(255, 255, 255, 0.85);
+ }
+
+ .modal {
+ display: block;
+ }
+}
+
+.modal {
+ display: none;
+ position: fixed;
+ width: 300px;
+ top: 50%;
+ left: 50%;
+ margin-left: -150px;
+ margin-top: -150px;
+ min-height: 0;
+ z-index: 9999;
+ background: #fff;
+ border: 1px solid $border-color;
+ border-radius: $border-radius;
+ box-shadow: $box-shadow;
+
+ &__title {
+ margin: 0;
+ padding: 0.5em 1em;
+ }
+
+ &__supporting-text {
+ padding: 0 1em 0.5em 1em;
+ }
+
+ &__actions {
+ padding: 0.5em 1em;
+ border-top: 1px solid $border-color;
+ }
+}
+
+/*
+ Footnotes
+ ========================================================================== */
+
+.footnote {
+ color: mix(#fff, $gray, 25%);
+ text-decoration: none;
+}
+
+.footnotes {
+ color: mix(#fff, $gray, 25%);
+
+ ol,
+ li,
+ p {
+ margin-bottom: 0;
+ font-size: $type-size-6;
+ }
+}
+
+a.reversefootnote {
+ color: $gray;
+ text-decoration: none;
+
+ &:hover {
+ text-decoration: underline;
+ }
+}
+
+/*
+ Required
+ ========================================================================== */
+
+.required {
+ color: $danger-color;
+ font-weight: bold;
+}
+
+/*
+ Google Custom Search Engine
+ ========================================================================== */
+
+.gsc-control-cse {
+ table,
+ tr,
+ td {
+ border: 0; /* remove table borders widget */
+ }
+}
+
+/*
+ Responsive Video Embed
+ ========================================================================== */
+
+.responsive-video-container {
+ position: relative;
+ margin-bottom: 1em;
+ padding-bottom: 56.25%;
+ height: 0;
+ overflow: hidden;
+ max-width: 100%;
+
+ iframe,
+ object,
+ embed {
+ position: absolute;
+ top: 0;
+ left: 0;
+ width: 100%;
+ height: 100%;
+ }
+}
+
+// full screen video fixes
+:-webkit-full-screen-ancestor {
+ .masthead,
+ .page__footer {
+ position: static;
+ }
+}
diff --git a/docs/_sass/minimal-mistakes/_variables.scss b/docs/_sass/minimal-mistakes/_variables.scss
new file mode 100644
index 00000000..23123af1
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/_variables.scss
@@ -0,0 +1,154 @@
+/* ==========================================================================
+ Variables
+ ========================================================================== */
+
+/*
+ Typography
+ ========================================================================== */
+
+$doc-font-size: 16 !default;
+
+/* paragraph indention */
+$paragraph-indent: false !default; // true, false (default)
+$indent-var: 1.3em !default;
+
+/* system typefaces */
+$serif: Georgia, Times, serif !default;
+$sans-serif: -apple-system, BlinkMacSystemFont, "Roboto", "Segoe UI",
+ "Helvetica Neue", "Lucida Grande", Arial, sans-serif !default;
+$monospace: Monaco, Consolas, "Lucida Console", monospace !default;
+
+/* sans serif typefaces */
+$sans-serif-narrow: $sans-serif !default;
+$helvetica: Helvetica, "Helvetica Neue", Arial, sans-serif !default;
+
+/* serif typefaces */
+$georgia: Georgia, serif !default;
+$times: Times, serif !default;
+$bodoni: "Bodoni MT", serif !default;
+$calisto: "Calisto MT", serif !default;
+$garamond: Garamond, serif !default;
+
+$global-font-family: $sans-serif !default;
+$header-font-family: $sans-serif !default;
+$caption-font-family: $serif !default;
+
+/* type scale */
+$type-size-1: 2.441em !default; // ~39.056px
+$type-size-2: 1.953em !default; // ~31.248px
+$type-size-3: 1.563em !default; // ~25.008px
+$type-size-4: 1.25em !default; // ~20px
+$type-size-5: 1em !default; // ~16px
+$type-size-6: 0.75em !default; // ~12px
+$type-size-7: 0.6875em !default; // ~11px
+$type-size-8: 0.625em !default; // ~10px
+
+/*
+ Colors
+ ========================================================================== */
+
+$gray: #7a8288 !default;
+$dark-gray: mix(#000, $gray, 40%) !default;
+$darker-gray: mix(#000, $gray, 60%) !default;
+$light-gray: mix(#fff, $gray, 50%) !default;
+$lighter-gray: mix(#fff, $gray, 90%) !default;
+
+$background-color: #fff !default;
+$code-background-color: #fafafa !default;
+$code-background-color-dark: $light-gray !default;
+$text-color: $dark-gray !default;
+$muted-text-color: mix(#fff, $text-color, 35%) !default;
+$border-color: $lighter-gray !default;
+$form-background-color: $lighter-gray !default;
+$footer-background-color: $lighter-gray !default;
+
+$primary-color: #7a8288 !default;
+$success-color: #62c462 !default;
+$warning-color: #f89406 !default;
+$danger-color: #ee5f5b !default;
+$info-color: #52adc8 !default;
+
+/* YIQ color contrast */
+$yiq-contrasted-dark-default: $dark-gray !default;
+$yiq-contrasted-light-default: #fff !default;
+$yiq-contrasted-threshold: 175 !default;
+$yiq-debug: false !default;
+
+/* brands */
+$behance-color: #1769ff !default;
+$bitbucket-color: #205081 !default;
+$dribbble-color: #ea4c89 !default;
+$facebook-color: #3b5998 !default;
+$flickr-color: #ff0084 !default;
+$foursquare-color: #0072b1 !default;
+$github-color: #171516 !default;
+$gitlab-color: #e24329 !default;
+$google-plus-color: #dd4b39 !default;
+$instagram-color: #517fa4 !default;
+$lastfm-color: #d51007 !default;
+$linkedin-color: #007bb6 !default;
+$pinterest-color: #cb2027 !default;
+$rss-color: #fa9b39 !default;
+$soundcloud-color: #ff3300 !default;
+$stackoverflow-color: #fe7a15 !default;
+$tumblr-color: #32506d !default;
+$twitter-color: #55acee !default;
+$vimeo-color: #1ab7ea !default;
+$vine-color: #00bf8f !default;
+$youtube-color: #bb0000 !default;
+$xing-color: #006567 !default;
+
+/* links */
+$link-color: $info-color !default;
+$link-color-hover: mix(#000, $link-color, 25%) !default;
+$link-color-visited: mix(#fff, $link-color, 25%) !default;
+$masthead-link-color: $primary-color !default;
+$masthead-link-color-hover: mix(#000, $primary-color, 25%) !default;
+$navicon-link-color-hover: mix(#fff, $primary-color, 75%) !default;
+
+/* syntax highlighting (base16) */
+$base00: #263238 !default;
+$base01: #2e3c43 !default;
+$base02: #314549 !default;
+$base03: #546e7a !default;
+$base04: #b2ccd6 !default;
+$base05: #eeffff !default;
+$base06: #eeffff !default;
+$base07: #ffffff !default;
+$base08: #f07178 !default;
+$base09: #f78c6c !default;
+$base0a: #ffcb6b !default;
+$base0b: #c3e88d !default;
+$base0c: #89ddff !default;
+$base0d: #82aaff !default;
+$base0e: #c792ea !default;
+$base0f: #ff5370 !default;
+
+/*
+ Breakpoints
+ ========================================================================== */
+
+$small: 600px !default;
+$medium: 768px !default;
+$medium-wide: 900px !default;
+$large: 1024px !default;
+$x-large: 1500px !default;
+
+/*
+ Grid
+ ========================================================================== */
+
+$right-sidebar-width-narrow: 200px !default;
+$right-sidebar-width: 400px !default;
+$right-sidebar-width-wide: 450px !default;
+
+/*
+ Other
+ ========================================================================== */
+
+$border-radius: 4px !default;
+$box-shadow: 0 1px 1px rgba(0, 0, 0, 0.125) !default;
+$navicon-width: 1.5rem !default;
+$navicon-height: 0.25rem !default;
+$global-transition: all 0.2s ease-in-out !default;
+$intro-transition: intro 0.3s both !default;
diff --git a/docs/_sass/minimal-mistakes/skins/_air.scss b/docs/_sass/minimal-mistakes/skins/_air.scss
new file mode 100644
index 00000000..0e5360c3
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/skins/_air.scss
@@ -0,0 +1,23 @@
+/* ==========================================================================
+ Air skin
+ ========================================================================== */
+
+/* Colors */
+$background-color: #eeeeee !default;
+$text-color: #222831 !default;
+$muted-text-color: #393e46 !default;
+$primary-color: #0092ca !default;
+$border-color: mix(#fff, #393e46, 75%) !default;
+$footer-background-color: $primary-color !default;
+$link-color: #393e46 !default;
+$masthead-link-color: $text-color !default;
+$masthead-link-color-hover: $text-color !default;
+$navicon-link-color-hover: mix(#fff, $text-color, 80%) !default;
+
+.page__footer {
+ color: #fff !important; // override
+}
+
+.page__footer-follow .social-icons .svg-inline--fa {
+ color: inherit;
+}
diff --git a/docs/_sass/minimal-mistakes/skins/_aqua.scss b/docs/_sass/minimal-mistakes/skins/_aqua.scss
new file mode 100644
index 00000000..f5a69af5
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/skins/_aqua.scss
@@ -0,0 +1,30 @@
+/* ==========================================================================
+ Aqua skin
+ ========================================================================== */
+
+/* Colors */
+$gray : #1976d2 !default;
+$dark-gray : mix(#000, $gray, 40%) !default;
+$darker-gray : mix(#000, $gray, 60%) !default;
+$light-gray : mix(#fff, $gray, 50%) !default;
+$lighter-gray : mix(#fff, $gray, 90%) !default;
+
+$body-color : #fff !default;
+$background-color : #f0fff0 !default;
+$code-background-color : $lighter-gray !default;
+$code-background-color-dark : $light-gray !default;
+$text-color : $dark-gray !default;
+$border-color : $lighter-gray !default;
+
+$primary-color : $gray !default;
+$success-color : #27ae60 !default;
+$warning-color : #e67e22 !default;
+$danger-color : #c0392b !default;
+$info-color : #03a9f4 !default;
+
+/* links */
+$link-color : $info-color !default;
+$link-color-hover : mix(#000, $link-color, 25%) !default;
+$link-color-visited : mix(#fff, $link-color, 25%) !default;
+$masthead-link-color : $primary-color !default;
+$masthead-link-color-hover : mix(#000, $primary-color, 25%) !default;
\ No newline at end of file
diff --git a/docs/_sass/minimal-mistakes/skins/_contrast.scss b/docs/_sass/minimal-mistakes/skins/_contrast.scss
new file mode 100644
index 00000000..4635e533
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/skins/_contrast.scss
@@ -0,0 +1,51 @@
+/* ==========================================================================
+ Contrast skin
+ ========================================================================== */
+
+/* Colors */
+$text-color: #000 !default;
+$muted-text-color: $text-color !default;
+$primary-color: #ff0000 !default;
+$border-color: mix(#fff, $text-color, 75%) !default;
+$footer-background-color: #000 !default;
+$link-color: #0000ff !default;
+$masthead-link-color: $text-color !default;
+$masthead-link-color-hover: $text-color !default;
+$navicon-link-color-hover: mix(#fff, $text-color, 80%) !default;
+
+/* contrast syntax highlighting (base16) */
+$base00: #000000 !default;
+$base01: #242422 !default;
+$base02: #484844 !default;
+$base03: #6c6c66 !default;
+$base04: #918f88 !default;
+$base05: #b5b3aa !default;
+$base06: #d9d7cc !default;
+$base07: #fdfbee !default;
+$base08: #ff6c60 !default;
+$base09: #e9c062 !default;
+$base0a: #ffffb6 !default;
+$base0b: #a8ff60 !default;
+$base0c: #c6c5fe !default;
+$base0d: #96cbfe !default;
+$base0e: #ff73fd !default;
+$base0f: #b18a3d !default;
+
+.page__content {
+ .notice,
+ .notice--primary,
+ .notice--info,
+ .notice--warning,
+ .notice--success,
+ .notice--danger {
+ color: $text-color;
+ }
+}
+
+.page__footer {
+ color: #fff !important; // override
+}
+
+.page__footer-follow .social-icons .svg-inline--fa {
+ color: inherit;
+}
diff --git a/docs/_sass/minimal-mistakes/skins/_dark.scss b/docs/_sass/minimal-mistakes/skins/_dark.scss
new file mode 100644
index 00000000..4f0a77e0
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/skins/_dark.scss
@@ -0,0 +1,42 @@
+/* ==========================================================================
+ Dark skin
+ ========================================================================== */
+
+/* Colors */
+$background-color: #252a34 !default;
+$text-color: #eaeaea !default;
+$primary-color: #00adb5 !default;
+$border-color: mix(#fff, $background-color, 20%) !default;
+$code-background-color: mix(#000, $background-color, 15%) !default;
+$code-background-color-dark: mix(#000, $background-color, 20%) !default;
+$form-background-color: mix(#000, $background-color, 15%) !default;
+$footer-background-color: mix(#000, $background-color, 30%) !default;
+$link-color: mix($primary-color, $text-color, 40%) !default;
+$link-color-hover: mix(#fff, $link-color, 25%) !default;
+$link-color-visited: mix(#000, $link-color, 25%) !default;
+$masthead-link-color: $text-color !default;
+$masthead-link-color-hover: mix(#000, $text-color, 20%) !default;
+$navicon-link-color-hover: mix(#000, $background-color, 30%) !default;
+
+/* dark syntax highlighting (base16) */
+$base00: #ffffff !default;
+$base01: #e0e0e0 !default;
+$base02: #d0d0d0 !default;
+$base03: #b0b0b0 !default;
+$base04: #000000 !default;
+$base05: #101010 !default;
+$base06: #151515 !default;
+$base07: #202020 !default;
+$base08: #ff0086 !default;
+$base09: #fd8900 !default;
+$base0a: #aba800 !default;
+$base0b: #00c918 !default;
+$base0c: #1faaaa !default;
+$base0d: #3777e6 !default;
+$base0e: #ad00a1 !default;
+$base0f: #cc6633 !default;
+
+.author__urls.social-icons .svg-inline--fa,
+.page__footer-follow .social-icons .svg-inline--fa {
+ color: inherit;
+}
diff --git a/docs/_sass/minimal-mistakes/skins/_default.scss b/docs/_sass/minimal-mistakes/skins/_default.scss
new file mode 100644
index 00000000..7489b584
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/skins/_default.scss
@@ -0,0 +1,5 @@
+/* ==========================================================================
+ Default skin
+ ========================================================================== */
+
+// Intentionally left blank
diff --git a/docs/_sass/minimal-mistakes/skins/_dirt.scss b/docs/_sass/minimal-mistakes/skins/_dirt.scss
new file mode 100644
index 00000000..5090f559
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/skins/_dirt.scss
@@ -0,0 +1,33 @@
+/* ==========================================================================
+ Dirt skin
+ ========================================================================== */
+
+/* Colors */
+$background-color: #f3f3f3 !default;
+$text-color: #343434 !default;
+$muted-text-color: #8e8b82 !default;
+$primary-color: #343434 !default;
+$border-color: #e9dcbe !default;
+$footer-background-color: #e9dcbe !default;
+$link-color: #343434 !default;
+$masthead-link-color: $text-color !default;
+$masthead-link-color-hover: $text-color !default;
+$navicon-link-color-hover: mix(#fff, $text-color, 80%) !default;
+
+/* dirt syntax highlighting (base16) */
+$base00: #231e18 !default;
+$base01: #302b25 !default;
+$base02: #48413a !default;
+$base03: #9d8b70 !default;
+$base04: #b4a490 !default;
+$base05: #cabcb1 !default;
+$base06: #d7c8bc !default;
+$base07: #e4d4c8 !default;
+$base08: #d35c5c !default;
+$base09: #ca7f32 !default;
+$base0a: #e0ac16 !default;
+$base0b: #b7ba53 !default;
+$base0c: #6eb958 !default;
+$base0d: #88a4d3 !default;
+$base0e: #bb90e2 !default;
+$base0f: #b49368 !default;
diff --git a/docs/_sass/minimal-mistakes/skins/_mint.scss b/docs/_sass/minimal-mistakes/skins/_mint.scss
new file mode 100644
index 00000000..575e977d
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/skins/_mint.scss
@@ -0,0 +1,23 @@
+/* ==========================================================================
+ Mint skin
+ ========================================================================== */
+
+/* Colors */
+$background-color: #f3f6f6 !default;
+$text-color: #40514e !default;
+$muted-text-color: #40514e !default;
+$primary-color: #11999e !default;
+$border-color: mix(#fff, #40514e, 75%) !default;
+$footer-background-color: #30e3ca !default;
+$link-color: #11999e !default;
+$masthead-link-color: $text-color !default;
+$masthead-link-color-hover: $text-color !default;
+$navicon-link-color-hover: mix(#fff, $text-color, 80%) !default;
+
+.page__footer {
+ color: #fff !important; // override
+}
+
+.page__footer-follow .social-icons .svg-inline--fa {
+ color: inherit;
+}
diff --git a/docs/_sass/minimal-mistakes/skins/_neon.scss b/docs/_sass/minimal-mistakes/skins/_neon.scss
new file mode 100644
index 00000000..5da3688f
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/skins/_neon.scss
@@ -0,0 +1,53 @@
+/* ==========================================================================
+ Neon skin
+ ========================================================================== */
+
+/* Colors */
+$background-color: #141010 !default;
+$text-color: #fff6fb !default;
+$primary-color: #f21368 !default;
+$border-color: mix(#fff, $background-color, 20%) !default;
+$code-background-color: mix(#000, $background-color, 15%) !default;
+$code-background-color-dark: mix(#000, $background-color, 20%) !default;
+$form-background-color: mix(#000, $background-color, 15%) !default;
+$footer-background-color: mix($primary-color, #000, 10%) !default;
+$link-color: $primary-color !default;
+$link-color-hover: mix(#fff, $link-color, 25%) !default;
+$link-color-visited: mix(#000, $link-color, 25%) !default;
+$masthead-link-color: $text-color !default;
+$masthead-link-color-hover: mix(#000, $text-color, 20%) !default;
+$navicon-link-color-hover: mix(#000, $background-color, 30%) !default;
+
+/* neon syntax highlighting (base16) */
+$base00: #ffffff !default;
+$base01: #e0e0e0 !default;
+$base02: #d0d0d0 !default;
+$base03: #b0b0b0 !default;
+$base04: #000000 !default;
+$base05: #101010 !default;
+$base06: #151515 !default;
+$base07: #202020 !default;
+$base08: #ff0086 !default;
+$base09: #fd8900 !default;
+$base0a: #aba800 !default;
+$base0b: #00c918 !default;
+$base0c: #1faaaa !default;
+$base0d: #3777e6 !default;
+$base0e: #ad00a1 !default;
+$base0f: #cc6633 !default;
+
+.author__urls.social-icons .svg-inline--fa,
+.page__footer-follow .social-icons .svg-inline--fa {
+ color: inherit;
+}
+
+/* next/previous buttons */
+.pagination--pager {
+ color: $text-color;
+ background-color: $primary-color;
+ border-color: transparent;
+
+ &:visited {
+ color: $text-color;
+ }
+}
diff --git a/docs/_sass/minimal-mistakes/skins/_plum.scss b/docs/_sass/minimal-mistakes/skins/_plum.scss
new file mode 100644
index 00000000..b777a8ea
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/skins/_plum.scss
@@ -0,0 +1,60 @@
+/* ==========================================================================
+ Plum skin
+ ========================================================================== */
+
+/* Colors */
+$background-color: #521477 !default;
+$text-color: #fffd86 !default;
+$primary-color: #c327ab !default;
+$border-color: mix(#fff, $background-color, 20%) !default;
+$code-background-color: mix(#000, $background-color, 15%) !default;
+$code-background-color-dark: mix(#000, $background-color, 20%) !default;
+$form-background-color: mix(#000, $background-color, 15%) !default;
+$footer-background-color: mix(#000, $background-color, 25%) !default;
+$link-color: $primary-color !default;
+$link-color-hover: mix(#fff, $link-color, 25%) !default;
+$link-color-visited: mix(#000, $link-color, 25%) !default;
+$masthead-link-color: $text-color !default;
+$masthead-link-color-hover: mix(#000, $text-color, 20%) !default;
+$navicon-link-color-hover: mix(#000, $background-color, 30%) !default;
+
+/* plum syntax highlighting (base16) */
+$base00: #ffffff !default;
+$base01: #e0e0e0 !default;
+$base02: #d0d0d0 !default;
+$base03: #b0b0b0 !default;
+$base04: #000000 !default;
+$base05: #101010 !default;
+$base06: #151515 !default;
+$base07: #202020 !default;
+$base08: #ff0086 !default;
+$base09: #fd8900 !default;
+$base0a: #aba800 !default;
+$base0b: #00c918 !default;
+$base0c: #1faaaa !default;
+$base0d: #3777e6 !default;
+$base0e: #ad00a1 !default;
+$base0f: #cc6633 !default;
+
+.author__urls.social-icons .svg-inline--fa,
+.page__footer-follow .social-icons .svg-inline--fa {
+ color: inherit;
+}
+
+.page__content {
+ a,
+ a:visited {
+ color: inherit;
+ }
+}
+
+/* next/previous buttons */
+.pagination--pager {
+ color: $text-color;
+ background-color: $primary-color;
+ border-color: transparent;
+
+ &:visited {
+ color: $text-color;
+ }
+}
diff --git a/docs/_sass/minimal-mistakes/skins/_sunrise.scss b/docs/_sass/minimal-mistakes/skins/_sunrise.scss
new file mode 100644
index 00000000..1f0dca39
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/skins/_sunrise.scss
@@ -0,0 +1,44 @@
+/* ==========================================================================
+ Sunrise skin
+ ========================================================================== */
+
+/* Colors */
+$dark-gray: #0e2431 !default;
+$background-color: #e8d5b7 !default;
+$text-color: #000 !default;
+$muted-text-color: $dark-gray !default;
+$primary-color: #fc3a52 !default;
+$border-color: mix(#000, $background-color, 20%) !default;
+$code-background-color: mix(#fff, $background-color, 20%) !default;
+$code-background-color-dark: mix(#000, $background-color, 10%) !default;
+$form-background-color: mix(#fff, $background-color, 15%) !default;
+$footer-background-color: #f9b248 !default;
+$link-color: mix(#000, $primary-color, 10%) !default;
+$link-color-hover: mix(#fff, $link-color, 25%) !default;
+$link-color-visited: mix(#000, $link-color, 25%) !default;
+$masthead-link-color: $text-color !default;
+$masthead-link-color-hover: mix(#000, $text-color, 20%) !default;
+$navicon-link-color-hover: mix(#000, $background-color, 30%) !default;
+
+/* sunrise syntax highlighting (base16) */
+$base00: #1d1f21 !default;
+$base01: #282a2e !default;
+$base02: #373b41 !default;
+$base03: #969896 !default;
+$base04: #b4b7b4 !default;
+$base05: #c5c8c6 !default;
+$base06: #e0e0e0 !default;
+$base07: #ffffff !default;
+$base08: #cc6666 !default;
+$base09: #de935f !default;
+$base0a: #f0c674 !default;
+$base0b: #b5bd68 !default;
+$base0c: #8abeb7 !default;
+$base0d: #81a2be !default;
+$base0e: #b294bb !default;
+$base0f: #a3685a !default;
+
+.author__urls.social-icons .fa,
+.page__footer-follow .social-icons .svg-inline--fa {
+ color: inherit;
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/_breakpoint.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/_breakpoint.scss
new file mode 100644
index 00000000..a0528eb8
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/_breakpoint.scss
@@ -0,0 +1,114 @@
+//////////////////////////////
+// Default Variables
+//////////////////////////////
+$Breakpoint-Settings: (
+ 'default media': all,
+ 'default feature': min-width,
+ 'default pair': width,
+
+ 'force all media type': false,
+ 'to ems': false,
+ 'transform resolutions': true,
+
+ 'no queries': false,
+ 'no query fallbacks': false,
+
+ 'base font size': 16px,
+
+ 'legacy syntax': false
+);
+
+$breakpoint: () !default;
+
+//////////////////////////////
+// Imports
+//////////////////////////////
+@import "settings";
+@import "context";
+@import "helpers";
+@import "parsers";
+@import "no-query";
+
+@import "respond-to";
+
+@import "legacy-settings";
+
+//////////////////////////////
+// Breakpoint Mixin
+//////////////////////////////
+
+@mixin breakpoint($query, $no-query: false) {
+ @include legacy-settings-warning;
+
+ // Reset contexts
+ @include private-breakpoint-reset-contexts();
+
+ $breakpoint: breakpoint($query, false);
+
+ $query-string: map-get($breakpoint, 'query');
+ $query-fallback: map-get($breakpoint, 'fallback');
+
+ $private-breakpoint-context-holder: map-get($breakpoint, 'context holder') !global;
+ $private-breakpoint-query-count: map-get($breakpoint, 'query count') !global;
+
+ // Allow for an as-needed override or usage of no query fallback.
+ @if $no-query != false {
+ $query-fallback: $no-query;
+ }
+
+ @if $query-fallback != false {
+ $context-setter: private-breakpoint-set-context('no-query', $query-fallback);
+ }
+
+ // Print Out Query String
+ @if not breakpoint-get('no queries') {
+ @media #{$query-string} {
+ @content;
+ }
+ }
+
+ @if breakpoint-get('no query fallbacks') != false or breakpoint-get('no queries') == true {
+
+ $type: type-of(breakpoint-get('no query fallbacks'));
+ $print: false;
+
+ @if ($type == 'bool') {
+ $print: true;
+ }
+ @else if ($type == 'string') {
+ @if $query-fallback == breakpoint-get('no query fallbacks') {
+ $print: true;
+ }
+ }
+ @else if ($type == 'list') {
+ @each $wrapper in breakpoint-get('no query fallbacks') {
+ @if $query-fallback == $wrapper {
+ $print: true;
+ }
+ }
+ }
+
+ // Write Fallback
+ @if ($query-fallback != false) and ($print == true) {
+ $type-fallback: type-of($query-fallback);
+
+ @if ($type-fallback != 'bool') {
+ #{$query-fallback} & {
+ @content;
+ }
+ }
+ @else {
+ @content;
+ }
+ }
+ }
+
+ @include private-breakpoint-reset-contexts();
+}
+
+
+@mixin mq($query, $no-query: false) {
+ @include breakpoint($query, $no-query) {
+ @content;
+ }
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/_context.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/_context.scss
new file mode 100644
index 00000000..57947f5c
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/_context.scss
@@ -0,0 +1,95 @@
+//////////////////////////////
+// Private Breakpoint Variables
+//////////////////////////////
+$private-breakpoint-context-holder: ();
+$private-breakpoint-query-count: 0 !default;
+
+//////////////////////////////
+// Breakpoint Has Context
+// Returns whether or not you are inside a Breakpoint query
+//////////////////////////////
+@function breakpoint-has-context() {
+ @if length($private-breakpoint-query-count) {
+ @return true;
+ }
+ @else {
+ @return false;
+ }
+}
+
+//////////////////////////////
+// Breakpoint Get Context
+// $feature: Input feature to get it's current MQ context. Returns false if no context
+//////////////////////////////
+@function breakpoint-get-context($feature) {
+ @if map-has-key($private-breakpoint-context-holder, $feature) {
+ $get: map-get($private-breakpoint-context-holder, $feature);
+ // Special handling of no-query from get side so /false/ prepends aren't returned
+ @if $feature == 'no-query' {
+ @if type-of($get) == 'list' and length($get) > 1 and nth($get, 1) == false {
+ $get: nth($get, length($get));
+ }
+ }
+ @return $get;
+ }
+ @else {
+ @if breakpoint-has-context() and $feature == 'media' {
+ @return breakpoint-get('default media');
+ }
+ @else {
+ @return false;
+ }
+ }
+}
+
+//////////////////////////////
+// Private function to set context
+//////////////////////////////
+@function private-breakpoint-set-context($feature, $value) {
+ @if $value == 'monochrome' {
+ $feature: 'monochrome';
+ }
+
+ $current: map-get($private-breakpoint-context-holder, $feature);
+ @if $current and length($current) == $private-breakpoint-query-count {
+ @warn "You have already queried against `#{$feature}`. Unexpected things may happen if you query against the same feature more than once in the same `and` query. Breakpoint is overwriting the current context with `#{$value}`";
+ }
+
+ @if not map-has-key($private-breakpoint-context-holder, $feature) {
+ $v-holder: ();
+ @for $i from 1 to $private-breakpoint-query-count {
+ @if $feature == 'media' {
+ $v-holder: append($v-holder, breakpoint-get('default media'));
+ }
+ @else {
+ $v-holder: append($v-holder, false);
+ }
+ }
+ $v-holder: append($v-holder, $value);
+ $private-breakpoint-context-holder: map-merge($private-breakpoint-context-holder, ($feature: $v-holder)) !global;
+ }
+ @else {
+ $v-holder: map-get($private-breakpoint-context-holder, $feature);
+ $length: length($v-holder);
+ @for $i from $length to $private-breakpoint-query-count - 1 {
+ @if $feature == 'media' {
+ $v-holder: append($v-holder, breakpoint-get('default media'));
+ }
+ @else {
+ $v-holder: append($v-holder, false);
+ }
+ }
+ $v-holder: append($v-holder, $value);
+ $private-breakpoint-context-holder: map-merge($private-breakpoint-context-holder, ($feature: $v-holder)) !global;
+ }
+
+ @return true;
+}
+
+//////////////////////////////
+// Private function to reset context
+//////////////////////////////
+@mixin private-breakpoint-reset-contexts {
+ $private-breakpoint-context-holder: () !global;
+ $private-breakpoint-query-count: 0 !global;
+}
\ No newline at end of file
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/_helpers.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/_helpers.scss
new file mode 100644
index 00000000..97e522d1
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/_helpers.scss
@@ -0,0 +1,151 @@
+//////////////////////////////
+// Converts the input value to Base EMs
+//////////////////////////////
+@function breakpoint-to-base-em($value) {
+ $value-unit: unit($value);
+
+ // Will convert relative EMs into root EMs.
+ @if breakpoint-get('base font size') and type-of(breakpoint-get('base font size')) == 'number' and $value-unit == 'em' {
+ $base-unit: unit(breakpoint-get('base font size'));
+
+ @if $base-unit == 'px' or $base-unit == '%' or $base-unit == 'em' or $base-unit == 'pt' {
+ @return base-conversion($value) / base-conversion(breakpoint-get('base font size')) * 1em;
+ }
+ @else {
+ @warn '#{breakpoint-get(\'base font size\')} is not set in valid units for font size!';
+ @return false;
+ }
+ }
+ @else {
+ @return base-conversion($value);
+ }
+}
+
+@function base-conversion($value) {
+ $unit: unit($value);
+
+ @if $unit == 'px' {
+ @return $value / 16px * 1em;
+ }
+ @else if $unit == '%' {
+ @return $value / 100% * 1em;
+ }
+ @else if $unit == 'em' {
+ @return $value;
+ }
+ @else if $unit == 'pt' {
+ @return $value / 12pt * 1em;
+ }
+ @else {
+ @return $value;
+// @warn 'Everything is terrible! What have you done?!';
+ }
+}
+
+//////////////////////////////
+// Returns whether the feature can have a min/max pair
+//////////////////////////////
+$breakpoint-min-max-features: 'color',
+ 'color-index',
+ 'aspect-ratio',
+ 'device-aspect-ratio',
+ 'device-height',
+ 'device-width',
+ 'height',
+ 'monochrome',
+ 'resolution',
+ 'width';
+
+@function breakpoint-min-max($feature) {
+ @each $item in $breakpoint-min-max-features {
+ @if $feature == $item {
+ @return true;
+ }
+ }
+ @return false;
+}
+
+//////////////////////////////
+// Returns whether the feature can have a string value
+//////////////////////////////
+$breakpoint-string-features: 'orientation',
+ 'scan',
+ 'color',
+ 'aspect-ratio',
+ 'device-aspect-ratio',
+ 'pointer',
+ 'luminosity';
+
+@function breakpoint-string-value($feature) {
+ @each $item in $breakpoint-string-features {
+ @if breakpoint-min-max($item) {
+ @if $feature == 'min-#{$item}' or $feature == 'max-#{$item}' {
+ @return true;
+ }
+ }
+ @else if $feature == $item {
+ @return true;
+ }
+ }
+ @return false;
+}
+
+//////////////////////////////
+// Returns whether the feature is a media type
+//////////////////////////////
+$breakpoint-media-types: 'all',
+ 'braille',
+ 'embossed',
+ 'handheld',
+ 'print',
+ 'projection',
+ 'screen',
+ 'speech',
+ 'tty',
+ 'tv';
+
+@function breakpoint-is-media($feature) {
+ @each $media in $breakpoint-media-types {
+ @if ($feature == $media) or ($feature == 'not #{$media}') or ($feature == 'only #{$media}') {
+ @return true;
+ }
+ }
+
+ @return false;
+}
+
+//////////////////////////////
+// Returns whether the feature can stand alone
+//////////////////////////////
+$breakpoint-single-string-features: 'color',
+ 'color-index',
+ 'grid',
+ 'monochrome';
+
+@function breakpoint-single-string($feature) {
+ @each $item in $breakpoint-single-string-features {
+ @if $feature == $item {
+ @return true;
+ }
+ }
+ @return false;
+}
+
+//////////////////////////////
+// Returns whether the feature
+//////////////////////////////
+@function breakpoint-is-resolution($feature) {
+ $resolutions: 'device-pixel-ratio', 'dpr';
+
+ @if breakpoint-get('transform resolutions') {
+ $resolutions: append($resolutions, 'resolution');
+ }
+
+ @each $reso in $resolutions {
+ @if index($feature, $reso) or index($feature, 'min-#{$reso}') or index($feature, 'max-#{$reso}') {
+ @return true;
+ }
+ }
+
+ @return false;
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/_legacy-settings.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/_legacy-settings.scss
new file mode 100644
index 00000000..e060ebe3
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/_legacy-settings.scss
@@ -0,0 +1,50 @@
+@mixin legacy-settings-warning {
+ $legacyVars: (
+ 'default-media': 'default media',
+ 'default-feature': 'default feature',
+ 'force-media-all': 'force all media type',
+ 'to-ems': 'to ems',
+ 'resolutions': 'transform resolutions',
+ 'no-queries': 'no queries',
+ 'no-query-fallbacks': 'no query fallbacks',
+ 'base-font-size': 'base font size',
+ 'legacy-syntax': 'legacy syntax'
+ );
+
+ @each $legacy, $new in $legacyVars {
+ @if global-variable-exists('breakpoint-' + $legacy) {
+ @warn "In order to avoid variable namspace collisions, we have updated the way to change settings for Breakpoint. Please change all instances of `$breakpoint-#{$legacy}: {{setting}}` to `@include breakpoint-set('#{$new}', {{setting}})`. Variable settings, as well as this warning will be deprecated in a future release."
+ }
+ };
+
+ //////////////////////////////
+ // Hand correct each setting
+ //////////////////////////////
+ @if global-variable-exists('breakpoint-default-media') and $breakpoint-default-media != breakpoint-get('default media') {
+ @include breakpoint-set('default media', $breakpoint-default-media);
+ }
+ @if global-variable-exists('breakpoint-default-feature') and $breakpoint-default-feature != breakpoint-get('default feature') {
+ @include breakpoint-set('default feature', $breakpoint-default-feature);
+ }
+ @if global-variable-exists('breakpoint-force-media-all') and $breakpoint-force-media-all != breakpoint-get('force all media type') {
+ @include breakpoint-set('force all media type', $breakpoint-force-media-all);
+ }
+ @if global-variable-exists('breakpoint-to-ems') and $breakpoint-to-ems != breakpoint-get('to ems') {
+ @include breakpoint-set('to ems', $breakpoint-to-ems);
+ }
+ @if global-variable-exists('breakpoint-resolutions') and $breakpoint-resolutions != breakpoint-get('transform resolutions') {
+ @include breakpoint-set('transform resolutions', $breakpoint-resolutions);
+ }
+ @if global-variable-exists('breakpoint-no-queries') and $breakpoint-no-queries != breakpoint-get('no queries') {
+ @include breakpoint-set('no queries', $breakpoint-no-queries);
+ }
+ @if global-variable-exists('breakpoint-no-query-fallbacks') and $breakpoint-no-query-fallbacks != breakpoint-get('no query fallbacks') {
+ @include breakpoint-set('no query fallbacks', $breakpoint-no-query-fallbacks);
+ }
+ @if global-variable-exists('breakpoint-base-font-size') and $breakpoint-base-font-size != breakpoint-get('base font size') {
+ @include breakpoint-set('base font size', $breakpoint-base-font-size);
+ }
+ @if global-variable-exists('breakpoint-legacy-syntax') and $breakpoint-legacy-syntax != breakpoint-get('legacy syntax') {
+ @include breakpoint-set('legacy syntax', $breakpoint-legacy-syntax);
+ }
+}
\ No newline at end of file
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/_no-query.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/_no-query.scss
new file mode 100644
index 00000000..0b5a81f6
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/_no-query.scss
@@ -0,0 +1,15 @@
+@function breakpoint-no-query($query) {
+ @if type-of($query) == 'list' {
+ $keyword: nth($query, 1);
+
+ @if type-of($keyword) == 'string' and ($keyword == 'no-query' or $keyword == 'no query' or $keyword == 'fallback') {
+ @return nth($query, 2);
+ }
+ @else {
+ @return false;
+ }
+ }
+ @else {
+ @return false;
+ }
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/_parsers.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/_parsers.scss
new file mode 100644
index 00000000..f0b053fe
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/_parsers.scss
@@ -0,0 +1,215 @@
+//////////////////////////////
+// Import Parser Pieces
+//////////////////////////////
+@import "parsers/query";
+@import "parsers/single";
+@import "parsers/double";
+@import "parsers/triple";
+@import "parsers/resolution";
+
+$Memo-Exists: function-exists(memo-get) and function-exists(memo-set);
+
+//////////////////////////////
+// Breakpoint Function
+//////////////////////////////
+@function breakpoint($query, $contexts...) {
+ $run: true;
+ $return: ();
+
+ // Grab the Memo Output if Memoization can be a thing
+ @if $Memo-Exists {
+ $return: memo-get(breakpoint, breakpoint $query $contexts);
+
+ @if $return != null {
+ $run: false;
+ }
+ }
+
+ @if not $Memo-Exists or $run {
+ // Internal Variables
+ $query-string: '';
+ $query-fallback: false;
+ $return: ();
+
+ // Reserve Global Private Breakpoint Context
+ $holder-context: $private-breakpoint-context-holder;
+ $holder-query-count: $private-breakpoint-query-count;
+
+ // Reset Global Private Breakpoint Context
+ $private-breakpoint-context-holder: () !global;
+ $private-breakpoint-query-count: 0 !global;
+
+
+ // Test to see if it's a comma-separated list
+ $or-list: if(list-separator($query) == 'comma', true, false);
+
+
+ @if ($or-list == false and breakpoint-get('legacy syntax') == false) {
+ $query-string: breakpoint-parse($query);
+ }
+ @else {
+ $length: length($query);
+
+ $last: nth($query, $length);
+ $query-fallback: breakpoint-no-query($last);
+
+ @if ($query-fallback != false) {
+ $length: $length - 1;
+ }
+
+ @if (breakpoint-get('legacy syntax') == true) {
+ $mq: ();
+
+ @for $i from 1 through $length {
+ $mq: append($mq, nth($query, $i), comma);
+ }
+
+ $query-string: breakpoint-parse($mq);
+ }
+ @else {
+ $query-string: '';
+ @for $i from 1 through $length {
+ $query-string: $query-string + if($i == 1, '', ', ') + breakpoint-parse(nth($query, $i));
+ }
+ }
+ }
+
+ $return: ('query': $query-string,
+ 'fallback': $query-fallback,
+ 'context holder': $private-breakpoint-context-holder,
+ 'query count': $private-breakpoint-query-count
+ );
+ @if length($contexts) > 0 and nth($contexts, 1) != false {
+ @if $query-fallback != false {
+ $context-setter: private-breakpoint-set-context('no-query', $query-fallback);
+ }
+ $context-map: ();
+ @each $context in $contexts {
+ $context-map: map-merge($context-map, ($context: breakpoint-get-context($context)));
+ }
+ $return: map-merge($return, (context: $context-map));
+ }
+
+ // Reset Global Private Breakpoint Context
+ $private-breakpoint-context-holder: () !global;
+ $private-breakpoint-query-count: 0 !global;
+
+ @if $Memo-Exists {
+ $holder: memo-set(breakpoint, breakpoint $query $contexts, $return);
+ }
+ }
+
+ @return $return;
+}
+
+//////////////////////////////
+// General Breakpoint Parser
+//////////////////////////////
+@function breakpoint-parse($query) {
+ // Increase number of 'and' queries
+ $private-breakpoint-query-count: $private-breakpoint-query-count + 1 !global;
+
+ // Set up Media Type
+ $query-print: '';
+
+ $force-all: ((breakpoint-get('force all media type') == true) and (breakpoint-get('default media') == 'all'));
+ $empty-media: true;
+ @if ($force-all == true) or (breakpoint-get('default media') != 'all') {
+ // Force the print of the default media type if (force all is true and default media type is all) or (default media type is not all)
+ $query-print: breakpoint-get('default media');
+ $empty-media: false;
+ }
+
+
+ $query-resolution: false;
+
+ $query-holder: breakpoint-parse-query($query);
+
+
+
+ // Loop over each parsed out query and write it to $query-print
+ $first: true;
+
+ @each $feature in $query-holder {
+ $length: length($feature);
+
+ // Parse a single feature
+ @if ($length == 1) {
+ // Feature is currently a list, grab the actual value
+ $feature: nth($feature, 1);
+
+ // Media Type must by convention be the first item, so it's safe to flat override $query-print, which right now should only be the default media type
+ @if (breakpoint-is-media($feature)) {
+ @if ($force-all == true) or ($feature != 'all') {
+ // Force the print of the default media type if (force all is true and default media type is all) or (default media type is not all)
+ $query-print: $feature;
+ $empty-media: false;
+
+ // Set Context
+ $context-setter: private-breakpoint-set-context(media, $query-print);
+ }
+ }
+ @else {
+ $parsed: breakpoint-parse-single($feature, $empty-media, $first);
+ $query-print: '#{$query-print} #{$parsed}';
+ $first: false;
+ }
+ }
+ // Parse a double feature
+ @else if ($length == 2) {
+ @if (breakpoint-is-resolution($feature) != false) {
+ $query-resolution: $feature;
+ }
+ @else {
+ $parsed: null;
+ // If it's a string/number pair,
+ // we check to see if one is a single-string value,
+ // then we parse it as a normal double
+ $alpha: nth($feature, 1);
+ $beta: nth($feature, 2);
+ @if breakpoint-single-string($alpha) or breakpoint-single-string($beta) {
+ $parsed: breakpoint-parse-single($alpha, $empty-media, $first);
+ $query-print: '#{$query-print} #{$parsed}';
+ $first: false;
+ $parsed: breakpoint-parse-single($beta, $empty-media, $first);
+ $query-print: '#{$query-print} #{$parsed}';
+ }
+ @else {
+ $parsed: breakpoint-parse-double($feature, $empty-media, $first);
+ $query-print: '#{$query-print} #{$parsed}';
+ $first: false;
+ }
+ }
+ }
+ // Parse a triple feature
+ @else if ($length == 3) {
+ $parsed: breakpoint-parse-triple($feature, $empty-media, $first);
+ $query-print: '#{$query-print} #{$parsed}';
+ $first: false;
+ }
+
+ }
+
+ @if ($query-resolution != false) {
+ $query-print: breakpoint-build-resolution($query-print, $query-resolution, $empty-media, $first);
+ }
+
+ // Loop through each feature that's been detected so far and append 'false' to the the value list to increment their counters
+ @each $f, $v in $private-breakpoint-context-holder {
+ $v-holder: $v;
+ $length: length($v-holder);
+ @if length($v-holder) < $private-breakpoint-query-count {
+ @for $i from $length to $private-breakpoint-query-count {
+ @if $f == 'media' {
+ $v-holder: append($v-holder, breakpoint-get('default media'));
+ }
+ @else {
+ $v-holder: append($v-holder, false);
+ }
+ }
+ }
+ $private-breakpoint-context-holder: map-merge($private-breakpoint-context-holder, ($f: $v-holder)) !global;
+ }
+
+ @return $query-print;
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/_respond-to.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/_respond-to.scss
new file mode 100644
index 00000000..e2462c5f
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/_respond-to.scss
@@ -0,0 +1,82 @@
+////////////////////////
+// Default the Breakpoints variable
+////////////////////////
+$breakpoints: () !default;
+$BREAKPOINTS: () !default;
+
+////////////////////////
+// Respond-to API Mixin
+////////////////////////
+@mixin respond-to($context, $no-query: false) {
+ @if length($breakpoints) > 0 and length($BREAKPOINTS) == 0 {
+ @warn "In order to avoid variable namespace collisions, we have updated the way to add breakpoints for respond-to. Please change all instances of `$breakpoints: add-breakpoint()` to `@include add-breakpoint()`. The `add-breakpoint()` function will be deprecated in a future release.";
+ $BREAKPOINTS: $breakpoints !global;
+ $breakpoints: () !global;
+ }
+
+ @if type-of($BREAKPOINTS) != 'map' {
+ // Just in case someone writes gibberish to the $breakpoints variable.
+ @warn "Your breakpoints aren't a map! `respond-to` expects a map. Please check the value of $BREAKPOINTS variable.";
+ @content;
+ }
+ @else if map-has-key($BREAKPOINTS, $context) {
+ @include breakpoint(map-get($BREAKPOINTS, $context), $no-query) {
+ @content;
+ }
+ }
+ @else if not map-has-key($BREAKPOINTS, $context) {
+ @warn "`#{$context}` isn't a defined breakpoint! Please add it using `$breakpoints: add-breakpoint(`#{$context}`, $value);`";
+ @content;
+ }
+ @else {
+ @warn "You haven't created any breakpoints yet! Make some already! `@include add-breakpoint($name, $bkpt)`";
+ @content;
+ }
+}
+
+//////////////////////////////
+// Add Breakpoint to Breakpoints
+// TODO: Remove function in next release
+//////////////////////////////
+@function add-breakpoint($name, $bkpt, $overwrite: false) {
+ $output: ($name: $bkpt);
+
+ @if length($breakpoints) == 0 {
+ @return $output;
+ }
+ @else {
+ @if map-has-key($breakpoints, $name) and $overwrite != true {
+ @warn "You already have a breakpoint named `#{$name}`, please choose another breakpoint name, or pass in `$overwrite: true` to overwrite the previous breakpoint.";
+ @return $breakpoints;
+ }
+ @else if not map-has-key($breakpoints, $name) or $overwrite == true {
+ @return map-merge($breakpoints, $output);
+ }
+ }
+}
+
+@mixin add-breakpoint($name, $bkpt, $overwrite: false) {
+ $output: ($name: $bkpt);
+
+ @if length($BREAKPOINTS) == 0 {
+ $BREAKPOINTS: $output !global;
+ }
+ @else {
+ @if map-has-key($BREAKPOINTS, $name) and $overwrite != true {
+ @warn "You already have a breakpoint named `#{$name}`, please choose another breakpoint name, or pass in `$overwrite: true` to overwrite the previous breakpoint.";
+ $BREAKPOINTS: $BREAKPOINTS !global;
+ }
+ @else if not map-has-key($BREAKPOINTS, $name) or $overwrite == true {
+ $BREAKPOINTS: map-merge($BREAKPOINTS, $output) !global;
+ }
+ }
+}
+
+@function get-breakpoint($name: false) {
+ @if $name == false {
+ @return $BREAKPOINTS;
+ }
+ @else {
+ @return map-get($BREAKPOINTS, $name);
+ }
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/_settings.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/_settings.scss
new file mode 100644
index 00000000..05ee6894
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/_settings.scss
@@ -0,0 +1,71 @@
+//////////////////////////////
+// Has Setting
+//////////////////////////////
+@function breakpoint-has($setting) {
+ @if map-has-key($breakpoint, $setting) {
+ @return true;
+ }
+ @else {
+ @return false;
+ }
+}
+
+//////////////////////////////
+// Get Settings
+//////////////////////////////
+@function breakpoint-get($setting) {
+ @if breakpoint-has($setting) {
+ @return map-get($breakpoint, $setting);
+ }
+ @else {
+ @return map-get($Breakpoint-Settings, $setting);
+ }
+}
+
+//////////////////////////////
+// Set Settings
+//////////////////////////////
+@function breakpoint-set($setting, $value) {
+ @if (str-index($setting, '-') or str-index($setting, '_')) and str-index($setting, ' ') == null {
+ @warn "Words in Breakpoint settings should be separated by spaces, not dashes or underscores. Please replace dashes and underscores between words with spaces. Settings will not work as expected until changed.";
+ }
+ $breakpoint: map-merge($breakpoint, ($setting: $value)) !global;
+ @return true;
+}
+
+@mixin breakpoint-change($setting, $value) {
+ $breakpoint-change: breakpoint-set($setting, $value);
+}
+
+@mixin breakpoint-set($setting, $value) {
+ @include breakpoint-change($setting, $value);
+}
+
+@mixin bkpt-change($setting, $value) {
+ @include breakpoint-change($setting, $value);
+}
+@mixin bkpt-set($setting, $value) {
+ @include breakpoint-change($setting, $value);
+}
+
+//////////////////////////////
+// Remove Setting
+//////////////////////////////
+@function breakpoint-reset($settings...) {
+ @if length($settings) == 1 {
+ $settings: nth($settings, 1);
+ }
+
+ @each $setting in $settings {
+ $breakpoint: map-remove($breakpoint, $setting) !global;
+ }
+ @return true;
+}
+
+@mixin breakpoint-reset($settings...) {
+ $breakpoint-reset: breakpoint-reset($settings);
+}
+
+@mixin bkpt-reset($settings...) {
+ $breakpoint-reset: breakpoint-reset($settings);
+}
\ No newline at end of file
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_double.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_double.scss
new file mode 100644
index 00000000..24580c15
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_double.scss
@@ -0,0 +1,33 @@
+//////////////////////////////
+// Import Pieces
+//////////////////////////////
+@import "double/default-pair";
+@import "double/double-string";
+@import "double/default";
+
+@function breakpoint-parse-double($feature, $empty-media, $first) {
+ $parsed: '';
+ $leader: '';
+ // If we're forcing
+ @if not ($empty-media) or not ($first) {
+ $leader: 'and ';
+ }
+
+ $first: nth($feature, 1);
+ $second: nth($feature, 2);
+
+ // If we've got two numbers, we know we need to use the default pair because there are no media queries that has a media feature that is a number
+ @if type-of($first) == 'number' and type-of($second) == 'number' {
+ $parsed: breakpoint-parse-default-pair($first, $second);
+ }
+ // If they are both strings, we send it through the string parser
+ @else if type-of($first) == 'string' and type-of($second) == 'string' {
+ $parsed: breakpoint-parse-double-string($first, $second);
+ }
+ // If it's a string/number pair, we parse it as a normal double
+ @else {
+ $parsed: breakpoint-parse-double-default($first, $second);
+ }
+
+ @return $leader + $parsed;
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_query.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_query.scss
new file mode 100644
index 00000000..b138b393
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_query.scss
@@ -0,0 +1,82 @@
+@function breakpoint-parse-query($query) {
+ // Parse features out of an individual query
+ $feature-holder: ();
+ $query-holder: ();
+ $length: length($query);
+
+ @if $length == 2 {
+ // If we've got a string/number, number/string, check to see if it's a valid string/number pair or two singles
+ @if (type-of(nth($query, 1)) == 'string' and type-of(nth($query, 2)) == 'number') or (type-of(nth($query, 1)) == 'number' and type-of(nth($query, 2)) == 'string') {
+
+ $number: '';
+ $value: '';
+
+ @if type-of(nth($query, 1)) == 'string' {
+ $number: nth($query, 2);
+ $value: nth($query, 1);
+ }
+ @else {
+ $number: nth($query, 1);
+ $value: nth($query, 2);
+ }
+
+ // If the string value can be a single value, check to see if the number passed in is a valid input for said single value. Fortunately, all current single-value options only accept unitless numbers, so this check is easy.
+ @if breakpoint-single-string($value) {
+ @if unitless($number) {
+ $feature-holder: append($value, $number, space);
+ $query-holder: append($query-holder, $feature-holder, comma);
+ @return $query-holder;
+ }
+ }
+ // If the string is a media type, split the query
+ @if breakpoint-is-media($value) {
+ $query-holder: append($query-holder, nth($query, 1));
+ $query-holder: append($query-holder, nth($query, 2));
+ @return $query-holder;
+ }
+ // If it's not a single feature, we're just going to assume it's a proper string/value pair, and roll with it.
+ @else {
+ $feature-holder: append($value, $number, space);
+ $query-holder: append($query-holder, $feature-holder, comma);
+ @return $query-holder;
+ }
+
+ }
+ // If they're both numbers, we assume it's a double and roll with that
+ @else if (type-of(nth($query, 1)) == 'number' and type-of(nth($query, 2)) == 'number') {
+ $feature-holder: append(nth($query, 1), nth($query, 2), space);
+ $query-holder: append($query-holder, $feature-holder, comma);
+ @return $query-holder;
+ }
+ // If they're both strings and neither are singles, we roll with that.
+ @else if (type-of(nth($query, 1)) == 'string' and type-of(nth($query, 2)) == 'string') {
+ @if not breakpoint-single-string(nth($query, 1)) and not breakpoint-single-string(nth($query, 2)) {
+ $feature-holder: append(nth($query, 1), nth($query, 2), space);
+ $query-holder: append($query-holder, $feature-holder, comma);
+ @return $query-holder;
+ }
+ }
+ }
+ @else if $length == 3 {
+ // If we've got three items and none is a list, we check to see
+ @if type-of(nth($query, 1)) != 'list' and type-of(nth($query, 2)) != 'list' and type-of(nth($query, 3)) != 'list' {
+ // If none of the items are single string values and none of the values are media values, we're good.
+ @if (not breakpoint-single-string(nth($query, 1)) and not breakpoint-single-string(nth($query, 2)) and not breakpoint-single-string(nth($query, 3))) and ((not breakpoint-is-media(nth($query, 1)) and not breakpoint-is-media(nth($query, 2)) and not breakpoint-is-media(nth($query, 3)))) {
+ $feature-holder: append(nth($query, 1), nth($query, 2), space);
+ $feature-holder: append($feature-holder, nth($query, 3), space);
+ $query-holder: append($query-holder, $feature-holder, comma);
+ @return $query-holder;
+ }
+ // let's check to see if the first item is a media type
+ @else if breakpoint-is-media(nth($query, 1)) {
+ $query-holder: append($query-holder, nth($query, 1));
+ $feature-holder: append(nth($query, 2), nth($query, 3), space);
+ $query-holder: append($query-holder, $feature-holder);
+ @return $query-holder;
+ }
+ }
+ }
+
+ // If it's a single item, or if it's not a special case double or triple, we can simply return the query.
+ @return $query;
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_resolution.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_resolution.scss
new file mode 100644
index 00000000..19769adf
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_resolution.scss
@@ -0,0 +1,31 @@
+@import "resolution/resolution";
+
+@function breakpoint-build-resolution($query-print, $query-resolution, $empty-media, $first) {
+ $leader: '';
+ // If we're forcing
+ @if not ($empty-media) or not ($first) {
+ $leader: 'and ';
+ }
+
+ @if breakpoint-get('transform resolutions') and $query-resolution {
+ $resolutions: breakpoint-make-resolutions($query-resolution);
+ $length: length($resolutions);
+ $query-holder: '';
+
+ @for $i from 1 through $length {
+ $query: '#{$query-print} #{$leader}#{nth($resolutions, $i)}';
+ @if $i == 1 {
+ $query-holder: $query;
+ }
+ @else {
+ $query-holder: '#{$query-holder}, #{$query}';
+ }
+ }
+
+ @return $query-holder;
+ }
+ @else {
+ // Return with attached resolution
+ @return $query-print;
+ }
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_single.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_single.scss
new file mode 100644
index 00000000..d9fd764a
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_single.scss
@@ -0,0 +1,26 @@
+//////////////////////////////
+// Import Pieces
+//////////////////////////////
+@import "single/default";
+
+@function breakpoint-parse-single($feature, $empty-media, $first) {
+ $parsed: '';
+ $leader: '';
+ // If we're forcing
+ @if not ($empty-media) or not ($first) {
+ $leader: 'and ';
+ }
+
+ // If it's a single feature that can stand alone, we let it
+ @if (breakpoint-single-string($feature)) {
+ $parsed: $feature;
+ // Set Context
+ $context-setter: private-breakpoint-set-context($feature, $feature);
+ }
+ // If it's not a stand alone feature, we pass it off to the default handler.
+ @else {
+ $parsed: breakpoint-parse-default($feature);
+ }
+
+ @return $leader + '(' + $parsed + ')';
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_triple.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_triple.scss
new file mode 100644
index 00000000..e2732067
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/_triple.scss
@@ -0,0 +1,36 @@
+//////////////////////////////
+// Import Pieces
+//////////////////////////////
+@import "triple/default";
+
+@function breakpoint-parse-triple($feature, $empty-media, $first) {
+ $parsed: '';
+ $leader: '';
+
+ // If we're forcing
+ @if not ($empty-media) or not ($first) {
+ $leader: 'and ';
+ }
+
+ // separate the string features from the value numbers
+ $string: null;
+ $numbers: null;
+ @each $val in $feature {
+ @if type-of($val) == string {
+ $string: $val;
+ }
+ @else {
+ @if type-of($numbers) == 'null' {
+ $numbers: $val;
+ }
+ @else {
+ $numbers: append($numbers, $val);
+ }
+ }
+ }
+
+ $parsed: breakpoint-parse-triple-default($string, nth($numbers, 1), nth($numbers, 2));
+
+ @return $leader + $parsed;
+
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/double/_default-pair.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/double/_default-pair.scss
new file mode 100644
index 00000000..f88432cc
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/double/_default-pair.scss
@@ -0,0 +1,21 @@
+@function breakpoint-parse-default-pair($first, $second) {
+ $default: breakpoint-get('default pair');
+ $min: '';
+ $max: '';
+
+ // Sort into min and max
+ $min: min($first, $second);
+ $max: max($first, $second);
+
+ // Set Context
+ $context-setter: private-breakpoint-set-context(min-#{$default}, $min);
+ $context-setter: private-breakpoint-set-context(max-#{$default}, $max);
+
+ // Make them EMs if need be
+ @if (breakpoint-get('to ems') == true) {
+ $min: breakpoint-to-base-em($min);
+ $max: breakpoint-to-base-em($max);
+ }
+
+ @return '(min-#{$default}: #{$min}) and (max-#{$default}: #{$max})';
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/double/_default.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/double/_default.scss
new file mode 100644
index 00000000..73190ed5
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/double/_default.scss
@@ -0,0 +1,22 @@
+@function breakpoint-parse-double-default($first, $second) {
+ $feature: '';
+ $value: '';
+
+ @if type-of($first) == 'string' {
+ $feature: $first;
+ $value: $second;
+ }
+ @else {
+ $feature: $second;
+ $value: $first;
+ }
+
+ // Set Context
+ $context-setter: private-breakpoint-set-context($feature, $value);
+
+ @if (breakpoint-get('to ems') == true) {
+ $value: breakpoint-to-base-em($value);
+ }
+
+ @return '(#{$feature}: #{$value})'
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/double/_double-string.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/double/_double-string.scss
new file mode 100644
index 00000000..c6fd0cb0
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/double/_double-string.scss
@@ -0,0 +1,22 @@
+@function breakpoint-parse-double-string($first, $second) {
+ $feature: '';
+ $value: '';
+
+ // Test to see which is the feature and which is the value
+ @if (breakpoint-string-value($first) == true) {
+ $feature: $first;
+ $value: $second;
+ }
+ @else if (breakpoint-string-value($second) == true) {
+ $feature: $second;
+ $value: $first;
+ }
+ @else {
+ @warn "Neither #{$first} nor #{$second} is a valid media query name.";
+ }
+
+ // Set Context
+ $context-setter: private-breakpoint-set-context($feature, $value);
+
+ @return '(#{$feature}: #{$value})';
+}
\ No newline at end of file
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/resolution/_resolution.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/resolution/_resolution.scss
new file mode 100644
index 00000000..36804212
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/resolution/_resolution.scss
@@ -0,0 +1,60 @@
+@function breakpoint-make-resolutions($resolution) {
+ $length: length($resolution);
+
+ $output: ();
+
+ @if $length == 2 {
+ $feature: '';
+ $value: '';
+
+ // Find which is number
+ @if type-of(nth($resolution, 1)) == 'number' {
+ $value: nth($resolution, 1);
+ }
+ @else {
+ $value: nth($resolution, 2);
+ }
+
+ // Determine min/max/standard
+ @if index($resolution, 'min-resolution') {
+ $feature: 'min-';
+ }
+ @else if index($resolution, 'max-resolution') {
+ $feature: 'max-';
+ }
+
+ $standard: '(#{$feature}resolution: #{$value})';
+
+ // If we're not dealing with dppx,
+ @if unit($value) != 'dppx' {
+ $base: 96dpi;
+ @if unit($value) == 'dpcm' {
+ $base: 243.84dpcm;
+ }
+ // Write out feature tests
+ $webkit: '';
+ $moz: '';
+ $webkit: '(-webkit-#{$feature}device-pixel-ratio: #{$value / $base})';
+ $moz: '(#{$feature}-moz-device-pixel-ratio: #{$value / $base})';
+ // Append to output
+ $output: append($output, $standard, space);
+ $output: append($output, $webkit, space);
+ $output: append($output, $moz, space);
+ }
+ @else {
+ $webkit: '';
+ $moz: '';
+ $webkit: '(-webkit-#{$feature}device-pixel-ratio: #{$value / 1dppx})';
+ $moz: '(#{$feature}-moz-device-pixel-ratio: #{$value / 1dppx})';
+ $fallback: '(#{$feature}resolution: #{$value / 1dppx * 96dpi})';
+ // Append to output
+ $output: append($output, $standard, space);
+ $output: append($output, $webkit, space);
+ $output: append($output, $moz, space);
+ $output: append($output, $fallback, space);
+ }
+
+ }
+
+ @return $output;
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/single/_default.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/single/_default.scss
new file mode 100644
index 00000000..503ef427
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/single/_default.scss
@@ -0,0 +1,13 @@
+@function breakpoint-parse-default($feature) {
+ $default: breakpoint-get('default feature');
+
+ // Set Context
+ $context-setter: private-breakpoint-set-context($default, $feature);
+
+ @if (breakpoint-get('to ems') == true) and (type-of($feature) == 'number') {
+ @return '#{$default}: #{breakpoint-to-base-em($feature)}';
+ }
+ @else {
+ @return '#{$default}: #{$feature}';
+ }
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/triple/_default.scss b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/triple/_default.scss
new file mode 100644
index 00000000..7fa418dd
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/breakpoint/parsers/triple/_default.scss
@@ -0,0 +1,18 @@
+@function breakpoint-parse-triple-default($feature, $first, $second) {
+
+ // Sort into min and max
+ $min: min($first, $second);
+ $max: max($first, $second);
+
+ // Set Context
+ $context-setter: private-breakpoint-set-context(min-#{$feature}, $min);
+ $context-setter: private-breakpoint-set-context(max-#{$feature}, $max);
+
+ // Make them EMs if need be
+ @if (breakpoint-get('to ems') == true) {
+ $min: breakpoint-to-base-em($min);
+ $max: breakpoint-to-base-em($max);
+ }
+
+ @return '(min-#{$feature}: #{$min}) and (max-#{$feature}: #{$max})';
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/magnific-popup/_magnific-popup.scss b/docs/_sass/minimal-mistakes/vendor/magnific-popup/_magnific-popup.scss
new file mode 100644
index 00000000..27b27bcc
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/magnific-popup/_magnific-popup.scss
@@ -0,0 +1,649 @@
+/* Magnific Popup CSS */
+
+@import "settings";
+
+////////////////////////
+//
+// Contents:
+//
+// 1. Default Settings
+// 2. General styles
+// - Transluscent overlay
+// - Containers, wrappers
+// - Cursors
+// - Helper classes
+// 3. Appearance
+// - Preloader & text that displays error messages
+// - CSS reset for buttons
+// - Close icon
+// - "1 of X" counter
+// - Navigation (left/right) arrows
+// - Iframe content type styles
+// - Image content type styles
+// - Media query where size of arrows is reduced
+// - IE7 support
+//
+////////////////////////
+
+
+
+////////////////////////
+// 1. Default Settings
+////////////////////////
+
+$mfp-overlay-color: #0b0b0b !default;
+$mfp-overlay-opacity: 0.8 !default;
+$mfp-shadow: 0 0 8px rgba(0, 0, 0, 0.6) !default; // shadow on image or iframe
+$mfp-popup-padding-left: 8px !default; // Padding from left and from right side
+$mfp-popup-padding-left-mobile: 6px !default; // Same as above, but is applied when width of window is less than 800px
+
+$mfp-z-index-base: 1040 !default; // Base z-index of popup
+$mfp-include-arrows: true !default; // include styles for nav arrows
+$mfp-controls-opacity: 0.65 !default;
+$mfp-controls-color: #FFF !default;
+$mfp-controls-border-color: #3F3F3F !default;
+$mfp-inner-close-icon-color: #333 !default;
+$mfp-controls-text-color: #CCC !default; // Color of preloader and "1 of X" indicator
+$mfp-controls-text-color-hover: #FFF !default;
+$mfp-IE7support: true !default; // Very basic IE7 support
+
+// Iframe-type options
+$mfp-include-iframe-type: true !default;
+$mfp-iframe-padding-top: 40px !default;
+$mfp-iframe-background: #000 !default;
+$mfp-iframe-max-width: 900px !default;
+$mfp-iframe-ratio: 9/16 !default;
+
+// Image-type options
+$mfp-include-image-type: true !default;
+$mfp-image-background: #444 !default;
+$mfp-image-padding-top: 40px !default;
+$mfp-image-padding-bottom: 40px !default;
+$mfp-include-mobile-layout-for-image: true !default; // Removes paddings from top and bottom
+
+// Image caption options
+$mfp-caption-title-color: #F3F3F3 !default;
+$mfp-caption-subtitle-color: #BDBDBD !default;
+
+// A11y
+$mfp-use-visuallyhidden: false !default; // Hide content from browsers, but make it available for screen readers
+
+
+
+////////////////////////
+// 2. General styles
+////////////////////////
+
+// Transluscent overlay
+.mfp-bg {
+ top: 0;
+ left: 0;
+ width: 100%;
+ height: 100%;
+ z-index: $mfp-z-index-base + 2;
+ overflow: hidden;
+ position: fixed;
+
+ background: $mfp-overlay-color;
+ opacity: $mfp-overlay-opacity;
+ @if $mfp-IE7support {
+ filter: unquote("alpha(opacity=#{$mfp-overlay-opacity*100})");
+ }
+}
+
+// Wrapper for popup
+.mfp-wrap {
+ top: 0;
+ left: 0;
+ width: 100%;
+ height: 100%;
+ z-index: $mfp-z-index-base + 3;
+ position: fixed;
+ outline: none !important;
+ -webkit-backface-visibility: hidden; // fixes webkit bug that can cause "false" scrollbar
+}
+
+// Root container
+.mfp-container {
+ text-align: center;
+ position: absolute;
+ width: 100%;
+ height: 100%;
+ left: 0;
+ top: 0;
+ padding: 0 $mfp-popup-padding-left;
+ -webkit-box-sizing: border-box;
+ -moz-box-sizing: border-box;
+ box-sizing: border-box;
+}
+
+// Vertical centerer helper
+.mfp-container {
+ &:before {
+ content: '';
+ display: inline-block;
+ height: 100%;
+ vertical-align: middle;
+ }
+}
+
+// Remove vertical centering when popup has class `mfp-align-top`
+.mfp-align-top {
+ .mfp-container {
+ &:before {
+ display: none;
+ }
+ }
+}
+
+// Popup content holder
+.mfp-content {
+ position: relative;
+ display: inline-block;
+ vertical-align: middle;
+ margin: 0 auto;
+ text-align: left;
+ z-index: $mfp-z-index-base + 5;
+}
+.mfp-inline-holder,
+.mfp-ajax-holder {
+ .mfp-content {
+ width: 100%;
+ cursor: auto;
+ }
+}
+
+// Cursors
+.mfp-ajax-cur {
+ cursor: progress;
+}
+.mfp-zoom-out-cur {
+ &, .mfp-image-holder .mfp-close {
+ cursor: -moz-zoom-out;
+ cursor: -webkit-zoom-out;
+ cursor: zoom-out;
+ }
+}
+.mfp-zoom {
+ cursor: pointer;
+ cursor: -webkit-zoom-in;
+ cursor: -moz-zoom-in;
+ cursor: zoom-in;
+}
+.mfp-auto-cursor {
+ .mfp-content {
+ cursor: auto;
+ }
+}
+
+.mfp-close,
+.mfp-arrow,
+.mfp-preloader,
+.mfp-counter {
+ -webkit-user-select:none;
+ -moz-user-select: none;
+ user-select: none;
+}
+
+// Hide the image during the loading
+.mfp-loading {
+ &.mfp-figure {
+ display: none;
+ }
+}
+
+// Helper class that hides stuff
+@if $mfp-use-visuallyhidden {
+ // From HTML5 Boilerplate https://github.com/h5bp/html5-boilerplate/blob/v4.2.0/doc/css.md#visuallyhidden
+ .mfp-hide {
+ border: 0 !important;
+ clip: rect(0 0 0 0) !important;
+ height: 1px !important;
+ margin: -1px !important;
+ overflow: hidden !important;
+ padding: 0 !important;
+ position: absolute !important;
+ width: 1px !important;
+ }
+} @else {
+ .mfp-hide {
+ display: none !important;
+ }
+}
+
+
+////////////////////////
+// 3. Appearance
+////////////////////////
+
+// Preloader and text that displays error messages
+.mfp-preloader {
+ color: $mfp-controls-text-color;
+ position: absolute;
+ top: 50%;
+ width: auto;
+ text-align: center;
+ margin-top: -0.8em;
+ left: 8px;
+ right: 8px;
+ z-index: $mfp-z-index-base + 4;
+ a {
+ color: $mfp-controls-text-color;
+ &:hover {
+ color: $mfp-controls-text-color-hover;
+ }
+ }
+}
+
+// Hide preloader when content successfully loaded
+.mfp-s-ready {
+ .mfp-preloader {
+ display: none;
+ }
+}
+
+// Hide content when it was not loaded
+.mfp-s-error {
+ .mfp-content {
+ display: none;
+ }
+}
+
+// CSS-reset for buttons
+button {
+ &.mfp-close,
+ &.mfp-arrow {
+ overflow: visible;
+ cursor: pointer;
+ background: transparent;
+ border: 0;
+ -webkit-appearance: none;
+ display: block;
+ outline: none;
+ padding: 0;
+ z-index: $mfp-z-index-base + 6;
+ -webkit-box-shadow: none;
+ box-shadow: none;
+ }
+ &::-moz-focus-inner {
+ padding: 0;
+ border: 0
+ }
+}
+
+
+// Close icon
+.mfp-close {
+ width: 44px;
+ height: 44px;
+ line-height: 44px;
+
+ position: absolute;
+ right: 0;
+ top: 0;
+ text-decoration: none;
+ text-align: center;
+ opacity: $mfp-controls-opacity;
+ @if $mfp-IE7support {
+ filter: unquote("alpha(opacity=#{$mfp-controls-opacity*100})");
+ }
+ padding: 0 0 18px 10px;
+ color: $mfp-controls-color;
+
+ font-style: normal;
+ font-size: 28px;
+ font-family: $serif;
+
+ &:hover,
+ &:focus {
+ opacity: 1;
+ @if $mfp-IE7support {
+ filter: unquote("alpha(opacity=#{1*100})");
+ }
+ }
+
+ &:active {
+ top: 1px;
+ }
+}
+.mfp-close-btn-in {
+ .mfp-close {
+ color: $mfp-inner-close-icon-color;
+ }
+}
+.mfp-image-holder,
+.mfp-iframe-holder {
+ .mfp-close {
+ color: $mfp-controls-color;
+ right: -6px;
+ text-align: right;
+ padding-right: 6px;
+ width: 100%;
+ }
+}
+
+// "1 of X" counter
+.mfp-counter {
+ position: absolute;
+ top: 0;
+ right: 0;
+ color: $mfp-controls-text-color;
+ font-size: 12px;
+ line-height: 18px;
+}
+
+// Navigation arrows
+@if $mfp-include-arrows {
+ .mfp-arrow {
+ position: absolute;
+ opacity: $mfp-controls-opacity;
+ @if $mfp-IE7support {
+ filter: unquote("alpha(opacity=#{$mfp-controls-opacity*100})");
+ }
+ margin: 0;
+ top: 50%;
+ margin-top: -55px;
+ padding: 0;
+ width: 90px;
+ height: 110px;
+ -webkit-tap-highlight-color: rgba(0,0,0,0);
+ &:active {
+ margin-top: -54px;
+ }
+ &:hover,
+ &:focus {
+ opacity: 1;
+ @if $mfp-IE7support {
+ filter: unquote("alpha(opacity=#{1*100})");
+ }
+ }
+ &:before,
+ &:after,
+ .mfp-b,
+ .mfp-a {
+ content: '';
+ display: block;
+ width: 0;
+ height: 0;
+ position: absolute;
+ left: 0;
+ top: 0;
+ margin-top: 35px;
+ margin-left: 35px;
+ border: medium inset transparent;
+ }
+
+ &:after,
+ .mfp-a {
+
+ border-top-width: 13px;
+ border-bottom-width: 13px;
+ top:8px;
+ }
+
+ &:before,
+ .mfp-b {
+ border-top-width: 21px;
+ border-bottom-width: 21px;
+ opacity: 0.7;
+ }
+
+ }
+
+ .mfp-arrow-left {
+ left: 0;
+
+ &:after,
+ .mfp-a {
+ border-right: 17px solid $mfp-controls-color;
+ margin-left: 31px;
+ }
+ &:before,
+ .mfp-b {
+ margin-left: 25px;
+ border-right: 27px solid $mfp-controls-border-color;
+ }
+ }
+
+ .mfp-arrow-right {
+ right: 0;
+ &:after,
+ .mfp-a {
+ border-left: 17px solid $mfp-controls-color;
+ margin-left: 39px
+ }
+ &:before,
+ .mfp-b {
+ border-left: 27px solid $mfp-controls-border-color;
+ }
+ }
+}
+
+
+
+// Iframe content type
+@if $mfp-include-iframe-type {
+ .mfp-iframe-holder {
+ padding-top: $mfp-iframe-padding-top;
+ padding-bottom: $mfp-iframe-padding-top;
+ .mfp-content {
+ line-height: 0;
+ width: 100%;
+ max-width: $mfp-iframe-max-width;
+ }
+ .mfp-close {
+ top: -40px;
+ }
+ }
+ .mfp-iframe-scaler {
+ width: 100%;
+ height: 0;
+ overflow: hidden;
+ padding-top: $mfp-iframe-ratio * 100%;
+ iframe {
+ position: absolute;
+ display: block;
+ top: 0;
+ left: 0;
+ width: 100%;
+ height: 100%;
+ box-shadow: $mfp-shadow;
+ background: $mfp-iframe-background;
+ }
+ }
+}
+
+
+
+// Image content type
+@if $mfp-include-image-type {
+
+ /* Main image in popup */
+ img {
+ &.mfp-img {
+ width: auto;
+ max-width: 100%;
+ height: auto;
+ display: block;
+ line-height: 0;
+ -webkit-box-sizing: border-box;
+ -moz-box-sizing: border-box;
+ box-sizing: border-box;
+ padding: $mfp-image-padding-top 0 $mfp-image-padding-bottom;
+ margin: 0 auto;
+ }
+ }
+
+ /* The shadow behind the image */
+ .mfp-figure {
+ line-height: 0;
+ &:after {
+ content: '';
+ position: absolute;
+ left: 0;
+ top: $mfp-image-padding-top;
+ bottom: $mfp-image-padding-bottom;
+ display: block;
+ right: 0;
+ width: auto;
+ height: auto;
+ z-index: -1;
+ box-shadow: $mfp-shadow;
+ background: $mfp-image-background;
+ }
+ small {
+ color: $mfp-caption-subtitle-color;
+ display: block;
+ font-size: 12px;
+ line-height: 14px;
+ }
+ figure {
+ margin: 0;
+ }
+ figcaption {
+ margin-top: 0;
+ margin-bottom: 0; // reset for bottom spacing
+ }
+ }
+ .mfp-bottom-bar {
+ margin-top: -$mfp-image-padding-bottom + 4;
+ position: absolute;
+ top: 100%;
+ left: 0;
+ width: 100%;
+ cursor: auto;
+ }
+ .mfp-title {
+ text-align: left;
+ line-height: 18px;
+ color: $mfp-caption-title-color;
+ word-wrap: break-word;
+ padding-right: 36px; // leave some space for counter at right side
+ }
+
+ .mfp-image-holder {
+ .mfp-content {
+ max-width: 100%;
+ }
+ }
+
+ .mfp-gallery {
+ .mfp-image-holder {
+ .mfp-figure {
+ cursor: pointer;
+ }
+ }
+ }
+
+
+ @if $mfp-include-mobile-layout-for-image {
+ @media screen and (max-width: 800px) and (orientation:landscape), screen and (max-height: 300px) {
+ /**
+ * Remove all paddings around the image on small screen
+ */
+ .mfp-img-mobile {
+ .mfp-image-holder {
+ padding-left: 0;
+ padding-right: 0;
+ }
+ img {
+ &.mfp-img {
+ padding: 0;
+ }
+ }
+ .mfp-figure {
+ // The shadow behind the image
+ &:after {
+ top: 0;
+ bottom: 0;
+ }
+ small {
+ display: inline;
+ margin-left: 5px;
+ }
+ }
+ .mfp-bottom-bar {
+ background: rgba(0,0,0,0.6);
+ bottom: 0;
+ margin: 0;
+ top: auto;
+ padding: 3px 5px;
+ position: fixed;
+ -webkit-box-sizing: border-box;
+ -moz-box-sizing: border-box;
+ box-sizing: border-box;
+ &:empty {
+ padding: 0;
+ }
+ }
+ .mfp-counter {
+ right: 5px;
+ top: 3px;
+ }
+ .mfp-close {
+ top: 0;
+ right: 0;
+ width: 35px;
+ height: 35px;
+ line-height: 35px;
+ background: rgba(0, 0, 0, 0.6);
+ position: fixed;
+ text-align: center;
+ padding: 0;
+ }
+ }
+ }
+ }
+}
+
+
+
+// Scale navigation arrows and reduce padding from sides
+@media all and (max-width: 900px) {
+ .mfp-arrow {
+ -webkit-transform: scale(0.75);
+ transform: scale(0.75);
+ }
+ .mfp-arrow-left {
+ -webkit-transform-origin: 0;
+ transform-origin: 0;
+ }
+ .mfp-arrow-right {
+ -webkit-transform-origin: 100%;
+ transform-origin: 100%;
+ }
+ .mfp-container {
+ padding-left: $mfp-popup-padding-left-mobile;
+ padding-right: $mfp-popup-padding-left-mobile;
+ }
+}
+
+
+
+// IE7 support
+// Styles that make popup look nicier in old IE
+@if $mfp-IE7support {
+ .mfp-ie7 {
+ .mfp-img {
+ padding: 0;
+ }
+ .mfp-bottom-bar {
+ width: 600px;
+ left: 50%;
+ margin-left: -300px;
+ margin-top: 5px;
+ padding-bottom: 5px;
+ }
+ .mfp-container {
+ padding: 0;
+ }
+ .mfp-content {
+ padding-top: 44px;
+ }
+ .mfp-close {
+ top: 0;
+ right: 0;
+ padding-top: 0;
+ }
+ }
+}
diff --git a/docs/_sass/minimal-mistakes/vendor/magnific-popup/_settings.scss b/docs/_sass/minimal-mistakes/vendor/magnific-popup/_settings.scss
new file mode 100644
index 00000000..e7866b3f
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/magnific-popup/_settings.scss
@@ -0,0 +1,46 @@
+////////////////////////
+// Settings //
+////////////////////////
+
+// overlay
+$mfp-overlay-color: #000; // Color of overlay screen
+$mfp-overlay-opacity: 0.8; // Opacity of overlay screen
+$mfp-shadow: 0 0 8px rgba(0, 0, 0, 0.6); // Shadow on image or iframe
+
+// spacing
+$mfp-popup-padding-left: 8px; // Padding from left and from right side
+$mfp-popup-padding-left-mobile: 6px; // Same as above, but is applied when width of window is less than 800px
+
+$mfp-z-index-base: 1040; // Base z-index of popup
+
+// controls
+$mfp-include-arrows: true; // Include styles for nav arrows
+$mfp-controls-opacity: 1; // Opacity of controls
+$mfp-controls-color: #fff; // Color of controls
+$mfp-controls-border-color: #fff; // Border color of controls
+$mfp-inner-close-icon-color: #fff; // Color of close button when inside
+$mfp-controls-text-color: #ccc; // Color of preloader and "1 of X" indicator
+$mfp-controls-text-color-hover: #fff; // Hover color of preloader and "1 of X" indicator
+$mfp-IE7support: true; // Very basic IE7 support
+
+// Iframe-type options
+$mfp-include-iframe-type: true; // Enable Iframe-type popups
+$mfp-iframe-padding-top: 40px; // Iframe padding top
+$mfp-iframe-background: #000; // Background color of iframes
+$mfp-iframe-max-width: 900px; // Maximum width of iframes
+$mfp-iframe-ratio: 9/16; // Ratio of iframe (9/16 = widescreen, 3/4 = standard, etc.)
+
+// Image-type options
+$mfp-include-image-type: true; // Enable Image-type popups
+$mfp-image-background: #444 !default;
+$mfp-image-padding-top: 40px; // Image padding top
+$mfp-image-padding-bottom: 40px; // Image padding bottom
+$mfp-include-mobile-layout-for-image: true; // Removes paddings from top and bottom
+
+// Image caption options
+$mfp-caption-title-color: #f3f3f3; // Caption title color
+$mfp-caption-subtitle-color: #bdbdbd; // Caption subtitle color
+.mfp-counter { font-family: $serif; } // Caption font family
+
+// A11y
+$mfp-use-visuallyhidden: false;
\ No newline at end of file
diff --git a/docs/_sass/minimal-mistakes/vendor/susy/_su.scss b/docs/_sass/minimal-mistakes/vendor/susy/_su.scss
new file mode 100644
index 00000000..83386adb
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/susy/_su.scss
@@ -0,0 +1,4 @@
+// Su
+// ==
+
+@import 'susy/su';
diff --git a/docs/_sass/minimal-mistakes/vendor/susy/_susy-prefix.scss b/docs/_sass/minimal-mistakes/vendor/susy/_susy-prefix.scss
new file mode 100644
index 00000000..185b3561
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/susy/_susy-prefix.scss
@@ -0,0 +1,13 @@
+// Susy (Prefixed)
+// ===============
+
+$susy-version: 3;
+
+@import 'susy/utilities';
+@import 'susy/su-validate';
+@import 'susy/su-math';
+@import 'susy/settings';
+@import 'susy/normalize';
+@import 'susy/parse';
+@import 'susy/syntax-helpers';
+@import 'susy/api';
diff --git a/docs/_sass/minimal-mistakes/vendor/susy/_susy.scss b/docs/_sass/minimal-mistakes/vendor/susy/_susy.scss
new file mode 100644
index 00000000..bfda3d08
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/susy/_susy.scss
@@ -0,0 +1,5 @@
+// Susy (Un-Prefixed)
+// ==================
+
+@import 'susy-prefix';
+@import 'susy/unprefix';
diff --git a/docs/_sass/minimal-mistakes/vendor/susy/plugins/_svg-grid.scss b/docs/_sass/minimal-mistakes/vendor/susy/plugins/_svg-grid.scss
new file mode 100644
index 00000000..99db8d1e
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/susy/plugins/_svg-grid.scss
@@ -0,0 +1,5 @@
+// SVG Grid Background
+// ===================
+
+@import 'svg-grid/prefix';
+@import 'svg-grid/svg-unprefix';
diff --git a/docs/_sass/minimal-mistakes/vendor/susy/plugins/svg-grid/_prefix.scss b/docs/_sass/minimal-mistakes/vendor/susy/plugins/svg-grid/_prefix.scss
new file mode 100644
index 00000000..21fb45fa
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/susy/plugins/svg-grid/_prefix.scss
@@ -0,0 +1,7 @@
+// Prefixed SVG Plugin
+// ===================
+
+@import 'svg-settings';
+@import 'svg-utilities';
+@import 'svg-grid-math';
+@import 'svg-api';
diff --git a/docs/_sass/minimal-mistakes/vendor/susy/plugins/svg-grid/_svg-api.scss b/docs/_sass/minimal-mistakes/vendor/susy/plugins/svg-grid/_svg-api.scss
new file mode 100644
index 00000000..7d880e3e
--- /dev/null
+++ b/docs/_sass/minimal-mistakes/vendor/susy/plugins/svg-grid/_svg-api.scss
@@ -0,0 +1,114 @@
+/// Plugin: SVG Grid Image
+/// ======================
+/// @group plugin_svg-grid
+/// @see susy-svg-grid
+
+
+
+/// ## Overview
+/// If you want to generate svg-backgrounds
+/// for help visualizing and debugging your grids,
+/// import the SVG Grid Plugin.
+///
+/// The plugin adds `svg-grid-colors` setting
+/// to your global defaults,
+/// which you can override in `$susy`.
+/// It also provides you with a new function,
+/// `susy-svg-grid()`,
+/// which will return inline svg for use in
+/// backgrounds or generated content.
+///
+/// This function come with an unprefixed alias by default,
+/// using the `svg-grid` import.
+/// If you only only want prefixed versions of the API,
+/// import the `svg-grid/prefix` partial instead.
+///
+/// @group plugin_svg-grid
+///
+/// @example scss - importing the plugin
+/// // The full path to import Susy will depend on your setup…
+///
+/// // unprefixed
+/// @import 'plugins/svg-grid';
+///
+/// // prefixed
+/// @import 'plugins/svg-grid/prefix';
+///
+/// @example scss - generating background grids
+/// .grid {
+/// background: susy-svg-grid() no-repeat scroll;
+/// }
+
+
+
+// SVG Grid
+// --------
+/// Return inline svg-data in to display the grid.
+///
+/// @group plugin_svg-grid
+///
+/// @param {Map | List} $grid [$susy] -
+/// Map or shorthand defining the current grid
+/// @param {Color | List | null} $colors [null] -
+/// Column color, or list of colors for column-gradient,
+/// used to override the global `svg-grid-colors` setting
+/// @param {Length | null} $offset [null] -
+/// Manually override the default grid-image offset,
+/// to account for grid edges
+///
+/// @return {String} -
+/// CSS inline-data SVG string, in `url(