Skip to content

Commit

Permalink
chore(docs): render docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 6, 2024
1 parent e0a7e52 commit c1f36f1
Show file tree
Hide file tree
Showing 14 changed files with 95 additions and 95 deletions.
2 changes: 1 addition & 1 deletion docs/_reference/dummyreaction.reaction.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.56">
<meta name="generator" content="quarto-1.5.53">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
2 changes: 1 addition & 1 deletion docs/_reference/hat_naive.reaction.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.56">
<meta name="generator" content="quarto-1.5.53">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
2 changes: 1 addition & 1 deletion docs/_reference/homolysis.reaction.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.56">
<meta name="generator" content="quarto-1.5.53">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
2 changes: 1 addition & 1 deletion docs/_reference/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.56">
<meta name="generator" content="quarto-1.5.53">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
2 changes: 1 addition & 1 deletion docs/_reference/reaction.DummyReaction.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.56">
<meta name="generator" content="quarto-1.5.53">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
2 changes: 1 addition & 1 deletion docs/_reference/reaction.Homolysis.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.56">
<meta name="generator" content="quarto-1.5.53">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
2 changes: 1 addition & 1 deletion docs/_reference/reaction.NaiveHAT.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.56">
<meta name="generator" content="quarto-1.5.53">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
2 changes: 1 addition & 1 deletion docs/_reference/reaction.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.56">
<meta name="generator" content="quarto-1.5.53">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
2 changes: 1 addition & 1 deletion docs/config.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.56">
<meta name="generator" content="quarto-1.5.53">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.56">
<meta name="generator" content="quarto-1.5.53">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
132 changes: 66 additions & 66 deletions docs/search.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@
]
},
{
"objectID": "_reference/reaction.NaiveHAT.html",
"href": "_reference/reaction.NaiveHAT.html",
"title": "reaction.NaiveHAT",
"objectID": "_reference/reaction.Homolysis.html",
"href": "_reference/reaction.Homolysis.html",
"title": "reaction.Homolysis",
"section": "",
"text": "reaction.NaiveHAT\nreaction.NaiveHAT()\nNaive HAT reaction, selects hydrogens at random\n\n\n\n\n Back to top"
"text": "reaction.Homolysis\nreaction.Homolysis()\nHomolytic bond breaking leading to 2 radicals. Implementation for time-varying rates\n\n\n\n\n Back to top"
},
{
"objectID": "config.html",
Expand Down Expand Up @@ -59,48 +59,18 @@
"text": "Naive HAT\nreactions:\n hat_naive: ...\n\nfrequency_factor\nFrequency factor\nType: float\nDefault: 1\n\n\nh_cutoff\nCutoff for H atom\nType: float\nDefault: 4\n\n\npolling_rate\nPolling rate\nType: float\nDefault: 1\n\n\nkmc\nKMC algorithm for this reaction.\nType: str\nOptions: [‘rfkmc’, ‘frm’, ‘extrande’, ‘extrande_mod’]\nDefault: extrande_mod"
},
{
"objectID": "_reference/index.html",
"href": "_reference/index.html",
"title": "References",
"section": "",
"text": "homolysis.reaction\n\n\n\n\n\n\n\n\n\n\nhat_naive.reaction\n\n\n\n\n\n\n\n\n\n\ndummyreaction.reaction",
"crumbs": [
"Reference",
"References"
]
},
{
"objectID": "_reference/index.html#homolysis",
"href": "_reference/index.html#homolysis",
"title": "References",
"section": "",
"text": "homolysis.reaction",
"crumbs": [
"Reference",
"References"
]
},
{
"objectID": "_reference/index.html#naive-hat",
"href": "_reference/index.html#naive-hat",
"title": "References",
"objectID": "_reference/reaction.html",
"href": "_reference/reaction.html",
"title": "reaction",
"section": "",
"text": "hat_naive.reaction",
"crumbs": [
"Reference",
"References"
]
"text": "reaction\n\n\n\n\n\nName\nDescription\n\n\n\n\nDummyReaction\nDummy reaction, returns empty RecipeCollection\n\n\n\n\n\nreaction.DummyReaction()\nDummy reaction, returns empty RecipeCollection"
},
{
"objectID": "_reference/index.html#dummyreaction",
"href": "_reference/index.html#dummyreaction",
"title": "References",
"objectID": "_reference/reaction.html#classes",
"href": "_reference/reaction.html#classes",
"title": "reaction",
"section": "",
"text": "dummyreaction.reaction",
"crumbs": [
"Reference",
"References"
]
"text": "Name\nDescription\n\n\n\n\nDummyReaction\nDummy reaction, returns empty RecipeCollection\n\n\n\n\n\nreaction.DummyReaction()\nDummy reaction, returns empty RecipeCollection"
},
{
"objectID": "index.html",
Expand Down Expand Up @@ -130,6 +100,30 @@
"section": "",
"text": "Implement your reaction as a subclass of kimmdy.reaction.Reaction\nRegister your Reaction class in the [options.entry_points] section in the setup.cfg. The name you give here must match the entry in the config.yml for Kimmdy!"
},
{
"objectID": "_reference/hat_naive.reaction.html",
"href": "_reference/hat_naive.reaction.html",
"title": "hat_naive.reaction",
"section": "",
"text": "reaction\n\n\n\n\n\nName\nDescription\n\n\n\n\nNaiveHAT\nNaive HAT reaction, selects hydrogens at random\n\n\n\n\n\nreaction.NaiveHAT()\nNaive HAT reaction, selects hydrogens at random",
"crumbs": [
"Reference",
"Naive HAT",
"hat_naive.reaction"
]
},
{
"objectID": "_reference/hat_naive.reaction.html#classes",
"href": "_reference/hat_naive.reaction.html#classes",
"title": "hat_naive.reaction",
"section": "",
"text": "Name\nDescription\n\n\n\n\nNaiveHAT\nNaive HAT reaction, selects hydrogens at random\n\n\n\n\n\nreaction.NaiveHAT()\nNaive HAT reaction, selects hydrogens at random",
"crumbs": [
"Reference",
"Naive HAT",
"hat_naive.reaction"
]
},
{
"objectID": "_reference/homolysis.reaction.html",
"href": "_reference/homolysis.reaction.html",
Expand Down Expand Up @@ -162,48 +156,54 @@
"text": "reaction.DummyReaction\nreaction.DummyReaction()\nDummy reaction, returns empty RecipeCollection\n\n\n\n\n Back to top"
},
{
"objectID": "_reference/hat_naive.reaction.html",
"href": "_reference/hat_naive.reaction.html",
"title": "hat_naive.reaction",
"objectID": "_reference/index.html",
"href": "_reference/index.html",
"title": "References",
"section": "",
"text": "reaction\n\n\n\n\n\nName\nDescription\n\n\n\n\nNaiveHAT\nNaive HAT reaction, selects hydrogens at random\n\n\n\n\n\nreaction.NaiveHAT()\nNaive HAT reaction, selects hydrogens at random",
"text": "homolysis.reaction\n\n\n\n\n\n\n\n\n\n\nhat_naive.reaction\n\n\n\n\n\n\n\n\n\n\ndummyreaction.reaction",
"crumbs": [
"Reference",
"Naive HAT",
"hat_naive.reaction"
"References"
]
},
{
"objectID": "_reference/hat_naive.reaction.html#classes",
"href": "_reference/hat_naive.reaction.html#classes",
"title": "hat_naive.reaction",
"objectID": "_reference/index.html#homolysis",
"href": "_reference/index.html#homolysis",
"title": "References",
"section": "",
"text": "Name\nDescription\n\n\n\n\nNaiveHAT\nNaive HAT reaction, selects hydrogens at random\n\n\n\n\n\nreaction.NaiveHAT()\nNaive HAT reaction, selects hydrogens at random",
"text": "homolysis.reaction",
"crumbs": [
"Reference",
"Naive HAT",
"hat_naive.reaction"
"References"
]
},
{
"objectID": "_reference/reaction.html",
"href": "_reference/reaction.html",
"title": "reaction",
"objectID": "_reference/index.html#naive-hat",
"href": "_reference/index.html#naive-hat",
"title": "References",
"section": "",
"text": "reaction\n\n\n\n\n\nName\nDescription\n\n\n\n\nDummyReaction\nDummy reaction, returns empty RecipeCollection\n\n\n\n\n\nreaction.DummyReaction()\nDummy reaction, returns empty RecipeCollection"
"text": "hat_naive.reaction",
"crumbs": [
"Reference",
"References"
]
},
{
"objectID": "_reference/reaction.html#classes",
"href": "_reference/reaction.html#classes",
"title": "reaction",
"objectID": "_reference/index.html#dummyreaction",
"href": "_reference/index.html#dummyreaction",
"title": "References",
"section": "",
"text": "Name\nDescription\n\n\n\n\nDummyReaction\nDummy reaction, returns empty RecipeCollection\n\n\n\n\n\nreaction.DummyReaction()\nDummy reaction, returns empty RecipeCollection"
"text": "dummyreaction.reaction",
"crumbs": [
"Reference",
"References"
]
},
{
"objectID": "_reference/reaction.Homolysis.html",
"href": "_reference/reaction.Homolysis.html",
"title": "reaction.Homolysis",
"objectID": "_reference/reaction.NaiveHAT.html",
"href": "_reference/reaction.NaiveHAT.html",
"title": "reaction.NaiveHAT",
"section": "",
"text": "reaction.Homolysis\nreaction.Homolysis()\nHomolytic bond breaking leading to 2 radicals. Implementation for time-varying rates\n\n\n\n\n Back to top"
"text": "reaction.NaiveHAT\nreaction.NaiveHAT()\nNaive HAT reaction, selects hydrogens at random\n\n\n\n\n Back to top"
}
]
2 changes: 1 addition & 1 deletion docs/site_libs/bootstrap/bootstrap-dark.min.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/site_libs/bootstrap/bootstrap.min.css

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions docs/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,42 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/dummyreaction.reaction.html</loc>
<lastmod>2024-09-05T08:32:41.000Z</lastmod>
<lastmod>2024-09-06T09:29:04.489Z</lastmod>
</url>
<url>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/reaction.NaiveHAT.html</loc>
<lastmod>2024-09-05T08:20:57.000Z</lastmod>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/reaction.Homolysis.html</loc>
<lastmod>2024-09-06T09:29:04.489Z</lastmod>
</url>
<url>
<loc>http://graeter-group.github.io/kimmdy-reactions/config.html</loc>
<lastmod>2024-09-05T10:27:12.000Z</lastmod>
<lastmod>2024-09-06T09:29:04.489Z</lastmod>
</url>
<url>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/index.html</loc>
<lastmod>2024-09-05T10:38:40.000Z</lastmod>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/reaction.html</loc>
<lastmod>2024-09-06T09:29:04.489Z</lastmod>
</url>
<url>
<loc>http://graeter-group.github.io/kimmdy-reactions/index.html</loc>
<lastmod>2024-09-05T08:12:58.000Z</lastmod>
<lastmod>2024-09-06T09:29:04.497Z</lastmod>
</url>
<url>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/homolysis.reaction.html</loc>
<lastmod>2024-09-05T08:32:41.000Z</lastmod>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/hat_naive.reaction.html</loc>
<lastmod>2024-09-06T09:29:04.489Z</lastmod>
</url>
<url>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/reaction.DummyReaction.html</loc>
<lastmod>2024-09-05T08:20:57.000Z</lastmod>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/homolysis.reaction.html</loc>
<lastmod>2024-09-06T09:29:04.489Z</lastmod>
</url>
<url>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/hat_naive.reaction.html</loc>
<lastmod>2024-09-05T08:32:41.000Z</lastmod>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/reaction.DummyReaction.html</loc>
<lastmod>2024-09-06T09:29:04.489Z</lastmod>
</url>
<url>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/reaction.html</loc>
<lastmod>2024-09-05T08:25:27.000Z</lastmod>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/index.html</loc>
<lastmod>2024-09-06T09:29:49.573Z</lastmod>
</url>
<url>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/reaction.Homolysis.html</loc>
<lastmod>2024-09-05T08:20:57.000Z</lastmod>
<loc>http://graeter-group.github.io/kimmdy-reactions/_reference/reaction.NaiveHAT.html</loc>
<lastmod>2024-09-06T09:29:04.489Z</lastmod>
</url>
</urlset>

0 comments on commit c1f36f1

Please sign in to comment.