Skip to content

Commit

Permalink
deploy: ab7e61d
Browse files Browse the repository at this point in the history
  • Loading branch information
tardis-bot committed Nov 18, 2024
1 parent 769016f commit 121f2b4
Show file tree
Hide file tree
Showing 17 changed files with 289 additions and 25 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 34142cb844088c47c883424b2da7dfe8
config: 3fcb24b0d3efd26759478e20ff53de2d
tags: 645f666f9bcd5a90fca523b33c5a78b7
1 change: 1 addition & 0 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ This is the documentation for STARDIS.
Quickstart <quickstart/quickstart>
Downloading and Installation <installation>
Physics of STARDIS <physics/physics_of_stardis>
Using STARDIS in Parallel <using_stardis_in_parallel/stardis_in_parallel>
Example Notebooks <example_notebooks/rotation_broadening>
Contributing <contributing>
Bibliography <bibliography>
Expand Down
61 changes: 61 additions & 0 deletions _sources/using_stardis_in_parallel/stardis_in_parallel.ipynb.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Setting number of threads used in running a STARDIS simulation"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"When you run a STARDIS simulation, the yaml file determines how many threads are used. By default, it will only use 1 thread. The more threads you set a simulation to use, the more computing power the simulation will take advantage of for calculating line opacity and ray tracing steps (as both of these are parallelized in STARDIS). **Setting n_threads to 0 will make the simulation use all available threads.**"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Here is a what a yaml file that has the STARDIS simulation use 3 threads will look like\n",
"\n",
"``` yaml\n",
"stardis_config_version: 1.0\n",
"n_threads: 3 # <----------- add your 'n_threads: <integer>' here\n",
"atom_data: kurucz_cd23_chianti_H_He.h5\n",
"model:\n",
" ...\n",
"```\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"One reason you may want to consider increasing threads used is when computing spectra with large numbers (i.e. 10,000 or more) of wavelength points."
]
}
],
"metadata": {
"kernelspec": {
"display_name": "stardis",
"language": "python",
"name": "python3"
},
"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.12.4"
}
},
"nbformat": 4,
"nbformat_minor": 2
}
2 changes: 1 addition & 1 deletion _static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.1.dev1+gec588eb',
VERSION: '0.1.dev1+gab7e61d',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
5 changes: 3 additions & 2 deletions bibliography.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Bibliography &mdash; stardis 0.1.dev1+gec588eb documentation</title>
<title>Bibliography &mdash; stardis 0.1.dev1+gab7e61d documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=3f3f9bfb"></script>
<script src="_static/documentation_options.js?v=d75fa11a"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand Down Expand Up @@ -50,6 +50,7 @@
<li class="toctree-l1"><a class="reference internal" href="quickstart/quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Downloading and Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="physics/physics_of_stardis.html">Physics of STARDIS</a></li>
<li class="toctree-l1"><a class="reference internal" href="using_stardis_in_parallel/stardis_in_parallel.html">Using STARDIS in Parallel</a></li>
<li class="toctree-l1"><a class="reference internal" href="example_notebooks/rotation_broadening.html">Example Notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Bibliography</a></li>
Expand Down
5 changes: 3 additions & 2 deletions contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributing &mdash; stardis 0.1.dev1+gec588eb documentation</title>
<title>Contributing &mdash; stardis 0.1.dev1+gab7e61d documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=3f3f9bfb"></script>
<script src="_static/documentation_options.js?v=d75fa11a"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand Down Expand Up @@ -51,6 +51,7 @@
<li class="toctree-l1"><a class="reference internal" href="quickstart/quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Downloading and Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="physics/physics_of_stardis.html">Physics of STARDIS</a></li>
<li class="toctree-l1"><a class="reference internal" href="using_stardis_in_parallel/stardis_in_parallel.html">Using STARDIS in Parallel</a></li>
<li class="toctree-l1"><a class="reference internal" href="example_notebooks/rotation_broadening.html">Example Notebooks</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#generating-conda-lockfiles">Generating Conda Lockfiles</a><ul>
Expand Down
9 changes: 5 additions & 4 deletions example_notebooks/rotation_broadening.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>STARDIS &mdash; stardis 0.1.dev1+gec588eb documentation</title>
<title>STARDIS &mdash; stardis 0.1.dev1+gab7e61d documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
Expand All @@ -16,7 +16,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=3f3f9bfb"></script>
<script src="../_static/documentation_options.js?v=d75fa11a"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand All @@ -27,7 +27,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Contributing" href="../contributing.html" />
<link rel="prev" title="Physics of STARDIS" href="../physics/physics_of_stardis.html" />
<link rel="prev" title="Setting number of threads used in running a STARDIS simulation" href="../using_stardis_in_parallel/stardis_in_parallel.html" />
</head>

<body class="wy-body-for-nav">
Expand All @@ -54,6 +54,7 @@
<li class="toctree-l1"><a class="reference internal" href="../quickstart/quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Downloading and Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../physics/physics_of_stardis.html">Physics of STARDIS</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using_stardis_in_parallel/stardis_in_parallel.html">Using STARDIS in Parallel</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Example Notebooks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#Import-Necessary-Code">Import Necessary Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="#Download-Atomic-Data">Download Atomic Data</a><ul>
Expand Down Expand Up @@ -249,7 +250,7 @@ <h2>Plot spectra<a class="headerlink" href="#Plot-spectra" title="Link to this h
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../physics/physics_of_stardis.html" class="btn btn-neutral float-left" title="Physics of STARDIS" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../using_stardis_in_parallel/stardis_in_parallel.html" class="btn btn-neutral float-left" title="Setting number of threads used in running a STARDIS simulation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../contributing.html" class="btn btn-neutral float-right" title="Contributing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
5 changes: 3 additions & 2 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; stardis 0.1.dev1+gec588eb documentation</title>
<title>Index &mdash; stardis 0.1.dev1+gab7e61d documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
Expand All @@ -14,7 +14,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=3f3f9bfb"></script>
<script src="_static/documentation_options.js?v=d75fa11a"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand Down Expand Up @@ -48,6 +48,7 @@
<li class="toctree-l1"><a class="reference internal" href="quickstart/quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Downloading and Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="physics/physics_of_stardis.html">Physics of STARDIS</a></li>
<li class="toctree-l1"><a class="reference internal" href="using_stardis_in_parallel/stardis_in_parallel.html">Using STARDIS in Parallel</a></li>
<li class="toctree-l1"><a class="reference internal" href="example_notebooks/rotation_broadening.html">Example Notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="bibliography.html">Bibliography</a></li>
Expand Down
6 changes: 4 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>STARDIS Documentation &mdash; stardis 0.1.dev1+gec588eb documentation</title>
<title>STARDIS Documentation &mdash; stardis 0.1.dev1+gab7e61d documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=3f3f9bfb"></script>
<script src="_static/documentation_options.js?v=d75fa11a"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand Down Expand Up @@ -50,6 +50,7 @@
<li class="toctree-l1"><a class="reference internal" href="quickstart/quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Downloading and Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="physics/physics_of_stardis.html">Physics of STARDIS</a></li>
<li class="toctree-l1"><a class="reference internal" href="using_stardis_in_parallel/stardis_in_parallel.html">Using STARDIS in Parallel</a></li>
<li class="toctree-l1"><a class="reference internal" href="example_notebooks/rotation_broadening.html">Example Notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="bibliography.html">Bibliography</a></li>
Expand Down Expand Up @@ -105,6 +106,7 @@ <h1>STARDIS Documentation<a class="headerlink" href="#stardis-documentation" tit
<li class="toctree-l2"><a class="reference internal" href="physics/physics_of_stardis.html#transport">Transport</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="using_stardis_in_parallel/stardis_in_parallel.html">Using STARDIS in Parallel</a></li>
<li class="toctree-l1"><a class="reference internal" href="example_notebooks/rotation_broadening.html">Example Notebooks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="example_notebooks/rotation_broadening.html#Import-Necessary-Code">Import Necessary Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="example_notebooks/rotation_broadening.html#Download-Atomic-Data">Download Atomic Data</a></li>
Expand Down
5 changes: 3 additions & 2 deletions installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Downloading and Installation &mdash; stardis 0.1.dev1+gec588eb documentation</title>
<title>Downloading and Installation &mdash; stardis 0.1.dev1+gab7e61d documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=3f3f9bfb"></script>
<script src="_static/documentation_options.js?v=d75fa11a"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand Down Expand Up @@ -59,6 +59,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="physics/physics_of_stardis.html">Physics of STARDIS</a></li>
<li class="toctree-l1"><a class="reference internal" href="using_stardis_in_parallel/stardis_in_parallel.html">Using STARDIS in Parallel</a></li>
<li class="toctree-l1"><a class="reference internal" href="example_notebooks/rotation_broadening.html">Example Notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="bibliography.html">Bibliography</a></li>
Expand Down
Binary file modified objects.inv
Binary file not shown.
Loading

0 comments on commit 121f2b4

Please sign in to comment.