drasil-sysinfo-0.1.1.0: A framework for code and document generation for scientific software - SystemInformation SubPackage

Safe Haskell	Safe-Inferred
Language	Haskell2010

SysInfo.Drasil.SystemInformation

Contents

System Information
Reference Database

Description

Define types and functions related to creating a system information database.

Synopsis

data SystemInformation where
- SI :: (CommonIdea a, Idea a, Idea b, Quantity e, Eq e, MayHaveUnit e, Quantity f, MayHaveUnit f, Concept f, Eq f, Quantity h, MayHaveUnit h, Quantity i, MayHaveUnit i, HasUID j, Constrained j) => {..} -> SystemInformation
data Block a
- = Coupled a a [a]
- | Parallel a [a]
class HasSystemInformation c where
- systemInformation :: Lens' c SystemInformation
- authors :: Lens' c People
- background :: Lens' c Background
- configFiles :: Lens' c [String]
- constants :: Lens' c [ConstQDef]
- datadefs :: Lens' c [DataDefinition]
- defSequence :: Lens' c [Block SimpleQDef]
- instModels :: Lens' c [InstanceModel]
- motivation :: Lens' c Motivation
- purpose :: Lens' c Purpose
- scope :: Lens' c Scope
- sysinfodb :: Lens' c ChunkDB
- usedinfodb :: Lens' c ChunkDB
citeDB :: SystemInformation -> BibRef
citationsFromBibMap :: BibMap -> [Citation]
data ReferenceDB
type RefMap a = Map UID (a, Int)
type Purpose = [Sentence]
type Background = [Sentence]
type Scope = [Sentence]
type Motivation = [Sentence]
rdb :: BibRef -> [ConceptInstance] -> ReferenceDB
simpleMap :: HasUID a => [a] -> RefMap a
citationDB :: Lens' ReferenceDB BibMap
conceptDB :: Lens' ReferenceDB ConceptMap

System Information

Types

data SystemInformation where Source #

Data structure for holding all of the requisite information about a system to be used in artifact generation.

Constructors

Fields

:: (CommonIdea a, Idea a, Idea b, Quantity e, Eq e, MayHaveUnit e, Quantity f, MayHaveUnit f, Concept f, Eq f, Quantity h, MayHaveUnit h, Quantity i, MayHaveUnit i, HasUID j, Constrained j)
=> { _sys :: a
, _kind :: b
, _authors :: People
, _purpose :: Purpose
, _background :: Background
, _scope :: Scope
, _motivation :: Motivation
, _quants :: [e]
, _concepts :: [f]
, _instModels :: [InstanceModel]
, _datadefs :: [DataDefinition]
, _configFiles :: [String]
, _inputs :: [h]
, _outputs :: [i]
, _defSequence :: [Block SimpleQDef]
, _constraints :: [j]
, _constants :: [ConstQDef]
, _sysinfodb :: ChunkDB
, _usedinfodb :: ChunkDB
, refdb :: ReferenceDB
} -> SystemInformation

Instances

Instances details

HasSystemInformation SystemInformation Source #

Instance details

Defined in SysInfo.Drasil.SystemInformation

Methods

systemInformation :: Lens' SystemInformation SystemInformation Source #

authors :: Lens' SystemInformation People Source #

background :: Lens' SystemInformation Background Source #

configFiles :: Lens' SystemInformation [String] Source #

constants :: Lens' SystemInformation [ConstQDef] Source #

datadefs :: Lens' SystemInformation [DataDefinition] Source #

defSequence :: Lens' SystemInformation [Block SimpleQDef] Source #

instModels :: Lens' SystemInformation [InstanceModel] Source #

motivation :: Lens' SystemInformation Motivation Source #

purpose :: Lens' SystemInformation Purpose Source #

scope :: Lens' SystemInformation Scope Source #

sysinfodb :: Lens' SystemInformation ChunkDB Source #

usedinfodb :: Lens' SystemInformation ChunkDB Source #

data Block a Source #

for listing QDefinitions in SystemInformation.

Constructors

Coupled a a [a]
Parallel a [a]

Lenses

class HasSystemInformation c where Source #

Minimal complete definition

systemInformation

Methods

systemInformation :: Lens' c SystemInformation Source #

authors :: Lens' c People Source #

background :: Lens' c Background Source #

configFiles :: Lens' c [String] Source #

constants :: Lens' c [ConstQDef] Source #

datadefs :: Lens' c [DataDefinition] Source #

defSequence :: Lens' c [Block SimpleQDef] Source #

instModels :: Lens' c [InstanceModel] Source #

motivation :: Lens' c Motivation Source #

purpose :: Lens' c Purpose Source #

scope :: Lens' c Scope Source #

sysinfodb :: Lens' c ChunkDB Source #

usedinfodb :: Lens' c ChunkDB Source #

Instances

Instances details

HasSystemInformation SystemInformation Source #

Instance details

Defined in SysInfo.Drasil.SystemInformation

Methods

systemInformation :: Lens' SystemInformation SystemInformation Source #

authors :: Lens' SystemInformation People Source #

background :: Lens' SystemInformation Background Source #

configFiles :: Lens' SystemInformation [String] Source #

constants :: Lens' SystemInformation [ConstQDef] Source #

datadefs :: Lens' SystemInformation [DataDefinition] Source #

defSequence :: Lens' SystemInformation [Block SimpleQDef] Source #

instModels :: Lens' SystemInformation [InstanceModel] Source #

motivation :: Lens' SystemInformation Motivation Source #

purpose :: Lens' SystemInformation Purpose Source #

scope :: Lens' SystemInformation Scope Source #

sysinfodb :: Lens' SystemInformation ChunkDB Source #

usedinfodb :: Lens' SystemInformation ChunkDB Source #

Lookup Functions

citeDB :: SystemInformation -> BibRef Source #

Helper for extracting a bibliography from the system information.

citationsFromBibMap :: BibMap -> [Citation] Source #

Create sorted citations from a bibliography.

Reference Database

Types

data ReferenceDB Source #

Database for internal references. Contains citations and referrable concepts.

type RefMap a = Map UID (a, Int) Source #

Database for maintaining references. The Int is that reference's number. Maintains access to both num and chunk for easy reference swapping between number and shortname/refname when necessary (or use of number if no shortname exists).

type Purpose = [Sentence] Source #

Project Example purpose.

type Background = [Sentence] Source #

Project Example background information, used in the What section of README.

type Scope = [Sentence] Source #

Project Example scope.

type Motivation = [Sentence] Source #

Project Example motivation.

Constructors

rdb :: BibRef -> [ConceptInstance] -> ReferenceDB Source #

Smart constructor for creating a reference database from a bibliography and concept instances.

simpleMap :: HasUID a => [a] -> RefMap a Source #

Constructor that makes a RefMap from things that have a UID.

Lenses

citationDB :: Lens' ReferenceDB BibMap Source #

conceptDB :: Lens' ReferenceDB ConceptMap Source #