Skip to content

Credit page for dependencies such as FastChem #683

@stuitje

Description

@stuitje

Feature description

Last week, we discussed the potential licensing issue with using dependencies under GPL licenses, and how to properly credit the authors of these (and other) dependencies in our docs. An example for this is FastChem, which does not yet have a designated documentation website but is regularly used in PROTEUS, for example, from VULCAN and AGNI.

Preferred solution

Dependencies without their own documentation website, such as FastChem, should have a separate scientific credit page. For example, in both AGNI and VULCAN (and perhaps a link within PROTEUS). This page should introduce the model and reference the paper in which it was originally described. Other ideas are welcome.

More generally, other dependencies that do have designated documentation websites should be checked to see whether appropriate scientific credit is given. We do not want to go back to a full list of contributors, however, so a reference to relevant papers should be enough (any opinions on this?).

Relevant people

@nichollsh @timlichtenberg @maraattia

Metadata

Metadata

Assignees

Labels

DocsUpdate documentation webpageInterraIssue has been imported to the Interra Board projectimport

Type

No type
No fields configured for issues without a type.

Projects

Status

Next Up

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions