Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yuyizheng1112 authored and James Gillanders committed Aug 20, 2021
1 parent a68bfd8 commit 1fde653
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 0 deletions.
55 changes: 55 additions & 0 deletions docs/io/visualization/abundance_widget.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
{
"metadata": {
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.10"
},
"orig_nbformat": 4,
"kernelspec": {
"name": "python3",
"display_name": "Python 3.7.10 64-bit ('tardis': conda)"
},
"interpreter": {
"hash": "42180fb7a26743e791b9c1155ac51f7e87399be241c0afbd4c0781c11826afd9"
}
},
"nbformat": 4,
"nbformat_minor": 2,
"cells": [
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"from tardis.visualization import CustomAbundanceWidget"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"widget = CustomAbundanceWidget.from_yml('tardis_example.yml')"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"widget.display()"
]
}
]
}
1 change: 1 addition & 0 deletions docs/io/visualization/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ diagnostic visualizations.

sdec_plot
convergence_plot
abundance_widget


TARDIS Widgets (Graphical User Interfaces)
Expand Down

0 comments on commit 1fde653

Please sign in to comment.